TIBCO ActiveMatrix Adapter for SAP Properties

TIBCO ActiveMatrix Adapter for SAP properties contains the adapter properties, the TIDManager properties, and the SDK fault tolerance properties.

Adapter Properties

The following table lists the adapter properties:

Property Commented out? Description
adr3.contextTimeout Yes The timeout value of the context in the inbound BAPI transactional support.

If this property is specified, this property overrides the contextTimeout property defined in the closure class during an inbound transaction from TIBCO ActiveMatrix BusinessWorks.

adr3.discovery Yes The value of ON indicates the dynamic discovery feature is enabled.

The value of OFF indicates the dynamic discovery feature is disabled.

The default value is ON.

adr3.discovery.appserver.suffix Yes The suffix of the server name used by server connections.

The property is appended with the server names returned by the Discovery Agent. For example, if the server name returned by the Discovery Agent is tibdemo and the value specified is na.tibco.com, then the server connection uses the server name as tibdemo.na.tibco.com.

It is good practice to use this property when DNS services are required for connectivity.

adr3.discovery.listenerSession Yes The session used by the subscriber created internally in adapters.

Required when using the dynamic discovery feature for outbound adapters.

adr3.discovery.listenerSubject Yes The destination used by the subscriber created internally in the adapter.

The default value is R3.APPSERVERS.ACTIVE.

Required when using the dynamic discovery feature for outbound adapters.

adr3.discovery.maxconnections Yes The maximum number of connections that can be established to the gateway of each discovered application server.

The default value is 1.

Required when using the dynamic discovery feature for the outbound adapter.

Note: The adr3.discovery.maxconnections property overwrites the adr3.maxconnections property when both of them are used.
adr3.discovery.maxretryinterval Yes The maximum retry interval in seconds when re-establishing the connection with the discovered application server.

Required when using the dynamic discovery feature for outbound adapters.

adr3.discovery.pid Yes The program IDs on which to register with the gateway of the discovered application server.

You can specify multiple program IDs as comma-separated values.

Required when using the dynamic discovery feature for the outbound adapter.

adr3.expiration_check_period Yes The interval in seconds for checking idled inbound connections to the SAP system.

If not specified, connections can be checked every 60 seconds and the idled connection can be closed automatically based on the configuration of the adr3.expiration_time property.

This property is not configurable by using TIBCO Administrator.

This property is used to control the SAP JCo property, jco.destination.expiration_check_period. For more information on the usage of this property, see the SAP JCo documentation.

The time observed when the connection is closed cannot exactly match the time configured.

adr3.expiration_time Yes The idle time allowed in seconds for inbound connections to the SAP system.

If the property is not specified and the connection is idled for more than 60 seconds, the connection is closed automatically.

This property is not configurable by using TIBCO Administrator.

This property is used to control the SAP JCo property, jco.destination.expiration_time. For more information on the usage of this property, see the SAP JCo documentation.

adr3.idocNumAndStatusIncluded No

The value of ON indicates that the IDoc number and its status are included in the IDoc confirmation message report.

The value of OFF indicates that the IDoc number and its status are not included in the IDoc confirmation message report.

For Request-Response Service services (one-way only), to include IDoc number and status, ensure RFC being invoked matches one of the following funtion modules:
  • INBOUND_IDOC_ASYNCHONOUS
  • INBOUND_IDOC_IN_QUEUE
  • IDOC_INBOUND_PROCESS
adr3.idocLogDirectory Yes The directory where the IDoc is logged to a file.

The value overrides the directory specified in the project.

adr3.jmscompress No The value of ON indicates the JMS compression is enabled.

The value of OFF indicates the JMS compression is disabled.

The default value is ON.

adr3.MACHINE_NAME No The name of machine where you installs adapters.

TIBCO Universal Installer populates the machine name when you installs TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio).

adr3.maxconnections Yes The maximum amount of connections of each type in adapter configurations.
adr3.msgReportOutboundThreadCount No The number of threads used to publish IDoc confirmation message report.

The default value is 1.

The maximum value is 10.

adr3.msgReportQueueNameSuffix Message.Confirmation No The suffix used to identify the message queue.
adr3.msgReportQueue.password No The valid password corresponding to the user name.
Note: You have to encrypt the password.
adr3.msgReportQueue.serverUrl No The URL of the remote EMS server.
adr3.msgReportQueue.userName No The valid user name used to log on to the remote EMS server.
adr3.Operation_Name. invocationTimeout Not specified by default. The invocation timeout value.

This property is dynamic and based on the name of the RFC or BAPI that is used for the invocation. If the property exists for a given RFC or BAPI, it overrides the invocation timeout specified for the corresponding endpoint. If no timeout is specified for the endpoint and this property is not specified for the RFC or BAPI, the adapter defaults to 300000 ms, which is the default time allowed by the SAP system.

Note: This property is not configurable in TIBCO Administrator.
adr3.rfcBapiReplaceNullFieldsWithSpace Yes The value of ON indicates that the TIBCO ActiveMatrix BusinessWorks mappings is prevented from being changed when you migrate a project from a non-Unicode adapter version to a Unicode version.

