IBM App Connect Enterprise, Version 11.0.0.2 Operating Systems: Windows, Linux


SAP Connection policy (SAPConnection)

Attach an SAP Connection policy to one or more SAP nodes in a message flow to control connection details at run time.

You use SAPInput and SAPRequest nodes to accept input from, and send requests to, SAP applications. SAP nodes can get SAP connection details from either the adapter component or a policy. By using a policy, you can change the connection details for an adapter at run time without the need to redeploy the adapter.

To attach an SAP Connection policy to an SAPInput or SAPRequest node, set the Primary adapter component property on the node to the name of the policy, in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.

The properties of this policy are described in the following table.
Table 1. Properties of the SAP Connection policy
Property Property name in .policyxml file Value
RFC program ID rfcProgramID This property specifies the remote function call identifier that the adapter uses to register in the SAP gateway. This property applies to .inadapter files only.

The value of this property must match the RFC Program ID that is registered in SAP (transaction SM59). The default value is an empty string, which indicates that behavior is controlled by the .inadapter file.

Value type: String

Application server host applicationServerHost This property specifies the IP address or name of the application server host to which the adapter logs on. This property applies to .inadapter and .outadapter files.

This property is mandatory; you must set the value to a valid SAP server host name or IP address. The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

SAP gateway service gatewayService This property specifies the identifier of the gateway on the gateway host that completes the Remote Function Call (RFC) services. This property applies to .inadapter and .outadapter files.

This property is not mandatory, and the default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

The property controls the port number that the integration node uses when establishing a TCP/IP connection to the SAP server. Set the property to either of the following values:
  • The name of the service, which must be defined in the services (/etc/services or C:\Windows\System32\drivers\etc\services) with the port number that corresponds to the port on which the SAP gateway is listening
  • The port number
The name of this property and its corresponding port number typically depend on the system number. The gateway service name is usually sapgwXX and the port number is 33XX, where XX is the system number. For example, if the system number is 01, one of the following conditions applies:
  • The etc/services file typically has a line with sapgw01 3301/tcp defined; in which case, this property is set to sapgw01.
  • If the service is not defined in the etc/services file, this property is set to 3301.

Value type: String

Client client This property specifies the client number of the SAP system to which the adapter connects. This property applies to .inadapter and .outadapter files.

Set this property to the required SAP client number, which is a three-digit integer in the range 000 - 999. The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

SAP gateway host name gatewayHost This property specifies the host name of the SAP gateway. This property applies to .inadapter and .outadapter files.

This property is not mandatory, and the default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

System number systemNumber This property specifies the system number of the SAP application server. This property applies to .inadapter and .outadapter files.

This property is not mandatory. Set this property to the required SAP system number, which is a two-digit integer in the range 00 - 99. The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

RFC global trace level RFCTraceLevel This mandatory property specifies the global trace level. This property applies to .inadapter and .outadapter files.
This property is not mandatory.
  • If you set this value to 1, SAP JCo Java™ API logging occurs.
  • If you set this value to 3, SAP JCo JNI API logging occurs.
  • If you set this value to 5, error diagnostic logging occurs.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: Integer

RFC trace path RFCTracePath This property sets the fully qualified local path to the folder into which the RFC trace files are written. This property applies to .inadapter and .outadapter files.

This property is mandatory only if the RFC trace enabled property is set to true. By default, the value of this property is an empty string; therefore, when RFC trace enabled is set to true, you must set a valid path for the RFC trace path property.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

RFC trace enabled RFCTraceOn This property controls whether to generate a text file that details the RFC activity for each event listener. This property applies to .inadapter and .outadapter files.

This property is not mandatory. Set this property to true to enable RFC trace. The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: Boolean

Number of listeners numberOfListeners This mandatory property specifies the number of RFC connections that are established to SAP by the .inadapter component. This number corresponds to the maximum number of RFC or tRFC calls from SAP that can be handled concurrently by the adapter. This property applies to .inadapter files only.

If you set this property to 1, the number of listeners matches the number of additional instances in the message flow. If you set this property to any value other than 1, that value represents the number of listeners. The default value is an empty string, which indicates that behavior is controlled by the .inadapter file.

Value type: Integer

Shared TID store queue manager sharedTidStoreQmgr This property specifies the name of the queue manager that is used to store the state for tRFC events. This property applies to .inadapter and .outadapter files.

By setting this property, adapters on separate integration nodes can share the same store and process IDocs by using the same RFC Program ID while still providing the "exactly once" quality of service.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

Shared TID store client definition file sharedTidStoreClientDefinitionFile This property specifies the URL to a client definition table that is used when connecting to the event store queue manager. This property applies to .inadapter and .outadapter files.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

Load balancing loadBalancing This property specifies how to connect to a message server or application server. This property applies to .inadapter and .outadapter files.

You can set this property to true or false.

Set this property to false to connect directly to the application server that is specified in the Application Server host property. If you set this property to false, the Logon group, Message server host name, and SAP system ID properties are ignored.

Set this property to true to connect to a message server by using the Logon group, Message server host name, and SAP system ID properties. If you set this property to true, the values that are configured on the .inadapter or .outadapter file are used, unless they are overridden by this policy. If some of these properties are overridden by the policy, they are used, and the rest of the properties are taken from the .inadapter or .outadapter file.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: Boolean

Logon group logonGroup This property specifies the name of the group of application server instances that have been defined in transaction SMLG and linked together for logon load balancing. This property applies to .inadapter and .outadapter files.

You can set this property to any string. The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

Message server host name messageServerHost This property specifies the name of the host on which the message server is running. This property applies to .inadapter and .outadapter files.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

SAP system ID SAPSystemID This property specifies the system ID of the SAP system for which logon load balancing is allowed. This property applies to .inadapter and .outadapter files.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter or .outadapter file.

Value type: String

Assured once-only delivery assuredOnceDelivery This property specifies whether to provide assured once-only delivery for inbound events. This property applies to .inadapter files only.

You can set this property to true or false. The default value is an empty string, which indicates that behavior is controlled by the .inadapter file.

Value type: Boolean

Retry connection on start-up retryConnectionOnStartup This property specifies whether to start a retry cycle if a connection cannot be made to the SAP system when the SAPInput node is deployed or when the integration node or integration server is started. This property applies to .inadapter files only.

You can set this property to true or false. If you set this property to false, deployment fails if a connection cannot be made. Otherwise, deployment succeeds and the adapter tries to connect again in the background. User trace reports the status of these attempts.

The default value is an empty string, which indicates that behavior is controlled by the .inadapter file.

Value type: Boolean

Retry limit retryLimit This mandatory property specifies the number of times the adapter tries to restart the event listeners. This property applies to .inadapter files only.

Set this property to a positive integer. The default value is an empty string, which indicates that behavior is controlled by the .inadapter file.

Value type: Integer

Retry interval retryInterval This mandatory property specifies the time interval (in milliseconds) between attempts to restart the event listeners. This property applies to .inadapter files only.

Set this property to a positive integer. The default value is an empty string, which indicates that behavior is controlled by the .inadapter component.

Value type: Integer

Connection idle timeout (seconds) connectionIdleTimeout This property specifies the number of seconds for which a connection can be idle before it is closed by IBM® App Connect Enterprise to effectively maintain the connection pool. The default value for this property is 0 (zero) seconds, indicating that no timeout occurs.

New connections to SAP are opened with different user IDs, therefore do not set this property to zero if you are using identity propagation.

Value type: Integer


py00131_.htm | Last updated 2018-11-02 14:46:47