TIBCO ActiveMatrix Adapter for Database Properties

This is an instance-level parameter, which specifies a time after which the adapter triggers a timer for refresh connection. The default value is 300 minutes.

This is an instance-level parameter, which indicates that every service under an instance can refresh a connection after a configured time elapses. Its default value is off. An instance has only one timer while a service does not have a timer. When the adb.connDBRefresh property is set to on, a timer is created.

A publisher adapter changes the delivery status of a message from F to N and then republishes the message.The auto update status to 'N' statement is as follows:

UPDATE ADBDEV_TEST_PUB_P SET ADB_L_DELIVERY_STATUS = 'N' WHERE ADB_L_DELIVERY_STATUS = 'F'

Set JMS message properties when using JMS transport type for the Publication Service. For more information, see TIBCO Enterprise Message Service documentation.

During the runtime, it has higher precedence than the adb.jmscompress variable.

When setting the value to on, the adapter can poll remaining records continuously regardless of the Polling Interval value you set.

Preregisters RVCM names for the specified subjects.

For example,

adb.ADBPublisher.preRegisteredListeners=adb.sub1:rvcm1,adb.sub2:rvcm2

preregisters RVCM name rvcm1 to subject adb.sub1, and RVCM name rvcm2 to subject adb.sub2.

For more information, see Advanced Topics, Preregistering a Certified Subscriber.

Size of an internal message queue in the service level. The default value is 1000.

In the previous release, the default value of this property is -1, which indicates that the adapter does not limit the queue size. If you use the default value, when the adapter receives a large number of messages from a TIBCO messaging bus within a short period, in which the receiving speed exceeds the processing speed of the adapter, an OutOfMemory error might occur.

To resolve this issue, the default value is changed to 1000 in this release. Even within a short time, the adapter fetches only 1000 rows, which contributes to a reasonable performance of the adapter.

Selection of the sessionName or serviceName variable depends on whether you use a separate session. Specify the sessionName variable if you do not use a separate session; specify the serviceName variable if you use a separate session.

For more information on how to configure the internal queue, see Configuring the Internal Message Queue.

Interval that the adapter waits to retrieve messages from the transport queue when the internal message queue is saturated. The default value is 500 ms.

Selection of the sessionName or serviceName variable depends on whether you use a separate session. Specify the sessionName variable if you do not use a separate session; specify the serviceName variable if you use a separate session.

For more information on how to configure the internal queue, see Configuring the Internal Message Queue.

This feature helps improve the performance of your queries. This feature is only supported by Oracle and SQLServer databases.

See Using Hints for more information.

Setting the property to on to add custom methods to the adapter’s standard microagent. Setting to off to disable adding. The default value is set to on. See Managing and Monitoring an Adapter Project for more information.

The default iSeries library to be accessed and only used for library name verification.

Applies only to the Publication Service and Subscription Service.

It applies only to the Publication Service and Subscription Service.

The rules for which library name is used are as follow:

If the library name specified in design time is equal to the name of adb.as400.defaultlibrary, the adapter will use adb.as400.library name specified in the TRA file.

If adb.as400.library name specified in the TRA file is equal to adb.as400.defaultlibrary name, the adapter will use the library name specified in design time.

If the library name is not defined in design time, the publishing table cannot be created.

The default property value is set to off.

When adb.PollingBatchSize is used, this optimizes publishing performance by batching message status updates to the publishing table. Do not use this option when messages are published using a parameterized subject name.

If an adapter instance stops before a batch update is performed, the status column is not updated. As a result, duplicate messages are published when the instance is restarted.

Applies only to Subscription Service. This property sets the default scale of Oracle Number(empty) datatype. It is used to control the entered number with high precision.

The standard date format pattern for java.text.SimpleDateFormat. The default format is yyyy-MM-dd.

The debug printing level. If not specified, the default, 2, is used. Possible values are:

Applies only to Subscription Service. This property specifies the number of messages to be batched before invoking a commit operation. The default value is 1.

You can set this property if you want to enable batch commit without using separate sessions in TIBCO Designer.

If you set values for both the adb.subBatchCommitSize property and the adb.<default session name>.subBatchCommitSize property, the value of the adb.subBatchCommitSize property is used.

Note: If messages greater than 32K are published, batching is automatically turned off.

Applies only to Subscription Service. This property specifies the longest interval between two batch commits. When the specified timeout expires, the subscriber adapter commits all the received messages even if the number does not reach the specified batch commit size.

You can set this property if you want to enable batch commit without using separate sessions in TIBCO Designer. The default value is 10,000 milliseconds.

If you set values for both the adb.subBatchCommitTimeout property and the adb.<default session name>.subBatchCommitTimeout property, the value of the adb.subBatchCommitTimeout property is used.

When this property is set to on, the adapter does not terminate on receiving a termination subject message.

