Skip to main content

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

Service SOAP rules

Updated on November 23, 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 About Service Package data instances.

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.

  • Creating a Service SOAP rule

    To process service requests in your Pega Platform synchronously or asynchronously, create a Service SOAP rule. You use SOAP service rules when your Pega Platform applications needs to act as a web service.

  • Configuring the request for a Service SOAP rule

    Configure the data mapping of the incoming SOAP request from the external client application to Pega Platform on the Request tab.

  • Configuring the response for a Service SOAP rule

    Configure the data mapping for the reply message on the Response tab of the Service SOAP rule.

  • Configuring Service SOAP fault messages

    Use the Faults tab of the Service SOAP form to specify data that is returned to the client application when the service encounters a fatal processing error and must return a SOAP fault message. You can also use the Faults tab for other conditions that you want to cause SOAP fault messages to be returned.

  • Defining the XML page of a Service SOAP rule

    Use the XML Page tab to identify a data transform that defines the schema of an XML object. The service rule uses the data transform to map the XML object's arguments to and from the pages and properties.

  • Enabling Web service security in a Service SOAP rule

    Configure Web service security (WS-Security) settings to ensure content integrity and confidentiality for SOAP requests and responses.

  • Service SOAP form - Working with the Test Cases tab

    This tab is visible only to operators who have the AutomatedTesting privilege through an access role.

  • WSDL generation for Service SOAP rules

    After you have created all the Service SOAP rules that are to be included in a service package, generate WSDL files that describe the services in the package. Then, you can copy the generated WSDL files to the system on which you are developing the SOAP client and use it to create your SOAP client application.

  • Modifying character set encoding for Service SOAP rules

    By default, Pega Platform uses UTF-8 as the character set encoding for SOAP response messages.

  • Service SOAP rules debugging and performance

    Learn about the ways in which you can monitor the performance of your Service SOAP rules and debug these rules if necessary. By understanding how to debug your Service SOAP rules, you can troubleshoot errors and improve performance.

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