JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Configuring Environment Components for Oracle Java CAPS Database Adapters     Java CAPS Documentation
search filter icon
search icon

Document Information

Configuring Java CAPS Environment Components for Database Adapters

Using the Environment Properties Editor

To Add an External System to the Environment

To Configure the Environment Properties

DB2 Adapter Environment Properties

Inbound DB2 Adapter Environment Properties

Inbound Environment Properties for Windows/UNIX

Inbound Environment Properties for z/OS and AS/400

Outbound DB2 Adapter Environment Properties

Outbound Environment Properties for Windows/UNIX

JDBC Connector Settings for Windows/UNIX

Connection Retry Settings for Windows/UNIX

Outbound Environment Properties for Non-Transactional Windows/UNIX

JDBC Connector Settings for Non-Transactional Windows/UNIX

Connection Retry Settings for Non-Transactional Windows/UNIX

Outbound Environment Properties for XA Windows/UNIX

JDBC Connector Settings for XA Windows/UNIX

Connection Retry Settings for XA Windows/UNIX

Outbound Environment Properties for z/OS and AS/400

JDBC Connector Settings for z/OS and AS/400

Connection Retry Settings for z/OS and AS/400

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

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

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

eTL Environment Properties

Alternate ID Properties

DB2 Connect Adapter Environment Properties

Inbound DB2 Connect Adapter - Parameter Settings

Outbound DB2 Connect Adapter - JDBC Connector Settings

Outbound DB2 Connect Adapter - Connection Retry Settings

Outbound DB2 Connect non-Transactional Adapter - JDBC Connector Settings

Outbound DB2 Connect non-Transactional Adapter - Connection Retry Settings

Outbound DB2 Connect XA Adapter - JDBC Connector Settings

Outbound DB2 Connect XA Adapter - Connection Retry Settings

Inbound DB2 Connect Type 4 Adapter - Parameter Settings

Outbound DB2 Connect Type 4 Adapter - JDBC Connector Settings

Outbound DB2 Connect Type 4 Adapter - Connection Retry Settings

Outbound DB2 Connect non-Transactional Type 4 Adapter - JDBC Connector Settings

Outbound DB2 Connect non-Transactional Type 4 Adapter - Connection Retry Settings

Outbound DB2 Connect Type 4 XA Adapter - JDBC Connector Settings

Outbound DB2 Connect Type 4 XA Adapter - Connection Retry Settings

Informix Adapter Environment Properties

Informix Adapter External System Properties

Inbound Informix Adapter External System Properties

Outbound Informix Adapter External System Properties

Outbound non-Transactional Informix Adapter External System Properties

Outbound XA Informix Adapter External System Properties

Oracle Adapter Environment Properties

Inbound Oracle Adapter Environment Properties

Outbound Oracle Adapter Environment Properties

JDBC Connector Settings

Connection Retry Settings

Outbound Oracle Adapter Environment Properties with XA support

JDBC Connector Settings (with XA support)

Connection Retry Settings (with XA support)

SQL Server Adapter Environment Properties

Inbound SQL Server Adapter Properties

Outbound SQL Server Adapter Properties

JDBC Connector Settings

Connection Retry Settings

Outbound SQL Server Non-Transactional Adapter Properties

JDBC Connector Settings

Connection Retry Settings

Outbound SQL Server XA Adapter Properties

JDBC Connector Settings (with XA support)

Connection Retry Settings (with XA support)

Sybase Adapter Environment Properties

Inbound Sybase Adapter

Outbound Sybase Adapter

JDBC Connector Settings

Connection Retry Settings

Outbound XA Sybase Adapter

JDBC Connector Settings

Connection Retry Settings

Outbound Sybase non-Transactional Adapter

JDBC Connector Settings

Connection Retry Settings

JDBC/ODBC Adapter Environment Properties

Inbound JDBC Adapter Properties

Outbound JDBC Adapter Properties

JDBC Connector Settings

Connection Retry Settings

Outbound non-Transactional JDBC Adapter Properties

JDBC Connector Settings

Connection Retry Settings

Outbound XA JDBC Adapter Properties

JDBC Connector Settings

Connection Retry Settings

VSAM Adapter Environment Properties

Inbound VSAM Adapter Properties

Outbound VSAM CP Adapter Properties

JDBC Connector Settings

Connection Retry Settings

Outbound VSAM non-Transactional Adapter Properties

JDBC Connector Settings

Connection Retry Settings

