SAPConnection configurable service

Select the objects and properties that you want to change for the SAPConnection configurable service.

For SAPConnection configurable services, you must stop and start the integration server for a change of property value to take effect.

Supplied configurable services that are created for each integration node Properties for each configurable service that is defined Description of properties

None

applicationServerHost

Specifies the IP address or the 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.

assuredOnceDelivery

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

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

client

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.

connectionIdleTimeout

The number of seconds for which a connection can be idle before it is closed by IBM® Integration Bus 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.

gatewayHost

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

This property is not mandatory.

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

gatewayService

The identifier of the gateway on the gateway host that carries out the Remote Function Call (RFC) services. This property applies to .inadapter and .outadapter files.

This property is not mandatory.

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 the gatewayService 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, the gatewayService property of this configurable service is set to sapgw01.
  • If the service is not defined in the etc/services file, the gatewayService property of this configurable service is set to 3301.

loadBalancing

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 applicationServerHost property. If you set this property to false, the logonGroup, messageServer, and SAPSystemID properties are ignored.

Set this property to true to connect to a message server by using the logonGroup, messageServer, and SAPSystemID 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 on this configurable service. If some of these properties are overridden on the configurable service, 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.

logonGroup

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.

MessageServerHost

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.

numberOfListeners

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 only to .inadapter files.

If you set the numberOfListeners 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.

retryConnectionOnStartup

Specifies whether to go into a retry cycle if it is not possible to make a connection to the SAP system when the SAPInput node is deployed or when the integration node or integration server is started. This property applies only to .inadapter files.

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.

retryInterval

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

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

retryLimit

Specifies the number of times the adapter tries to restart the event listeners. This property applies only to .inadapter files.

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

RFCTraceLevel

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.

RFCTracePath

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 RFCTraceOn property is set to true. By default, the value of this property is an empty string, therefore, when RFCTraceOn is set to true, you must set a valid path for the RFCTracePath.

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

RFCTraceOn

Specifies whether to generate a text file detailing 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.

rfcProgramID

The remote function call identifier under which the adapter registers in the SAP gateway. This property applies only to .inadapter files.

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.

SAPSystemID

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.

sharedTidStoreClientDefinitionFile

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.

sharedTidStoreQmgr

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.

systemNumber

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.