Skip to main content

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

Connect SOAP rules

Updated on April 6, 2022

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. By using the SOAP integration interface, you optimize your business processes and avoid relying on an additional platform as a service to make calls.

Note: As a best practice, use the Create SOAP integration wizard to create a data source. The wizard generates the records that the system requires to use the data source, including classes, properties, mapping rules, an authentication profile, and a connector. For more information, see Creating a SOAP integration.

The following tabs are available on this form:


To list the Connect SOAP rules in your application, use the Application Explorer or click ConfigureIntegrationConnectorsConnector Definitions & Simulations.

To list all Connect SOAP rules that are available to you, use the Records Explorer.


To create a SOAP connector, start the Create SOAP Integration wizard. Identify the URL of the WSDL file that describes the processing and methods of the SOAP Web service that you want to connect to. For more information, see Creating a SOAP integration.

SOAP connectors support sending and receiving SOAP attachments with SOAP messages. For more information, see the 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. For more information, see Creating Connector Simulations.

For details on gathering performance information about a connector, see Tracking system utilization for a requestor session with Performance Analyzer.

Where referenced

You can reference Connect SOAP rules on the Definition tab of a Data Page as the source of data for the content of the data page. For more information, see Creating a data page.


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

Related Pega Community articles

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