DB2 Connect Adapter Environment Properties

The DB2 Connect Adapter configuration parameters, accessed from the NetBeans Services window, are organized into the following sections:

Inbound DB2 Connect Adapter - Parameter Settings

The Inbound DB2 Connect Adapter > Parameter Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 14 Inbound DB2 Connect Adapter - Parameter Settings.

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default is DB2 Connect DriverManager.
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.

Outbound DB2 Connect Adapter - JDBC Connector Settings

The Outbound DB2 Connect Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 15 Outbound DB2 Connect Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect Connection Pool Datasource.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##.

A list of properties and their parameters.

The format is (with no spaces): <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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect Adapter - Connection Retry Settings

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

Table 16 Outbound DB2 Connect Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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 DB2 Connect non-Transactional Adapter - JDBC Connector Settings

The Outbound DB2 Connect non-Transactional Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 17 Outbound DB2 Connect non-Transactional Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect non-Transactional Connection Pool Datasource.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##

A list of properties and their parameters.

The format is (with no spaces): <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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect non-Transactional Adapter - Connection Retry Settings

The Outbound DB2 Connect non-Transactional Adapter > Connection Retry Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 18 Outbound DB2 Connect non-Transactional Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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 DB2 Connect XA Adapter - JDBC Connector Settings

The Outbound DB2 Connect XA Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 19 Outbound DB2 Connect XA Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect XA Datasource.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##.

A list of properties with their parameters.

The format is (with no spaces):

<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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect XA Adapter - Connection Retry Settings

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

Table 20 Outbound DB2 Connect XA Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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).

Inbound DB2 Connect Type 4 Adapter - Parameter Settings

The Inbound DB2 Connect Type 4 Adapter > Parameter Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 21 Inbound DB2 Connect Type 4 Adapter - Parameter Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default is DB2 Connect DriverManager.
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 446.
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.

Outbound DB2 Connect Type 4 Adapter - JDBC Connector Settings

The Outbound DB2 Connect Type 4 Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 22 Outbound DB2 Connect Type 4 Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect Type 4 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 446.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##.

A list of properties with their parameters.

The format is (with no spaces):

<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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect Type 4 Adapter - Connection Retry Settings

The Outbound DB2 Connect Type 4 Adapter > Connection Retry Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 23 Outbound DB2 Connect Type 4 Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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 DB2 Connect non-Transactional Type 4 Adapter - JDBC Connector Settings

The Outbound DB2 Connect non-Transactional Type 4 Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 24 Outbound DB2 Connect non-Transactional Type 4 Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect Type 4 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 446.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##.

A list of properties and their parameters.

The format is (with no spaces):

<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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect non-Transactional Type 4 Adapter - Connection Retry Settings

The Outbound DB2 Connect non-Transactional Type 4 Adapter > Connection Retry Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 25 Outbound DB2 Connect non-Transactional Type 4 Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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 DB2 Connect Type 4 XA Adapter - JDBC Connector Settings

The Outbound DB2 Connect Type 4 XA Adapter > JDBC Connector Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 26 Outbound DB2 Connect Type 4 XA Adapter - JDBC Connector Settings

Name
Description
Required Value
Description
Enter a description for the database.
A valid string. The default value is DB2 Connect Type 4 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 446.
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
Use the JDBC driver that is shipped with this Adapter. Often times the DataSource implementation needs to execute additional methods to assure a connection. You must identify the additional methods in the Driver Properties.

For example: To obtain a DB2 Connect trace, give the method a string for the email: settraceLevel#-1##settraceFile#c:/temp/db2trace.txt##.

A list of properties with their parameters.

The format is (with no spaces):

<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 #.
MinPoolSize
The minimum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there are no physical connections in the pool and new connections are created as needed.
A valid numeric value. The default is 0.
MaxPoolSize
The maximum number of physical connections the pool keeps available at all times. 0 (zero) indicates that there is no maximum.
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.

Outbound DB2 Connect Type 4 XA Adapter - Connection Retry Settings

The Outbound DB2 Connect Type 4 XA Adapter > Connection Retry Settings section of the DB2 Connect Environment properties, contains the top-level parameters displayed in the following table.

Table 27 Outbound DB2 Connect Type 4 XA Adapter - Connection Retry Settings

Name
Description
Required Value
ConnectionRetries
Specifies the number of retries to establish a connection with the DB2 Connect 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 10 times in 5 seconds intervals when the Connection Retries is 10 and the Connection Retry Interval 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).