Configuring Java CAPS Environment Components for Database Adapters

Outbound DB2 Adapter Environment Properties

The Outbound DB2 Adapter properties, accessed from the Environment Explorer tree, are organized into the following sections:

Outbound Environment Properties for Windows/Unix

The Outbound DB2 Adapter properties for Windows/Unix, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings for Windows/Unix

The JDBC Connector Settings section of the Outbound Windows/Unix Environment contains the top-level parameters displayed in the following table.

Table 3 Outbound Adapter Windows/Unix Environment - JDBC Connector Settings

Name 

Description 

Required Value 

Description 

Enter a description for the database. 

A valid string. The default value is DB2 Connection Pool Datasource.

ServerName 

Specifies the host name of the external database server. 

Any valid string. 

PortNumber 

Specifies the I/O port number on which the server is listening for connection requests. 

A valid port number. The default is 50000.

DatabaseName 

Specifies the name of the database instance used on the Server. 

Any valid string. 

User 

Specifies the user name that the Adapter uses to connect to the database. 

Any valid string. 

Password 

Specifies the password used to access the database. 

Any valid string. 

DriverProperties 

Any additional settings that are not otherwise part of the external system properties can be set here. 

Typically, anything that you would pass to the driver through the connect string, in the form of “AProperty = AValue” can be set in Java by calling setAProperty (“AValue”) which becomes setAProperty #AValue##. Use the JDBC driver that is shipped with this Adapter. 

Example 1:

To execute the method “setSpyAttributes” for the DataDirect driver, set the following string for the URL: “setSpyAttribute#<url>##”. 

Example 2:

To set DataDirect’s Spy Log, the Driver properties entry requires the following string: 

“setURL#jdbc:Seebeyond:DB2://<server>:4100;DatabaseName=<database>##setSpyAttributes#log=(file)c:/temp/spy.log;logTName=yes##”


Note –

Spy Log should be set for debugging purposes only.


Example 3:

For DB2 UDB, the Connect String parameter “SecurityMechanism=Encrypted Password” can be passed to the driver as “setSecurityMechanism# Encrypted Password##” This will call setSecurityMechanism (“Encrypted Password”) before the connection is established. 

A delimited list of parametrized method calls. 

The valid format is: 

“<method-name-1>#<param-1>#<param-2>#.....

....<param-n>##<method-name-2># <param-1>#<param-2>#.... ....<param-n> ##......##”.

Delimiter 

This is the delimiter character to be used in the DriverProperties prompt. 

The default is #. See the DriverProperties property above for more information on how the default value is used.

MinPoolSize

Specifies the minimum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed. 

If the pool size is too small, you may experience longer connection times due to the existing number of physical connections. 

A connection that stays in the pool allows transactions to use it via a logical connection which is faster. 

A valid numeric value. The default is 0.

MaxPoolSize

Specifies the maximum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum. 

The pool size depends on the transaction volume and response time. If the pool size is too big, you may end up with too many connections with the database. 

A valid numeric value. The default is 10.

MaxIdleTime 

The maximum number of seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit. 

A valid numeric value. The default is 0.

Connection Retry Settings for Windows/Unix

The Connection Retry Settings section of the Outbound DB2 Adapter Environment contains the top-level parameters displayed in the following table.

Table 4 Outbound Adapter Windows/Unix Environment - Connection Retry Settings

Name 

Description 

Required Value 

ConnectionRetries 

Specifies the number of retries to establish a connection with the DB2 Adapter database upon a failure to acquire one. 

An integer indicating the number of attempts allowed to establish a connection. The configured default is 0.

ConnectionRetry Interval 

Specifies the milliseconds of pause before each attempt to access the database. This setting is used in conjunction with the ’Connection Retries’ setting. 

For example: In the event that the Adapter cannot connect to the Database, the Adapter will try to reconnect to the database in 5 second intervals, a total of 10 times, when the Connection Retries property is set at 10 and the Connection Retry Interval property is 5000. 

An integer indicating the configured length of the time (in milliseconds) before each reattempt to access the destination file. The configured default is 1000 (1 second).

