Skip to main content

SAP Connector form - Completing the Service tab

Suggest edit
Updated on April 6, 2022

Use the Service tab to identify the properties of the remote service that is called. The settings are different for IDoc and SOAP connector types.

Important: Connect SAP rules are no longer being actively developed, and are being considered for deprecation in upcoming releases. Using Connect SAP rules does not follow Pega development best practices. Use Connect SOAP rules instead. For more information, see Connect SOAP rules.

Completing the Service tab for the IDoc connector type

If you create or update a Connect SAP rule of IDoc connector type, use the Service tab to enter the authentication details that you want to use to connect to the SAP system and configure the request and response.

Complete the following sections:

SAP connection

FieldDescription
Authentication profile Optional. Select or create an authentication profile that you want to use to connect to the SAP system.
Client numberRequired. Specify the client number of the SAP system.
Server host nameRequired. Specify the server host name of the SAP system.
PortRequired. Specify the port number of the SAP system.
Use SSL/TLSSelect this check box if you want to use a secure SSL/TSL protocol to connect to the SAP system.
Integration systemPress the Down arrow key to select the integration system to use as the system of record.

Request

FieldDescription
IDoc XML stream Required. Specify or create an XML stream that represents an IDoc XSD input document. This input document describes the external SAP service.

Response

FieldDescription
Status code Optional. Specify a Single Value Identifier property to hold the status code that the Connect-SAP method returns. This field is set to the standard property . pyStatusValue by default.
Status detail Optional. Specify a Single Value Text property to hold the status description for the status code that the Connect-SAP method returns. This field is set to the standard property . pyStatusMessage by default.
Test connectivity Click this button at any time after you have completed and saved the form to confirm that the Pega Platform can connect to the SAP system.

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.

Completing the Service tab for the SOAP connector type

If you are creating or updating a Connect SAP rule of SOAP connector type, use the Service tab to identify the properties of the remote SOAP service used by the SAP connector.

Complete the following sections:

Service properties

FieldDescription
Style and use Specify the SOAP operation style for the messages:
  • Select RPC/encoded for RPC-encoded.
  • Select Document/ literal for document-literal.
  • Select RPC/ literal for RPC-literal.
Method nameSpecify the SOAP operation name.
Namespace URIOptional. 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.
Call is read-onlySelect this check box to enable the SAP rule to read from or route to an external system, without updating the external system.
Integration systemPress the Down arrow key to select the integration system to use as the system of record.

Authentication

FieldDescription
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.

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

FieldDescription
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 Configuring dynamic references to external systems by using the Global Resource Settings feature.

Response timeoutOptional. 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 run time 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 Configuring dynamic references to external systems by using the Global Resource Settings feature.

Connection IDOptional. 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 sessionSelect 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 run time when the Intended for field is set to queuing.

SAP configuration

FieldDescription
SAP authentication profile Optional. Select or create an authentication profile that you want to use to connect to the SAP system.
Client numberOptional. Specify the client number of the SAP system.
LanguageOptional. Specify the language that you want to use to connect to the SAP system.
Server host nameOptional. Specify the server host name of the SAP system.
System numberOptional. Specify the system number of the SAP system.
System IDOptional. Specify the system ID of the SAP system.
SAP routerOptional. Specify the router information of the SAP system.

Error handling

FieldDescription
Error handling

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

Status value property

Optional. Specify a Single Value Identifier property to hold the status code that the Connect-SAP method returns. When you generate a connector rule with the New SAP Integration wizard, 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-SAP method returns. When you generate a connector rule with the New SAP Integration wizard, 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.

You can allow connector requests from this Connect SAP 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-SAP method, as enabled by the values in these two fields.)

Processing options

FieldDescription
Intended for Optional. Select:
  • immediate execution — The SAP connector executes synchronously; the calling activity waits for results.
  • queuing (response will not be available) — The SAP 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-SAP method.
Request processorOptional. 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 SAP rule. See More about SAP Connector rules.
Test connectivityClick 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.

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

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

  • Previous topic Connect SAP rules - Completing the Create, Save As, or Specialization form
  • Next topic SAP Connector form - Completing the Request tab
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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