Database connection properties

The Gateway can be configured to connect to the database. It has internal database connections that are used for operations such as:
  • Marking incoming and outgoing trackable item file records as complete.
  • Inserting and updating WIP records in the GW_FILE_STAT table.
  • Inserting performance data into the database.
  • Loading records into the database in support of the direct load feature of Gateway.
  • Gateway duplicate checking.
Notes:
  1. Either the Db2® server or the Db2 client package needs to be installed and properly configured.
  2. To avoid problems when you are running Gateway Server, user exits must not use these internal database connections to connect to the database.
Table 1 shows the database properties for Gateway Server and Table 2 shows the database properties for Gateway Server duplicate checking.
Table 1. Database connection properties
Property Values or examples Description
dbConnectURL jdbc:db2://localhost:50000/FTMDB FTM database name. Use a database that is available on the Transaction Server, such as, MYFTMDB, or refer to a database on another server by using the full URL. A full URL is specified as jdbc:db2://dbserver.example.com[:port]//MYFTMDB where:
dbserver.example.com
Is the DNS name of the server where the database exists. Dotted IP notation can also be used.
port
Is an optional port number for the database configuration on that server. It normally defaults to 50,000.
MYFTMDB
Is the name of the database.
Notes:
  1. On some systems, problems can occur when a local database is referenced by only the name. If problems occur, specify the database server as a full URL. Use localhost, 127.0.0.1, or the actual URL or DNS name in the specification.
  2. When you are resolving connectivity issues, always try to have the most recent Db2 fix pack for the database release that is being used.
dbConnectSchema FTM The name of the schema for the database.
dbConnectCacheSize 6-100 The number of Db2 connections that are allowed for Gateway. These connections are used to write to the database, such as for Gateway transmission status updates and for logging. If the number of transmission processing threads or Business Rules threads is increased, the number of database connections also needs to be increased.

These Db2 connections are pooled. When an insufficient number of connections are in the pool, a message that indicates that more connections are needed is logged. The Gateway duplicate detect threads have their own pool of database connections and do not need to be included in the value for this property. Gateway automatically pools a Db2 connection for every duplicate detect thread that is configured.

The default value for this property is 30.
dbConnectId UserID User ID that is used to connect to the database.
dbConnectPwd UserPwd User password that is used to connect to the database.
dbConnectRefreshTimer 0 (seconds) When a database connection is idle for the specified time period, the Gateway Server refreshes all database connections in the connection pool at every dbConnectRefreshTimer interval. If the value is set to zero, this function is disabled. The range of this value is 0 - 36000 seconds.
dbConnectionMode standard Configures the Gateway Server to use a specific type of database connection. The available database connection types are shown in the following list:
  • Standard - Uses a standard JDBC connection (the default).
  • Debug - Adds log-level tracing for all calls that are issued on the connection and any artifacts that belong to the connection.
dbConnectionRefreshTimer 2 hours After a database connection is idle for this amount of time, the Gateway Server checks if the connection must be refreshed. Database connections need to be refreshed if the connection is closed or if its remote connection was ended by a system timeout. If the Gateway Server determines that a database connection needs to be refreshed, the old database connection is discarded and replaced with a new one.
dbKeyStoreFormat
  • JKS (default)
  • KDS
  • PK12
  • PKCS12
 The keystore type of the keystore file.
dbKeyStorePassword   The password used to access the keystore.
dbLoginTimeout 1000 The maximum amount of time, in seconds, that a driver can wait when it attempts to log in to a database.
dbTrustStoreFormat
  • JKS (default)
  • KDS
  • PK12
  • PKCS12
 The truststore type of the truststore file.
dbTrustStorePassword   The password used to access the truststore.
enableSQLCheckData true/false Use this property only when directed to by IBM® Support.
The following table shows the database properties for Gateway Server duplicate checking. If these properties are not defined, the properties in Table 1 are used.
Table 2. Database connection properties for duplicate checking
Keywords Values or examples Description
auxDbConnectURL jdbc:db2://localhost:50000/FTMDB FTM database name. Use a database that is available on the Transaction Server, such as, MYFTMDB, or refer to a database on another server by using the full URL. A full URL is specified as jdbc:db2://dbserver.example.com[:port]//MYFTMDB where:
dbserver.example.com
Is the DNS name of the server where the database exists. Dotted IP notation can also be used.
port
Is an optional port number for the database configuration on that server. It normally defaults to 50,000.
MYFTMDB
Is the name of the database.
Notes:
  1. On some systems, problems can occur when a local database is referenced by only the name. If problems occur, specify the database server as a full URL. Use localhost, 127.0.0.1, or the actual URL or DNS name in the specification.
  2. When you are resolving connectivity issues, always try to have the most recent Db2 fix pack for the database release that is being used.
auxDbConnectSchema FTM The name of the schema for the database.
auxDbConnectCacheSize 0 - 40 The minimum number of connections to keep open for writing to the FTM database.
auxDbConnectId UserID User ID that is used to connect to the database.
auxDbConnectPwd UserPwd User password that is used to connect to the database.
auxEnableSSL true/false Indicates whether Gateway Server uses SSL authentication to connect to the Java™ Platform, Enterprise Edition EJB component.