Skip to main content


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

Configuring the connection for a Connect SOAP rule

Updated on April 6, 2022

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.

  1. On the Service tab of your Connect SOAP rule, in the Service properties section, complete the following fields:
    1. In the Style and use field, specify the SOAP operation style for the messages:
      • RPC/ encoded
      • RPC/ literal
      • Document/ literal
    2. In the Method name field, enter the SOAP operation name.
    3. Optional: In the Namespace URI field, enter the Uniform Resource Identifier (URI) or Uniform Resource Name (URN) for the namespace, starting with uri: or urn:.
      This value does not need to correspond to a file at that location.
    4. Optional: In the SOAPAction header field, enter the value of the soapAction HTTP header to send with the SOAP request message.
    5. Optional: To specify that the connector sends the SOAP message and ends the connection without waiting for a response (operate asynchronously), select Request only.
      Clear this option to make the connector wait for a response (operate synchronously).
      Note: If you select this option, the connector does not wait for a response even if you configure data mappings on the Response tab.
    6. Optional: To specify that the connector reads and routes to an external system without updating the external system, select the Call is read-only checkbox.
  2. In the Integration system section, press the Down arrow key to select the integration system to use as the system of record.
  3. To include authentication credentials in the HTTP header of the SOAP request message, in the Authentication section, select Use Authentication.
    If your application requires SOAP headers that conform to a WS-Security format rather than using HTTP Basic, NTLMv1, or NTLMv2 authentication, you can configure the header directly on the Request tab.
  4. In the Authentication profile field, press the Down arrow key to select the authentication profile that contains the authentication details required by the remote service.
    This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pyAuthenticationProfile. For more information, see Configuring dynamic references to external systems by using the Global Resource Settings feature.
    Note: Pega Platform supports OAuth 2.0 authentication for SOAP connections in the following product versions:
    • 8.6.3 and later
    • 8.7.1 and later
    For other Pega Platform versions, to configure OAuth 2.0 authentication for your SOAP connector, send your SOAP envelope over a REST connector. For more information, see Creating a REST integration by using the Create REST integration wizard.
  5. In the Connection section, configure the following connection details:
    1. In the Service endpoint URL field, enter the URL of the remote service provider to which the SOAP request message is sent.
      This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pySOAPURL. For more information, see Configuring dynamic references to external systems by using the Global Resource Settings feature.
    2. Optional: In the Response timeout field, enter a number, in milliseconds, after which this rule times out and displays a failure message if no response is received.
      The default value is zero. Leave the value as zero or leave the field blank to wait indefinitely.
    3. If the external system uses HTTP token passing to maintain stateful session data between requests, in the Connection ID field, specify that a group of logically related connectors is to share one session.
      Enter an arbitrary text value in this field, and enter the same text value for the other HTTP connector rules that are to share session data.
    4. To use HTTP token-passing as the mechanism for maintaining a stateful session with the Web service provider, click Maintain session.
      If selected, make sure that you enter a value in the Connection ID field as described in step 5c.

      This field is disabled and is ignored at run time when the Intended for field in the Processing options section is set to queuing.

  6. Optional: In the Error handling section, define the properties that hold the status and exception information that the Connect-SOAP method returns.
    Note: To map SOAP fault messages returned by the external web service to the clipboard, use the Faults tab. For more information, see Configuring SOAP fault messages.
    1. In the Status value property field, specify a Single Value Identifier property to hold the status code that the Connect-SOAP method returns.
      When you generate a connector rule with the Create SOAP Integration wizard, this field is set to the standard property .pyStatusValue.The literal value Good identifies success.
    2. In the Status message property field, specify a Single Value Text property to hold the status description for the status code that the Connect-SOAP method returns.
      When you generate a connector rule with the Create SOAP Integration wizard, this field is set to the standard property.pyStatusMessage.
    3. In the Error handler flow field, identify a flow rule that routes a work item that cannot continue in its current flow when this connector rule is unable to connect to the external system.
      The default flow rule Work-.ConnectionProblem provides one approach for handling such problems. See Handling connector exceptions.
    4. In the Invocation exception property field, specify a property of mode Java Object to contain the exception object, if any occur during the execution of the connector.
  7. In the Processing options section, specify the connector requests from this Connect SOAP to process asynchronously in parallel with the calling activity, or in background by an agent.
    (The mode of execution of each connector request is determined by the Execution Mode parameter of the Connect-SOAP method, as enabled by the values in these two fields.)
    1. In the Intended for field, select one of the following options:
      • immediate execution – The SOAP connector executes synchronously; the calling activity waits for results. This is the default option.
      • queuing (response will not be available) – The SOAP connector executes asynchronously, with calls placed in a queue for processing by the Pega-IntSvcs agent. The calling activity continues without waiting for results.

        Queuing, when selected, occurs only if also specified in the Connect-SOAP method.

    2. If you selected queuing (response will not be available) in step 7a, in the Request processor field, identify a Connect Request Processor data instance that defines the classes and other characteristics of the queued connector requests, and for which the ruleset key part matches the ruleset of this Connect SOAP rule.
      For more information, see More about SOAP Connector rules.
  8. Click Save.
What to do next:

  • To confirm that Pega Platform can connect to the identified Java class, click Test connectivity any time after you have completed and saved the rule form. The system presents test results in a separate window, identifying the parameters used in the test, the steps attempted, and the outcome of each step.
  • To create a simulator for this connect rule, click Simulations. For more information, see Connect Simulators.
  • You can use the Tracer to trace and analyze connector and service events. For more information, see Application debugging by using the Tracer tool.
  • Complete the Request tab. For more information, see Configuring the request for a SOAP connector.

Related articles

Connect SOAP rulesCreating a Connect SOAP ruleConfiguring asynchronous processing for SOAP connectors

Tags

Pega Platform 8.7 Data Integration

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us