The value of OFF indicates that the TIBCO ActiveMatrix BusinessWorks mappings is not prevented from being changed when you migrate a project from a non-Unicode adapter version to a Unicode version.

You have to specify this property only in one of the following situations:

  • Migrate from a earlier release of the adapter where use this property.
  • Migrate from a earlier release of the adapter where the adapter is non-Unicode and the TIBCO Designer project is configured to the ISO8859_1 message encoding.
adr3.saprepository Not specified by default. The value of ON indicates that an SAP client connection is used to generate the SAP JCo repository instead of using schemas already downloaded in the adapter instance.

The value of OFF indicates that the schemas downloaded in the adapter instance are used.

The default value is ON.

Note: Only the client connection of the Dedicated Application Server type is supported.
adr3.saprepository.appserver Not specified by default. The machine from which the adapter downloads schemas when the adr3.saprepository property is set to ON.
adr3.saprepository.client Not specified by default. The client number to access the SAP system when the adr3.saprepository property is set to ON.
adr3.saprepository.language Not specified by default. The language used by the adapter to set up connection with the SAP system when the adr3.saprepository property is set to ON.

The default value is E.

adr3.saprepository.password Not specified by default. The password corresponding to the user name when the adr3.saprepository property is set to ON.
Note: You have to obfuscate the password using the obfuscate utility installed with TIBCO Runtime Agent.
adr3.saprepository.sysnr Not specified by default. The SAP system number when the adr3.saprepository property is set to ON.
adr3.saprepository.username Not specified by default. The user name to log on to the specific client when the adr3.saprepository property is set to ON.
tibco.sdk.session.jmsCompressed Not specified by default. The list of JMS session names.

All the JMS endpoints under the specified session, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

tibco.sdk.endpoint.jmsCompressed Not specified by default. The list of JMS endpoints.

All the specified JMS endpoints, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.

adr3.stopJMSEndpoint Yes The JMS endpoint used as the stop subscriber for the adapter.
adr3.stoponsubscribersaperror Yes The value of ON indicates that the adapter configuration is stopped when an adapter configuration sends an IDoc to the SAP system and receives an exception from the SAP system.

The value of OFF indicates that the adapter configuration is not stopped when an adapter configuration sends an IDoc to the SAP system and receives an exception from the SAP system.

adr3.stopSubject Yes The destination of the stop subscriber in the adapter.

If the stop subject is not specified in the adr3.stopSubject property, then the adapter dynamically builds the stop subject with this property. The convention for the stop subject when using this property is value of (adr3.MACHINE_NAME) + "." + value of (instanceID) + "." STOPADAPTER. The result is then converted to all uppercase.

Note: TIBCO Administrator relies on TIBCO Hawk and TIBCO Adapter SDK for the feature of using a stop subscriber to stop the adapter.
adr3.trace.extended Yes

The value of ON indicates that Log4j is used for logging.

The value of OFF or that the property is commented out indicates that TIBCO Adapter SDK is used for logging.

The default value is OFF.

adr3.trace.log4j.properties Yes The configuration information required by Log4j.

This property is required when the adr3.trace.extended property is set to ON.

The adr3.log4j.properties file in the TIB_ADR3_HOME/bin directory.

adr3.trace.service Yes The value of ON indicates that the logging is configured at the adapter service level.

The value of OFF indicates that the logging is not configured at the adapter service level.

Only when both the adr3.trace.extended property and this property are set to ON, you can configure logging at the adapter service level.

adr3.trace.thread Yes The value of ON indicates that the thread ID is displayed in the adapter logs.

The value of OFF indicates that the thread ID is not displayed in the adapter logs.

adr3.<Adapter_Service_Name>.jmsProperties JMS_TIBCO_COMPRESS Not specified by default. The value of 1 indicates that the JMS compression feature is enabled when the Publication Service service is using JMS transport.

The value of 0 indicates that the JMS compression feature is disabled when the Publication Service service is using JMS transport.

This property is only available in the adapter TRA file.

If you add this property in the TRA file, it takes precedence over the adr3.jmscompress property.

adr3.<Adapter_Service_Name.jmsProperties> property1=value1,

property2=value2,

property3=value3

Yes The customer JMS properties.

TIDManager Properties

The following table lists the TIDManager properties:

Property Commented out? Description
adr3TIDManager.MACHINE_NAME No The machine name where you create TIDManager configurations.

If the stop subject is not specified in the adr3TIDManager.stopSubject property, the adapter dynamically builds the stop subject with this property. The convention for the stop subject when using this property is: value of (adr3TIDManager.MACHINE_NAME) + "." + value of (instanceID) + "." STOPADAPTER. Then the result is converted to all uppercase.

TIBCO Universal Installer populates the machine name when you installs TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio).

adr3TIDManager.stopJMSEndpoint Yes The JMS endpoint used as the stop subscriber for the remote TIDManager configuration.
adr3TIDManager.stopSubject Yes The destination of the stop subscriber in the remote TIDManager configuration.
Note: TIBCO Administrator relies on TIBCO Hawk and TIBCO Adapter SDK for the feature of using a stop subscriber to stop an adapter.
adr3TIDManager.threadPool Yes The number of threads used by an TIDManager configuration for responding to requests.

