Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Service SOAP rules

Updated on April 5, 2022

Using Simple Object Access Protocol (SOAP) over HTTP, the SOAP integration interface in Process commander supports interactions with external systems through Web services. Use SOAP service rules when your Pega Platform applications need to act as a Web service.

The following tabs are available on this form:

A SOAP service means 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 generally process service requests synchronously. That is, they immediately perform their requested processing and return a configured response while the calling application waits. However, you can configure SOAP services to process service requests asynchronously, which means the service queues the request for asynchronous execution and the calling application calls back later for the results. Additionally, you can configure synchronous SOAP services to check for specific error conditions that you expect will be temporary — work item locks, for example — and then queue service requests for another attempt at a later time.


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


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

For a comprehensive description of the development process and a sample, see the Pega Community document Building SOAP Services. See also:

  • How asynchronous service processing works
  • Configure a service to process requests asynchronously
  • Configure a service to queue a failed service request for another attempt


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

  • Previous topic Unit testing a Service JMS rule
  • Next topic Service SOAP rules - Completing the Create, Save As, or Specialization form

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