Specifies the number of rows to publish in a single message. Overrides the Group Size setting in the publication service configuration.

Determine whether you use JMS transport type to send byte messages. The default value is off.

One of JMS properties. Applies only to the Publication Service with JMS transport type.

Either on or off. The default value is off, which indicates that JMS messages is not compressed.

See Compressing JMS Messages for more information.

The path of the properties file.

The buffer size. Used for long data types such as BLOB.

Disables detection of duplicate configurations.

Either on or off. The default value is off, which indicates that duplicate configurations is detected.

The design-time table objects schema.

For more information, see Advanced Topics, Runtime Table Schema Configuration.

Password used by the adapter to access databases. If it is not specified, the runtime will call the password in the design time. If it is set in the TRA file, the runtime will call the password from the TRA file.

This property specifies whether only the error information or all the logging information is printed in the log file.

The default value is off, and it applies only to Subscription Service.

When configuring this property, you must note the following conditions:

The number of messages. It prints the performance report after processing the number of message.

Either on or off. The default is off. See Available TIBCO Hawk Methods for more information.

Applies only to publisher instances. Limits the amount of messages to be fetched. The value indicates the number of parent rows to be fetched for a polling interval. The default value is 1000.

In the previous release, the default value of this property is 0, which indicates that all new rows will be fetched. If you use the default value, when the adapter receives a large number of messages from a database within a short period, in which the receiving speed exceeds the processing speed of the adapter, an OutOfMemory error might occur.

To resolve this issue, the default value is changed to 1000 in this release. Even within a short time, the adapter fetches only 1000 rows, which contributes to a reasonable performance of the adapter.

Specifies the polling period. This property applies only to Publication Service. If not specified, the default value of 5000 milliseconds is used.

Either on or off. The default is off.

Applies only to publisher instances with publications that use certified message delivery. Optimizes performance by batching message status advisories to the publishing table. The value indicates the number of advisory messages to include in a single batch.

Do not use this option when messages are published using a parameterized subject name.

Note: If an adapter instance stops before a batch update is performed, the status column is not updated. As a result, messages that were successfully published still have a status of P (pending) in the publishing table when the adapter instance is restarted. In this case, the ledger file contains the correct status information. A smaller value for this property decreases this risk.

Applies only to publisher instances with publications that use certified message delivery. This property specifies the number of milliseconds to wait before updating the status column. After this interval, an update is performed even if the batch size value is not reached. The default value is 10000 (10 seconds). A value of 0 means that no timeout interval is used.

Do not use this option when messages are published using a parameterized subject name.

Note: If an adapter instance stops before a batch update is performed, the status column is not updated. As a result, messages that were successfully published still have a status of P (pending) in the publishing table when the adapter instance is restarted. In this case, the ledger file contains the correct status information. A smaller value for this property decreases this risk.

Applies only to parent-child relationships in Publication Service. Enables publishing child table rows. By default, the value is set to on.

This property specifies whether Publication Service is enabled to send date time format as ISO 8601. The default value is on. This property also controls the ADB publisher ADB_TIMESTAMP attribute format string.

Note that the value of the adb.pubTimestampFormatAsISO8601 property affects the format of published timestamps:

For example, if a timestamp to be published is 2001-08-07 08:09:30, the published format is as follows:

For example, if a BC timestamp to be published is 2001-08-07BC08:09:30, the published format is as follows:

This property specifies the maximum number of rows to fetch. This can be used limit the memory usage of the adapter. The unfetched rows will be ignored by the adapter.

The number of threads used by the Request-Response Service. The default value is 1.

Total number of reconnection attempts.

The runtime publisher table schema name. This overrides the adb.runtime.schema setting. This can be used if the user has a different schema for the publishing table than the other table objects, such as the source table.

For more information, see Advanced Topics, Runtime Table Schema Configuration.

The runtime database object schema name.

For more information, see Advanced Topics, Runtime Table Schema Configuration.

This property specifies whether RV advisory messages are be logged in the adapter log files.

Default: off.

Applies only to subscriber instances. Specifies the maximum number of messages that can be put in the TIBCO Rendezvous event queue. The default value is 0, which means no limit is placed on the event queue size.

Note: If the value of this property is set to be smaller than the actual number of messages in the event queue, only the allowable number of messages can be sent and the subsequent messages are lost.

When set to on, the adapter will call SET_CLIENT_INFO to set the database session client information.

Default: on.

Either on or off. Specifies whether the RVMSG fields of an empty string are treated as NULL or "" (empty strings). The default setting is off.

If the property value is set to on, empty strings are treated as NULL. If the property value is set to off, empty strings are treated as empty strings if the database allows it.

Either on or off. It only works when meeting the following three criteria:

When you set a default value to a field in creating table, if the property value is set to ON, the empty strings are changed to the default value.

Default: Off