The default value is 1.

adr3TIDManager.tidFile Yes The file name of the TID file of the remote TIDManager configuration.
adr3TIDManager.trace.extended Yes The value of ON indicates that Log4j is used for logging.

The value of OFF or that the property is commented out indicates that TIBCO Adapter SDK is used for logging.

The default value is OFF.

adr3TIDManager.trace.log4j.properties Yes The configuration information required by Log4j.

This property is required when the adr3TIDManager.trace.extended property is set to ON.

The adr3.log4j.properties file in the TIB_ADR3_HOME/bin directory.

adr3TIDManager.trace.thread Yes The value of ON indicates that thread IDs are displayed in the TIDManager logs.

The value of OFF indicates that thread IDs are not displayed in the TIDManager logs.

The default value is OFF.

SDK Fault Tolerance Properties

All the SDK Fault Tolerance properties are applicable to TIBCO ActiveMatrix Adapter for SAP, Discovery Agent and TIDManager.

The following table lists the SDK Fault Tolerance properties:

Property Commented out? Description
tibco.sdk.faultTolerance.ems.ackTokenOnStop Yes The value of ON indicates that the primary instance acknowledges its token when the adapter stops normally, which means a token in the specifies EMS queue is deleted.

The value of OFF indicates that the primary instance does not acknowledge its token when the adapter stops normally.

The default value is OFF.

tibco.sdk.faultTolerance.ems.enabled Yes The value of ON indicates that the Fault Tolerance feature is enabled.

The value of OFF indicates that the Fault Tolerance feature is disabled.

The default value is OFF.

tibco.sdk.faultTolerance. ems.isUsingJNDI Yes The value of ON indicates that the JNDI is used.

The value of OFF indicates that the JNDI is not used.

The default value is OFF.

tibco.sdk.faultTolerance.ems.isUsingSSL Yes The value of ON indicates that the adapter uses the SSL to connect to the JMS server.

The value of OFF indicates that the adapter does not use SSL to connect to the JMS server.

The default value is OFF.

tibco.sdk.faultTolerance.ems.jndi.providerContextFactory Yes The JNDI context factory.

The default value is com.tibco.tibjms.naming.TibjmsInitalContextFactory.

tibco.sdk.faultTolerance.ems.providerUrl Yes The URL of the EMS provider that is used for the EMS, JNDI, or SSL server. If the EMS server communicates over SSL, the prefix of the URL is ssl://. Otherwise, the prefix is tcp://.
tibco.sdk.faultTolerance.ems.jndi.password Yes The password of the JNDI connection.
tibco.sdk.faultTolerance.ems.jndi.userName Yes The user name of the JNDI connection.
tibco.sdk.faultTolerance.ems.password Yes The password for the EMS connection.
tibco.sdk.faultTolerance.ems.queueName Yes The queue name that stores the tokens in the EMS server.
tibco.sdk.faultTolerance.ems.sessionName Yes The session name that is used for Fault Tolerance. The specified session must be a JMS queue session.
tibco.sdk.faultTolerance.ems.session.factoryName Yes The factory name used when SDK creates the JMS connection factory for Fault Tolerance.
tibco.sdk.faultTolerance.ems.ssl.enableDebugTrace Yes The value of ON indicates that the SSL enables the more SSL tracing.

The value of OFF indicates that the SSL disables the more SSL tracing.

The default value is OFF.

tibco.sdk.faultTolerance.ems.ssl.enableTrace Yes The value of ON indicates that the SSL enables tracing of the loaded certificates.

The value of OFF indicates that the SSL disables tracing of the loaded certificates.

The default value is OFF.

tibco.sdk.faultTolerance.ems.ssl.enableVerifyHost Yes The value of ON indicates that the SSL client verifies the server certificate.

The value of OFF indicates that the SSL client does not verify the server certificate.

The default value is OFF.

tibco.sdk.faultTolerance.ems.ssl.enableVerifyHostName Yes The value of ON indicates that the SSL client verifies the name in the server certificate.

The value of OFF indicates that the SSL client does not verify the name in the server certificate.

The default value is OFF.

tibco.sdk.faultTolerance.ems.ssl.expectedHostName Yes The name in the server certificate.
Note: Required when the enableVerifyHostName and enableVerifyHost are both set to ON.
tibco.sdk.faultTolerance.ems.ssl.identity Yes The path of the client identity.
tibco.sdk.faultTolerance.ems.ssl.isStrongCipherSuites Yes The value of ON indicates that only the strong cipher suites are allowed.

The value of OFF indicates that not only the strong cipher suites are allowed.

The default value is OFF.

tibco.sdk.faultTolerance.ems.ssl.password Yes The client identity password.
Note: Required when the identity is specified.
tibco.sdk.faultTolerance.ems.ssl.trustedDir Yes The full path of the folder where the required certificates are located.
Note: Required when the connection between the EMS client and EMS server is over SSL.
tibco.sdk.faultTolerance.ems.userName Yes The user name for the EMS connection.