Outbound Environment Properties for Non-Transactional Windows/Unix

The Outbound DB2 Adapter properties for Non-Transactional Windows/Unix, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings for Non-Transactional Windows/Unix

The JDBC Connector Settings section of the Outbound Non-Transactional Windows/Unix Environment contains the top-level parameters displayed in the following table.

Table 5 Outbound Non-Transactional Adapter for Windows/Unix - JDBC Connector Settings

Name 

Description 

Required Value 

Description 

Enter a description for the database. 

A valid string. The default value is DB2 non-Transactional Connection Pool Datasource.

ServerName 

Specifies the host name of the external database server. 

Any valid string. 

PortNumber 

Specifies the I/O port number on which the server is listening for connection requests. 

A valid port number. The default is 50000.

DatabaseName 

Specifies the name of the database instance used on the Server. 

Any valid string. 

User 

Specifies the user name that the Adapter uses to connect to the database. 

Any valid string. 

Password 

Specifies the password used to access the database. 

Any valid string. 

DriverProperties 

Any additional settings that are not otherwise part of the external system properties can be set here. 

Typically, anything that you would pass to the driver through the connect string, in the form of “AProperty = AValue” can be set in Java by calling setAProperty (“AValue”) which becomes setAProperty #AValue##. Use the JDBC driver that is shipped with this Adapter. 

Example 1:

To execute the method “setSpyAttributes” for the DataDirect driver, set the following string for the URL: “setSpyAttribute#<url>##”. 

Example 2:

To set DataDirect’s Spy Log, the Driver properties entry requires the following string: 

“setURL#jdbc:Seebeyond:DB2://<server>:4100;DatabaseName=<database>##setSpyAttributes#log=(file)c:/temp/spy.log;logTName=yes##”


Note –

Spy Log should be set for debugging purposes only.


Example 3:

For DB2 UDB, the Connect String parameter “SecurityMechanism=Encrypted Password” can be passed to the driver as “setSecurityMechanism# Encrypted Password##” This will call setSecurityMechanism (“Encrypted Password”) before the connection is established. 

A delimited list of parametrized method calls. 

The valid format is: 

“<method-name-1>#<param-1>#<param-2>#.....

....<param-n>##<method-name-2># <param-1>#<param-2>#.... ....<param-n> ##......##”.

Delimiter 

This is the delimiter character to be used in the DriverProperties prompt. 

The default is #. See the DriverProperties property above for more information on how the default value is used.

MinPoolSize

Specifies the minimum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed. 

If the pool size is too small, you may experience longer connection times due to the existing number of physical connections. 

A connection that stays in the pool allows transactions to use it via a logical connection which is faster. 

A valid numeric value. The default is 0.

MaxPoolSize

Specifies the maximum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum. 

The pool size depends on the transaction volume and response time. If the pool size is too big, you may end up with too many connections with the database. 

A valid numeric value. The default is 10.

MaxIdleTime 

The maximum number of seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit. 

A valid numeric value. The default is 0.

Connection Retry Settings for Non-Transactional Windows/Unix

The Connection Retry Settings section of the Outbound DB2 Adapter Environment contains the top-level parameters displayed in the following table.

Table 6 Outbound Non-Transactional Adapter Windows/Unix - Connection Retry Settings

Name 

Description 

Required Value 

ConnectionRetries 

Specifies the number of retries to establish a connection with the DB2 database upon a failure to acquire one. 

An integer indicating the number of attempts allowed to establish a connection. The configured default is 0.

ConnectionRetry Interval 

Specifies the milliseconds of pause before each attempt to access the database. This setting is used in conjunction with the ’Connection Retries’ setting. 

For example: In the event that the Adapter cannot connect to the Database, the Adapter will try to reconnect to the database in 5 second intervals, a total of 10 times, when the Connection Retries property is set at 10 and the Connection Retry Interval property is 5000. 

An integer indicating the configured length of the time (in milliseconds) before each reattempt to access the destination file. The configured default is 1000 (1 second).

Outbound Environment Properties for XA Windows/Unix