Milliseconds of sleep between two reconnection attempts.

The number of cache statements for a generic RPC request/ reply service.

The number of statements that the adapter caches will be executed directly for repeated requests. If the cache is full, the adapter will remove the oldest message from the cache and add the new statement. The default setting is 1.

Applies only to subscriber instances. This property specifies the number of messages to be batched before invoking a commit operation. The default value is 0.

You can set this property if you want to enable batch commit without using separate sessions in TIBCO Designer.

If you set values for both the adb.subBatchCommitSize property and the adb.<default session name>.subBatchCommitSize property, the value of the adb.subBatchCommitSize property is used.

For more information, see Subscription Service: Advanced Tab

Note: If messages greater than 32K are published, batching is automatically turned off.

Applies only to subscriber instances. This property specifies the longest interval between two batch commits. When the specified timeout expires, the subscriber adapter commits all the received messages even if the number does not reach the specified batch commit size. The default value is 10,000 milliseconds.

You can set this property if you want to enable batch commit without using separate sessions in TIBCO Designer.

If you set values for both the adb.subBatchCommitTimeout property and the adb.<default session name>.subBatchCommitTimeout property, the value of the adb.subBatchCommitTimeout property is used.

For more information, see Subscription Service: Advanced Tab.

Applies only to subscriber instances. All incoming messages to insert are stored until this size is reached. Then a bulk insert operation is performed on the destination table. This value must be less than or equal to the value specified for adb.subBatchCommitSize, if used. The default value is 1.

If an update statement is published while messages are being batched, the bulk insert is performed regardless of whether the size value has been reached. After records have been inserted, the update operation is performed.

For more information, see Subscription Service: Advanced Tab.

Note: Do not use this option if LONG, LONG RAW, image, or varbinary records are published.

Enables or disables the bulk insert error handling function for Subscription Service.

The scheduler stores tasks in a queue. This property limits the maximum size of that scheduler task queue by the number of bytes. The properties can control the memory usage on the adapter side.

This value must be an integer. The default value is unspecified, which indicates that the size of the scheduler task queue is not limited.

The scheduler stores tasks in a queue. This property limits the maximum size of that scheduler task queue by the number of messages. The properties can control the memory usage on the adapter side.

This value must be an integer. The default value is unspecified, which indicates that the size of the scheduler task queue is not limited.

Specifies that if publication fails during the message delivery, the agent will terminate after the status has been updated to F. The default value is off.

The standard time format pattern for java.text.SimpleDateFormat. The default format is HH:mm:ss.

The standard timestamp format pattern for java.text.SimpleDateFormat. The default format is yyyy-MM-dd HH:mm:ss.S.

This property disable the use of the BETWEEN clause in the select query of the publisher.

The default value is on.

Enables the use of the exception table. The exception table is defined when a subscription is created. The default value is set to on.

Database url used by the adapter to access database. For example:

jdbc:tibcosoftwareinc:db2://IP:50000;databaseName=adb

Database account name used by the adapter to access databases. If it is not specified, the runtime will call the user name in the design time. If it is set in the TRA file, the runtime will call the user name from the TRA file.

Verbose mode. Print all available information to the console window or log file location. By default, the verbose mode is on.

User name under which to run the Windows service.

You can use this property to initially set the account for the service, but after the service is installed, use the Services control to change the user account of services.

Absolute path to the executable that is run when the service is started. For example:

ntservice.binary.path.absolute   C:/tibco/adapter/adadb/7.3.0/bin/adbagent.exe

The number of dependencies.

Name to display in the Services control for this Windows Service.

This property is useful if you want to have multiple Windows Services for the same executable. That is, you want to have two adapter running on the same machine. By specifying different service names and display names for the adapters, you can accomplish this.

Either true or false. Specifies whether the Windows Service is interactive. Set to false if you are not using a system account.

Name for this Windows Service.

This property is useful if you want to have multiple Windows Services for the same executable. That is, you want to have two adapters running on the same machine. By specifying different service names and display names for the adapters, you can accomplish this.

For example:

ntservice.name adapter_instance_name

Password for the user name in the ntservice.account property.

You can use this property to initially set the password for the user account, but after the service is installed, use the Services control to change the password.

Start type for this Windows Service. Either manual or automatic. For example:

ntservice.starttype automatic

You can use this property to initially set the start type for the service, but after the service is installed, use the Windows Services control to change the start type of services.

Runtime values for global variables defined inside the repository. This value takes precedence over any global value set in the repository. Substitution takes place at runtime.

You append the global variable to tibco.clientVar, then give its value. For example, a global variable named DirLedger is specified as follows:

tibco.clientVar.DirLedger      C:/tibco/adapter/adadb/7.2/ledger

Do not include the % character of substitution variables. For example, to set %%RvDaemon%%="tcp:7500", use tibco.clientVar.RvDaemon "tcp:7500".

