SAP Connector form - Completing the Service tab
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.
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
| Field | Description |
| Authentication profile | Optional. Select or create an authentication profile that you want to use to connect to the SAP system. |
| Client number | Required. Specify the client number of the SAP system. |
| Server host name | Required. Specify the server host name of the SAP system. |
| Port | Required. Specify the port number of the SAP system. |
| Use SSL/TLS | Select this check box if you want to use a secure SSL/TSL protocol to connect to the SAP system. |
| Integration system | Press the Down arrow key to select the integration system to use as the system of record. |
Request
| Field | Description |
| 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
| Field | Description |
| 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
| Field | Description |
| Style and use |
Specify the SOAP operation style for the messages:
|
| 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). |
| Call is read-only | Select this check box to enable the SAP rule to read from or route to an external system, without updating the external system. |
| Integration system | Press the Down arrow key to select the integration system to use as the system of record. |
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. |
| 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
(= |
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
(= |
| 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 run time when the
Intended for field is set to This field supports the Global Resource Settings syntax
(= |
| 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 run time when the Intended for field is set to
|
SAP configuration
| Field | Description |
| SAP authentication profile | Optional. Select or create an authentication profile that you want to use to connect to the SAP system. |
| Client number | Optional. Specify the client number of the SAP system. |
| Language | Optional. Specify the language that you want to use to connect to the SAP system. |
| Server host name | Optional. Specify the server host name of the SAP system. |
| System number | Optional. Specify the system number of the SAP system. |
| System ID | Optional. Specify the system ID of the SAP system. |
| SAP router | Optional. Specify the router information of the SAP system. |
Error handling
| Field | Description |
| 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 |
| 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
| Field | Description |
| Intended for | Optional. Select:
Blank is equivalent to |
| 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 SAP rule. |
| 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. |
| Simulations | Click 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