About Connect SOAP rules

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

The following tabs are available on this form:


Use the Application Explorer or Configure > Integration > Connector Definitions & Simulations to list the Connect SOAP rules in your application.

Select Configure > Integration > Connectors > Connector and Metadata wizard to start the Connector and Metadata wizard to create a Connect SOAP rule.

Use the Records Explorer to list all Connect SOAP rules that are available to you.


To create a SOAP connector, start the Connector and Metadata wizard. Identify the URL of the WSDL file that describes the processing and methods of the SOAP Web service you want to connect to. See About the Connector and Metadata wizard .

For a comprehensive description of the development process and a sample, see Building SOAP Connectors on the Integration area of the Pega Community. See also the Integrating with External Systems 5.2 publication.

The connector supports sending and receiving SOAP attachments with SOAP messages. For more information, see Pega Community article How to configure a SOAP or dotNET connector to send or receive SOAP with attachments.

To debug your application when the external Web service is unavailable or lacks a test environment, you can use a connector simulator. See Creating Connector Simulations.

Where referenced

Connect SOAP rules can be referenced in an Integrator shape of a flow rule, or on the Definition tab of a Data Page rule, as the source of data for the contents of the data page.


Connect SOAP rules belong to the Integration-Connectors category. A Connect SOAP rule is an instance of the Rule-Connect-SOAP rule type.