Username and password used by the repository server to access the project. The password can be obfuscated using the instructions in Password Handling.

Displays a banner with version information, then exits. This option is for troubleshooting purposes only.

The following properties are predefined in the adbagent.tra file for Fault Tolerance. You can set these properties accordingly to configure Fault Tolerance.

(Required) Specifies whether to enable Fault Tolerance. The value of on indicates that Fault Tolerance is enabled. Otherwise, it is disabled.

(Required) Specifies the queue name that stores the tokens on the EMS server.

Note: The prefetch parameter of the specified queue on the EMS server must be set to none.

(Required) Specifies the session name that is used for Fault Tolerance. The specified session must be a JMS queue session.

(Optional) Specifies 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://.

(Optional) Specifies the factory name used when SDK creates the JMS connection factory for Fault Tolerance.

(Optional) Specifies the username for the EMS connection. The default value is null.

(Optional) Specifies the password for the EMS connection. The default value is null.

(Optional) Specifies whether the primary instance acknowledges its token when the adapter stops normally. The value of on indicates that the token held by the primary instance is acknowledged, which means a token in the specified EMS queue is deleted. The default value is off.

After enabling this property, the number of primary instances decreases when the adapter stops normally.

The EMS connection used for fetching an EMS message as a token can work over JNDI or SSL.

The following properties are set for JNDI:

(Optional) Specifies whether the JNDI is used. The value of on indicates JNDI is used for looking up the JMS factory. The default value is off.

(Optional) Specifies the JNDI context factory. The default context factory is com.tibco.tibjms.naming.TibjmsInitalContextFactory.

(Optional) Specifies the user name of the JNDI connection. The default value is null.

(Optional) Specifies the password of the JNDI connection. The default value is null.

The following properties are set for SSL:

(Optional) Specifies whether the adapter connects to the JMS server using SSL. The value of on indicates that adapter connects to the JMS server using SSL. The default value is off.

(Optional) Specifies whether SSL enables tracing of the loaded certificates. The default value is off.

(Optional) Specifies whether SSL can obtain more detailed log information, on or off. The default value is off.

(Optional) Specifies whether an SSL client verifies the name in the server certificate. The default value is off.

(Optional) Specifies whether an SSL client verifies the server certificate, on or off. The default value is off.

(Required when the enableVerifyHostName and enableVerifyHost are both set to on.)

Specifies the name in the server certificate.

(Optional) Specifies whether only strong cipher suites are allowed, on or off. The default value is off.

(Required when the connection between the EMS client and EMS server is over SSL.)

Specifies the full path of the folder where the required certificates are located.

(Optional) Specified the path of the client identity.

(Required when the identity is specified.)

Specifies the client identity password.

Indicates fault tolerance port number.

Default value: 9999

Indicates fault tolerance heartbeat.

Default value: 5000

Indicates fault tolerance retry attempts.

Default value: 10

Use the new TRA property of "adb.getDbURLbyHawk" to control whether you want to get DB URL in Hawk.

Default value: Off

Set "adb.pollingCommitForTD" to issue db commit after each polling select statement against Teradata db.

Default value: Off

Use the new TRA property of "adb.engineStopWithDBOperationFailed". When its value is 0 as default, ADB agent works as before, that is it shuts down if the stage table is not accessible. For example, when its value is 1, the ADB agent keeps running with db exception logged in ADB log file.

Default value: 0

To keep the value as 0 milli seconds in the datetime field in the published messages, add adb.keepZeroMilliSecond tra property with value On.

Default value: Off

When it On, the output of datetime field is like 2018-09-06 01:59:23.0

When it is Off, the value is like 2018-08-28 06:16:22

To have nano seconds data as part of datetime field value of published messages, add adb.pubTimestampWithNanoSeconds tra property with value On.

Default value: Off

The expected datetime field value is like 2018-09-06 2018 00:00:00.123000000.

However, when no time is presented in the original value, for example 2018-09-06 00:00:00, then there are no nano seconds added.

To have float and double datatypes without scientific notation as part of published messages, add adb.noFloatDoubleScientificNotation tra property with value On.

Default value: Off

If the input data is in scientific format, such as 6.743240136E-7, then it is converted to nonscientific format such as 0.000000674324014.

Use this property to control output element of columns with nil value in published messages. Add adb.setExplicitNilForDB2 tra property with value On to get xsi:nil="true" in response. This property is applicable only for DB2.

Default value: Off

Indicates whether general and specific ADB methods should be added to the class microagent.

Default value: On

This property indicates whether the bulk insert error handling feature in Subscription Service is enabled or not.

Default value: Off

The following two properties are used for setting JMS compression.

Specifies a list of JMS session names. All the JMS endpoints under the specified session list, including Publisher and RPC Server, send compressed JMS messages to the EMS server.