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.
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:
|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.|
Select to indicate the timing of execution
|EndPointURL||Optional. Enter an endpoint URL value to override the value in the Connect SOAP rule.|
The Connect-SOAP method works as follows:
- Using rule resolution, locates the Connect SOAP rule identified by the ServiceName parameter and the class of the step page or primary page.
- Uses request information to assemble a SOAP request message for the Web service.
- If the step page does not exist, creates a new page, of the class identified in the Pages & Classes tab.
Checks whether simulation is in force for this rule. If true, results depend on the
Run— Executes the simulation activity synchronously
Run In Parallel— Executes the simulation activity in a separate requestor
Queue— Queues the simulation activity
If simulation is not in force, calls the Web service, or queues the request, depending
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.