The Outbound DB2 Adapter properties for XA Windows/Unix, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings for XA Windows/Unix

The JDBC Connector Settings section of the Outbound XA Windows/Unix Environment contains the top-level parameters displayed in the following table.

Table 7 Outbound XA Adapter for Windows/Unix - JDBC Connector Settings

Name 

Description 

Required Value 

Description 

Enter a description for the database. 

A valid string. The default value is DB2 XA Datasource.

ServerName 

Specifies the host name of the external database server. 

Any valid string. 

PortNumber 

Specifies the I/O port number on which the server is listening for connection requests. 

A valid port number. The default is 50000.

DatabaseName 

Specifies the name of the database instance used on the Server. 

Any valid string. 

User 

Specifies the user name that the Adapter uses to connect to the database. 

Any valid string. 

Password 

Specifies the password used to access the database. 

Any valid string. 

DriverProperties 

Any additional settings that are not otherwise part of the external system properties can be set here. 

Typically, anything that you would pass to the driver through the connect string, in the form of “AProperty = AValue” can be set in Java by calling setAProperty (“AValue”) which becomes setAProperty #AValue##. Use the JDBC driver that is shipped with this Adapter. 

Example 1:

To execute the method “setSpyAttributes” for the DataDirect driver, set the following string for the URL: “setSpyAttribute#<url>##”. 

Example 2:

To set DataDirect’s Spy Log, the Driver properties entry requires the following string: 

“setURL#jdbc:Seebeyond:DB2://<server>:4100;DatabaseName=<database>##setSpyAttributes#log=(file)c:/temp/spy.log;logTName=yes##”


Note –

Spy Log should be set for debugging purposes only.


Example 3:

For DB2 UDB, the Connect String parameter “SecurityMechanism=Encrypted Password” can be passed to the driver as “setSecurityMechanism# Encrypted Password##” This will call setSecurityMechanism (“Encrypted Password”) before the connection is established. 

A delimited list of parametrized method calls. 

The valid format is: 

“<method-name-1>#<param-1>#<param-2>#.....

....<param-n>##<method-name-2># <param-1>#<param-2>#.... ....<param-n> ##......##”.

Delimiter 

This is the delimiter character to be used in the DriverProperties prompt. 

The default is #. See the DriverProperties property above for more information on how the default value is used.

MinPoolSize

Specifies the minimum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed. 

If the pool size is too small, you may experience longer connection times due to the existing number of physical connections. 

A connection that stays in the pool allows transactions to use it via a logical connection which is faster. 

A valid numeric value. The default is 0.

MaxPoolSize

Specifies the maximum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum. 

The pool size depends on the transaction volume and response time. If the pool size is too big, you may end up with too many connections with the database. 

A valid numeric value. The default is 10.

MaxIdleTime 

The maximum number of seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit. 

A valid numeric value. The default is 0.

Connection Retry Settings for XA Windows/Unix

The Connection Retry Settings section of the Outbound DB2 Adapter Environment contains the top-level parameters displayed in the following table.

Table 8 Outbound XA Adapter Windows/Unix - Connection Retry Settings

Name 

Description 

Required Value 

ConnectionRetries 

Specifies the number of retries to establish a connection with the DB2 database upon a failure to acquire one. 

An integer indicating the number of attempts allowed to establish a connection. The configured default is 0.

ConnectionRetry Interval 

Specifies the milliseconds of pause before each attempt to access the database. This setting is used in conjunction with the ’Connection Retries’ setting. 

For example: In the event that the Adapter cannot connect to the Database, the Adapter will try to reconnect to the database in 5 second intervals, a total of 10 times, when the Connection Retries property is set at 10 and the Connection Retry Interval property is 5000. 

An integer indicating the configured length of the time (in milliseconds) before each reattempt to access the destination file. The configured default is 1000 (1 second).

Outbound Environment Properties for z/OS and AS/400

The Outbound z/OS and AS/400 properties, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings for z/OS and AS/400

The JDBC Connector Settings section of the Outbound z/OS and AS/400 Environment contains the top-level parameters displayed in the following table.

