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 adapter properties are listed in the following table:

Property	Commented out?	Description
adr3.contextTimeout	Yes	Defines 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	Defines whether to enable the dynamic discovery feature. The valid values is ON or OFF. The default value is ON.
adr3.discovery.appserver.suffix	Yes	Defines 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	Defines the session used by the subscriber created internally in adapters. Required when using the dynamic discovery feature for outbound adapters.
adr3.discovery.listenerSubject	Yes	Defines 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	Defines 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	Defines 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	Defines 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	Defines 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	Defines 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.idocLogDirectory	Yes	Defines the directory to log the IDoc to a file. The value overrides the directory specified in the project.
adr3.jmscompress	No	Indicator of whether to enable the JMS Compression feature. The value of ON indicates this feature is enabled. The value of OFF indicates this feature is disabled. The default value is ON.
adr3.MACHINE_NAME	No	Defines 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	Defines the maximum amount of connections of each type in adapter configurations.
adr3.`operationName`. invocationTimeout	Not specified by default.	Defines the timeout value for the invocation. 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	Defines whether to prevent the TIBCO ActiveMatrix BusinessWorks mappings from being changed when you migrate a project from a non-Unicode adapter version to a Unicode version. The valid value is ON or OFF. 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.stopJMSEndpoint	Yes	Defines the JMS endpoint used as the stop subscriber for the adapter.
adr3.stoponsubscribersaperror	Yes	Defines whether to stop the adapter configuration when an adapter configuration sends an IDoc to the SAP system and receives an exception from the SAP system. The valid value is ON or OFF.
adr3.stopSubject	Yes	Defines 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	Defines the logging mechanism of adapters. The value of ON indicates using Log4j for logging. The value of OFF or that the property is commented out indicates using TIBCO Adapter SDK for logging. The default value is OFF.
adr3.trace.log4j.properties	Yes	Defines 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	Defines whether to configure logging at the adapter service level. The valid value is ON or OFF. The default value is OFF. 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	Defines whether display the thread ID in the adapter logs. The value of ON or OFF. The default value is OFF.
adr3.idocNumAndStatusIncluded	No	Defines whether to include the IDoc number and its status in the IDoc confirmation message report. The value of ON or OFF. The default value is ON. 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.msgReportOutboundThreadCount	No	Defines 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	Defines the suffix to identify the message queue.
adr3.msgReportQueue.serverUrl	No	Defines the URL of the remote EMS server.
adr3.msgReportQueue.userName	No	Defines the valid user name to log on to the remote EMS server.
adr3.msgReportQueue.password	No	Defines the valid password corresponding to the user name. Note: You have to encrypt the password.
tibco.sdk.session.jmsCompressed	Not specified by default.	Defines 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.	Defines the list of JMS endpoints. All the specified JMS endpoints, including Publisher, Client, and Server, send compressed JMS messages to the EMS server.
adr3.<adapter_service_name>.jmsProperties <property1>=<value1>,<property2> =<value2>,<property3>=<value3>	Yes	Defines the customer JMS properties.
adr3.<adapter_service_name>.jmsProperties JMS_TIBCO_COMPRESS	Not specified by default.	Defines whether to enable the feature of compressing messages by using TIBCO Adapter SDK, 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.

TIDManager Properties

The TIDManager properties are listed in the following table:

Property	Commented out?	Description
adr3TIDManager.MACHINE_NAME	No	Defines 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	Defines the JMS endpoint used as the stop subscriber for the remote TIDManager configuration.
adr3TIDManager.stopSubject	Yes	Defines 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	Defines the number of threads used by an TIDManager configuration for responding to requests. The default value is 1.
adr3TIDManager.tidFile	Yes	Defines the file name of the TID file of the remote TIDManager configuration.
adr3TIDManager.trace.extended	Yes	Defines the logging mechanism of the remote TIDManager configuration: The value of ON indicates using Log4j for logging. The value of OFF or that the property is commented out indicates using TIBCO Adapter SDK for logging. The default value is OFF.
adr3TIDManager.trace.log4j.properties	Yes	Defines 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	Defines wether to display thread IDs in the TIDManager logs. The valid value is ON or OFF. The value of 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 SDK Fault Tolerance properties are listed in the following table:

Property	Commented out?	Description
tibco.sdk.faultTolerance.ems.enabled	Yes	Defines wether to enable the Fault Tolerance feature. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.queueName	Yes	Defines the queue name that stores the tokens in the EMS server.
tibco.sdk.faultTolerance.ems.sessionName	Yes	Defines the session name that is used for Fault Tolerance. The specified session must be a JMS queue session.
tibco.sdk.faultTolerance.ems.providerUrl	Yes	Defines 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.session.factoryName	Yes	Defines the factory name used when SDK creates the JMS connection factory for Fault Tolerance.
tibco.sdk.faultTolerance.ems.userName	Yes	Defines the user name for the EMS connection.
tibco.sdk.faultTolerance.ems.password	Yes	Defines the password for the EMS connection.
tibco.sdk.faultTolerance.ems.ackTokenOnStop	Yes	Defines whether the primary instance acknowledges its token when the adapter stops normally. A value of on indicates the token held by the primary instance is acknowledged, which means a token in the specifies EMS queue is deleted. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance. ems.isUsingJNDI	Yes	Defines whether the JNDI is used. A value of on indicates JNDI. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.jndi.providerContextFactory	Yes	Defines the JNDI context factory. The default value is com.tibco.tibjms.naming.TibjmsInitalContextFactory.
tibco.sdk.faultTolerance.ems.jndi.userName	Yes	Defines the user name of the JNDI connection.
tibco.sdk.faultTolerance. ems.jndi.password	Yes	Defines the password of the JNDI connection.
tibco.sdk.faultTolerance.ems.isUsingSSL	Yes	Defines whether the adapter connects to the JMS server using SSL. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.enableTrace	Yes	Specify whether the SSL enables tracing of the loaded certificates. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.enableDebugTrace	Yes	Defines whether the SSL enables the more SSL tracing. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.enableVerifyHostName	Yes	Defines whether the SSL client verifies the name in the server certificate. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.enableVerifyHost	Yes	Defines whether the SSL client verifies the server certificate. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.expectedHostName	Yes	Defines the name in the server certificate. Note: Required when the `enableVerifyHostName` and `enableVerifyHost` are both set to ON.
tibco.sdk.faultTolerance.ems.ssl.isStrongCipherSuites	Yes	Defines whether only the strong cipher suites are allowed. The valid value is ON or OFF. The default value is OFF.
tibco.sdk.faultTolerance.ems.ssl.trustedDir	Yes	Defines 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.ssl.identity	Yes	Defines the path of the client identity.
tibco.sdk.faultTolerance.ems.ssl.password	Yes	Defines the client identity password. Note: Required when the identity is specified.