Connect-SOAP method

Use the Connect-SOAP method to invoke a Web service identified in a Connect SOAP or Connect SAP rule ( Rule-Connect-SOAP rule type).

Operation of this method can be affected by dynamic system settings. See More about Connect SOAP rules.

Parameters

This method operates on a named clipboard page that is the source and destination of data mappings. Make sure the Step Page column that calls this method contains the non-blank name of such a page.

This method has four parameters:

Parameter Description
ServiceName Enter the Service Name (second key part) of a Connect SOAP rule, an instance of the Rule-Connect-SOAP rule type. The system uses the class of the step page as the first key part of the rule.
Execution Mode Select to indicate the timing of execution
  • Run — Execute the connector synchronously; the next step of the activity containing the Connect-SOAP method does not execute until the connector response is received.
  • Run in Parallel — This connector is to run in parallel as a child requestor of the current requestor. If selected, use the Connect-Wait method later in the current or a follow-on activity to access results from the connector. Do not select this value if the Connect SOAP rule supports compensating actions.
  • Queue — Add this connector request to a queue, defined by a Connect Request Processor data instance, for background processing by the Pega-IntSvcs ProcessConnectQueue agent. This mode works only if the Request Processor field on the Service tab of the SOAP Service rule identifies a Data-Admin-RequestProcessor-Connect data instance. When the agent executes a queued connector request, the execution is performed with the authorization profile of the original requestor.
EndPointURL Optional. Enter an endpoint URL value to override the value in the Connect SOAP rule.

Results

The Connect-SOAP method works as follows:

  1. Using rule resolution, locates the Connect SOAP rule identified by the ServiceName parameter and the class of the step page or primary page.
  2. Uses request information to assemble a SOAP request message for the Web service.
  3. If the step page does not exist, creates a new page, of the class identified in the Pages & Classes tab.
  4. Checks whether simulation is in force for this rule. If true, results depend on the Execution mode value:
    • Run — Executes the simulation activity synchronously
    • Run In Parallel — Executes the simulation activity in a separate requestor
    • Queue — Queues the simulation activity
  5. If simulation is not in force, calls the Web service, or queues the request, depending on the Execution mode value:
    • Run — Calls the Web service and waits for a response.
    • Run In Parallel — Executes in a separate requestor. (This temporary requestor has the same access group and clipboard as the original. At most 10 such child requestor sessions can be active at once.)
    • Queue — Creates a queue item based on the class and other characteristics identified in the Connect Request Processor, for later background processing by the Pega-IntSvcs agent.
    • Processes the SOAP response message when it is received. (No response is available for queued connector requests.)

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

CAUTION:
Design the activity to detect and handle exceptions. If the Connect-SOAP method with the Execution Mode of Run In Parallel fails in a way that causes the Connect-Wait method to be skipped, the child requestor can be left hanging. If the limit of parallel requestors is then eventually reached, the parent requestor fails as well. By default, the limit is 10 requestors in parallel; you can establish a higher or lower value in the prconfig.xml file or dynamic system settings using the services/maxRequestorChildren setting.