Table 9 Outbound Adapter z/OS and AS/400 Environment - JDBC Connector Settings

Name 

Description 

Required Value 

Description 

Enter a description for the database. 

A valid string. The default value is DB2 Datasource For AS400/zOS.

ServerName 

Specifies the host name of the external database server. 

Any valid string. 

LocationName 

Specifies the Location Name for the DB2 database that is being used on AS400/zOS. You can issue a “Select current service from sysibm.sysdummy1” to the database to find out its value. 

A valid port number. The default is 446.

PackageCollection 

Specifies the PackageCollection for the DB2 database that is being used on AS400/zOS. Use the same one you used in the Wizard Connection Panel.  

Any valid String. 

User 

Specifies the user name that the Adapter uses to connect to the database. 

Any valid string. 

Password 

Specifies the password used to access the database. 

Any valid string. 

DriverProperties 

Any additional settings that are not otherwise part of the external system properties can be set here. 

Typically, anything that you would pass to the driver through the connect string, in the form of “AProperty = AValue” can be set in Java by calling setAProperty (“AValue”) which becomes setAProperty #AValue##. Use the JDBC driver that is shipped with this Adapter. 

Example 1:

To execute the method “setSpyAttributes” for the DataDirect driver, set the following string for the URL: “setSpyAttribute#<url>##”. 

Example 2:

To set DataDirect’s Spy Log, the Driver properties entry requires the following string: 

“setURL#jdbc:Seebeyond:DB2://<server>:4100;DatabaseName=<database>##setSpyAttributes#log=(file)c:/temp/spy.log;logTName=yes##”


Note –

Spy Log should be set for debugging purposes only.


Example 3:

For DB2 UDB, the Connect String parameter “SecurityMechanism=Encrypted Password” can be passed to the driver as “setSecurityMechanism# Encrypted Password##” This will call setSecurityMechanism (“Encrypted Password”) before the connection is established. 

A delimited list of parametrized method calls. 

The valid format is: 

“<method-name-1>#<param-1>#<param-2>#.....

....<param-n>##<method-name-2># <param-1>#<param-2>#.... ....<param-n> ##......##”.

Delimiter 

This is the delimiter character to be used in the DriverProperties prompt. 

A valid delimiter. The default is #. 

MinPoolSize 

Specifies the minimum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed. 

If the pool size is too small, you may experience longer connection times due to the existing number of physical connections. 

A connection that stays in the pool allows transactions to use it via a logical connection which is faster. 

A valid numeric value. The default is 0.

MaxPoolSize 

Specifies the maximum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum. 

The pool size depends on the transaction volume and response time. If the pool size is too big, you may end up with too many connections with the database. 

A valid numeric value. The default is 10.

MaxIdleTime 

The maximum number of seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit. 

A valid numeric value. The default is 0.

Connection Retry Settings for z/OS and AS/400

The Connection Retry Settings section of the Outbound z/OS and AS/400 Environment contains the top-level parameters displayed in the following table.

Table 10 Outbound Adapter z/OS and AS/400 Environment - Connection Retry Settings

Name 

Description 

Required Value 

ConnectionRetries 

Specifies the number of retries to establish a connection with the DB2 Adapter database upon a failure to acquire one. 

An integer indicating the number of attempts allowed to establish a connection. The configured default is 0.

ConnectionRetry Interval 

Specifies the milliseconds of pause before each reattempt to access the database. This setting is used in conjunction with the ’Connection Retries’ setting. 

For example: In the event that the Adapter cannot connect to the Database, the Adapter will try to reconnect to the database in 5 second intervals, a total of 10 times, when the Connection Retries property is set at 10 and the Connection Retry Interval property is 5000. 

An integer indicating the configured length of the time (in milliseconds) before each reattempt to access the destination file. The configured default is 1000 (1 second).

Outbound Environment Properties for Non-Transactional z/OS and AS/400

The Outbound Non-Transactional z/OS and AS/400 properties, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings for Non-Transactional z/OS and AS/400

The JDBC Connector Settings section of the Outbound Non-Transactional z/OS and AS/400 Environment contains the top-level parameters displayed in the following table.

