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

  • Creating a Connect SOAP rule

    To easily call an external system in Pega Platform, create a Connect SOAP rule.

  • Configuring the connection for a Connect SOAP rule

    Identify the properties of the remote SOAP service by configuring the connection details on the Service tab. The Service tab contains all of your connection information in one place, so you save time when developing your connect SOAP rule.

  • Configuring the request for a SOAP connector

    Use the Request tab of a SOAP connector to configure the data mapping for the outgoing SOAP message.

  • Configuring the response for a SOAP connector

    Use the Response tab to configure the data mapping for the reply from the external Web service.

  • Configuring SOAP fault messages

    As a best practice, use the optional Faults tab to map any SOAP faults returned by the Web service. By configuring fault messages, you can include an error-handling steps in the connector activity and have the activity respond appropriately if the connector receives a SOAP fault instead of the response message that it expects.

  • Configuring advanced details for a SOAP Connector

    Use the Advanced tab to change which version of Axis or SOAP is used, to associate a compensating action with the connector, to specify the data transforms that define the schema, and to enable Web Service Security for the connector.

  • Viewing the WSDL tab in a Connect SOAP rule

    When you use the Create SOAP Integration wizard to generate the SOAP connector, it populates the contents of the Web service’s WSDL file on the WSDL tab. This information is for reference and is read-only. For example, you can use this information to understand how the connector was created.

  • Configuring asynchronous processing for SOAP connectors

    You can perform SOAP connector processing asynchronously by using Pega-IntSevcs agents to queue the connector request.

  • Secure the transport layer in integrations

    Learn how your Pega Platform application handles REST and SOAP connector rules that point to an SSL-enabled endpoint.

  • Calling web services using queued execution

    To preserve business data integrity across multiple Pega Platform instances, you can send messages asynchronously from one system to another. If the receiving system is unable to receive the message, you can queue the message until it can be resent later.

  • XSD type and element substitution for SOAP connectors

    When you create a SOAP connector, support for XSD type and element substitution enables the Connector and Metadata wizard to generate classes with dynamic directed inheritance. The wizard also generates linked map rules when the wizard runs against a WSDL file that references a compatible external XSD document.

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