Connect SOAP form – Completing the Service tab

Use the Service tab to identify the properties of the remote SOAP service. Complete this tab first.

Service properties

Field Description
Style and use Specify the SOAP operation style for the messages:
  • Choose RPC / encoded for RPC-encoded.
  • Choose RPC / literal for RPC-literal.
  • Choose Document for document-literal.
Method Name Specify the SOAP operation name.
Namespace URI Optional. Enter the Uniform Resource Identifier (URI) or Uniform Resource Name (URL) for the namespace, starting with uri: or urn :. This need not correspond to a file at that location.
SOAPAction Header Optional. Enter the value of the soapAction HTTP header to send with the SOAP request message.
Request Only Select to specify the connector is to send the SOAP message and end the connection without waiting for a response (operate asynchronously). Clear this option to specify that the connector is to 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.

Authentication

Field Description
Use Authentication? If selected, Pega Platform includes authentication credentials in the HTTP header of the SOAP request message.

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.

Note: If you open a Connect SOAP instance configured in a version prior to Version 6.2, the rule form contains a Username Property and Password Property field. To update the rule to use the Authentication Profile, save the rule and refresh the rule form. The Username Property and Password Property fields are replaced with the Authentication Profile field populated with a new profile.
Authentication Profile Required, if Use Authentication? is selected. 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 Using the Global Resource Settings feature.

Connection

Field Description
Service Endpoint URL 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 Using the Global Resource Settings feature.

Response Timeout Optional. Enter a number of milliseconds after which, if no response is received, this rule times out with a failure message. Enter zero or leave blank to wait indefinitely.

This field is disabled and ignored at runtime when the Intended for field is set to queuing.

This field supports the Global Resource Settings syntax (=PageName.PropertyName). The default property name for this field is pySOAPTimeout. For more information, see Using the Global Resource Settings feature.

Connection ID

Optional. If the external system uses HTTP token passing to maintain stateful session data between requests, you can use this field to specify that a group of logically related connectors is share one session. Enter an arbitrary text value in this field, and enter the same text value in the other HTTP connector rules that are to share session data.

Maintain Session? Select to use HTTP token-passing as the mechanism for maintaining a stateful session with the Web service provider. If selected, enter a Connection ID value in the previous field.

This field is disabled and ignored at runtime when the Intended for field is set to queuing.

Error handling

The properties in this section hold status and exception information returned by the Connect-SOAP method. To map SOAP fault messages returned by the external web service to the clipboard, use the Faults tab.

Field Description
Status Value Property

Optional. 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 Accelerator, this field is set to the standard property . pyStatusValue. The literal value Good identifies success.

Status Message Property Optional. 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 Accelerator, this field is set to the standard property . pyStatusMessage.
Invocation Exception Property Optional. Specify a property of mode Java Object to contain the exception object, if any are thrown during the execution of the connector.
Error Handler Flow Optional. Identify a flow rule that routes to an appropriate place a work item that cannot continue in its current flow because this connector rule was unable to connect to the external system. The default flow rule Work-.ConnectionProblem provides one approach for handling such problems. See Handling connector exceptions.

Processing options

You can allow connector requests from this Connect SOAP to be processed 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.)

Field Description
Intended For Optional. Select:
  • immediate execution — the SOAP connector executes synchronously; the calling activity waits for results.
  • 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.

Blank is equivalent to immediate execution.

Queuing, when selected, occurs only if also specified in the Connect-SOAP method.
Request Processor Optional. If you selected queuing for the Intended for field, identify here 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. See More about SOAP Connector rules.
Test Connectivity Click this button at any time after you have completed and saved the form to confirm that Pega Platform can connect to the Java class identified.

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.

Click Test Connectivity at any time after you have completed and saved the form to confirm that Pega Platform can connect to the Java class identified.

Click Simulations to create a simulator for this connect rule. See Connect Simulators.

You can use Tracer to trace and analyze connector and service events.