Table 11 Outbound Non-transactional Adapter for z/OS and AS/400 - JDBC Connector Settings

Name 

Description 

Required Value 

Description 

Enter a description for the database. 

A valid string. The default value is DB2 Datasource For AS400/zOS.

ServerName 

Specifies the host name of the external database server. 

Any valid string. 

LocationName 

Specifies the Location Name for the DB2 database that is being used on AS400/zOS. You can issue a “Select current service from sysibm.sysdummy1” to the database to find out its value. 

A valid port number. The default is 446.

PackageCollection 

Specifies the PackageCollection for the DB2 database that is being used on AS400/zOS. Use the same one you used in the Wizard Connection Panel.  

Any valid String. 

User 

Specifies the user name that the Adapter uses to connect to the database. 

Any valid string. 

Password 

Specifies the password used to access the database. 

Any valid string. 

DriverProperties 

Any additional settings that are not otherwise part of the external system properties can be set here. 

Typically, anything that you would pass to the driver through the connect string, in the form of “AProperty = AValue” can be set in Java by calling setAProperty (“AValue”) which becomes setAProperty #AValue##. Use the JDBC driver that is shipped with this Adapter. 

Example 1:

To execute the method “setSpyAttributes” for the DataDirect driver, set the following string for the URL: “setSpyAttribute#<url>##”. 

Example 2:

To set DataDirect’s Spy Log, the Driver properties entry requires the following string: 

“setURL#jdbc:Seebeyond:DB2://<server>:4100;DatabaseName=<database>##setSpyAttributes#log=(file)c:/temp/spy.log;logTName=yes##”


Note –

Spy Log should be set for debugging purposes only.


Example 3:

For DB2 UDB, the Connect String parameter “SecurityMechanism=Encrypted Password” can be passed to the driver as “setSecurityMechanism# Encrypted Password##” This will call setSecurityMechanism (“Encrypted Password”) before the connection is established. 

A delimited list of parametrized method calls. 

The valid format is: 

“<method-name-1>#<param-1>#<param-2>#.....

....<param-n>##<method-name-2># <param-1>#<param-2>#.... ....<param-n> ##......##”.

Delimiter 

This is the delimiter character to be used in the DriverProperties prompt. 

A valid delimiter. The default is #. 

MinPoolSize 

Specifies the minimum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there should be no physical connections in the pool and the new connections should be created as needed. 

If the pool size is too small, you may experience longer connection times due to the existing number of physical connections. 

A connection that stays in the pool allows transactions to use it via a logical connection which is faster. 

A valid numeric value. The default is 0.

MaxPoolSize 

Specifies the maximum number of physical connections the pool should keep available at all times. 0 (zero) indicates that there is no maximum. 

The pool size depends on the transaction volume and response time. If the pool size is too big, you may end up with too many connections with the database. 

A valid numeric value. The default is 10.

MaxIdleTime 

The maximum number of seconds that a physical connection may remain unused before it is closed. 0 (zero) indicates that there is no limit. 

A valid numeric value. The default is 0.

Connection Retry Settings for Non-Transactional z/OS and AS/400

The Connection Retry Settings section of the Outbound Non-Transactional z/OS and AS/400 Environment contains the top-level parameters displayed in the following table.

Table 12 Outbound Non-Transactional Adapter for z/OS and AS/400 - Connection Retry Settings

Name 

Description 

Required Value 

ConnectionRetries 

Specifies the number of retries to establish a connection with the DB2 Adapter database upon a failure to acquire one. 

An integer indicating the number of attempts allowed to establish a connection. The configured default is 0.

ConnectionRetry Interval 

Specifies the milliseconds of pause before each reattempt to access the database. This setting is used in conjunction with the ’Connection Retries’ setting. 

For example: In the event that the Adapter cannot connect to the Database, the Adapter will try to reconnect to the database in 5 second intervals, a total of 10 times, when the Connection Retries property is set at 10 and the Connection Retry Interval property is 5000. 

An integer indicating the configured length of the time (in milliseconds) before each reattempt to access the destination file. The configured default is 1000 (1 second).