Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Service SOAP rules

Updated on April 6, 2022

Pega Platform supports Web service interactions with external systems by using the SOAP messaging standard. Use SOAP service rules when your Pega Platform applications need to act as a web service.

A SOAP service requires a SOAP service package that provides one or more service methods for an external application to use. Each method in the service package corresponds to a SOAP service rule that identifies an activity to run and maps the incoming and outgoing data.

To call a Pega Platform SOAP service, an external application collects data values, wraps them in an XML document envelope (SOAP envelope) that contains the name of the requested service, and posts the envelope to the URL of the Pega Platform PRSOAPServlet servlet. The PRSOAPServlet servlet routes the request to the appropriate SOAP service package and rule.

SOAP services are run by using requestors with access restrictions that are defined by the service package to which they belong. At run time, the package, class, and method names are passed in as part of a SOAP request so that your Pega Platform application can look up the corresponding Service SOAP rule and run the service activity.


Use the Application Explorer to view Service SOAP rules in your application. Use the Records Explorer to list all Service SOAP rules that are available to you.

Client-side development

After you create all the Service SOAP rules in one package, you can access the Service Package data instance again to generate a WSDL file to support client-side development.

For more information, see Service Packages.

Asynchronous processing

For a comprehensive description of asynchronous processing and instructions on how to configure that functionality, see the following articles:


Service SOAP rules belong to the Integration-Services category. A Service SOAP rule is an instance of the Rule-Service-SOAP class.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us