Configuring Java CAPS Environment Components for Database Adapters

Configuring Oracle Adapter Environment Properties

The Oracle Adapter configuration parameters, accessed from the Environment Explorer tree, are organized into the following sections:

Inbound Oracle Adapter Environment Properties

The Parameter Settings section of the Inbound Oracle Environment contains the top-level parameters displayed in the following table.

Table 35 Inbound Oracle Adapter Environment Properties


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is Oracle 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 1521.
DatabaseName	Specifies the name of the Oracle SID.	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 Oracle Adapter Environment Properties

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

JDBC Connector Settings

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

Table 36 Outbound Adapter Environment JDBC Connector Settings


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is Oracle 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 1521.
DatabaseName	Specifies the name of the Oracle SID.	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 (Optional Setting)	Use the JDBC driver that is shipped with this Adapter. The DataSource implementation may need to execute additional methods to assure a successful run. The additional methods will need to be identified in the Driver Properties. Note – This field is seldomly used for Oracle.	The delimiter set by the user. For more information, see the Delimiter property below. Valid delimiters are: “<method-name-1>#<param-1>
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.
TNSEntry	Specifies the TNS name for the Oracle instance specified in `TNSNAMES.ORA`. If a TNS name is specified, then the OCI driver is used, which further requires installation of the Oracle client. If a TNS name is not specified, then the thin driver is used.	A valid TNS name if using the OCI driver; otherwise do not enter any value.
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

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

Table 37 Outbound Adapter Environment Connection Retry Settings


Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection with the Oracle database upon a failure to acquire one.	an integer indicationg 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 Oracle Adapter Environment Properties with XA support

The Outbound Oracle Adapter properties with XA support, accessed from the Environment Explorer tree, are organized into the following sections:

JDBC Connector Settings (with XA support)

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

Table 38 Outbound XA Adapter Environment JDBC Connector Settings


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is Oracle 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 1521.
DatabaseName	Specifies the name of the Oracle SID.	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 (Optional Setting)	Use the JDBC driver that is shipped with this Adapter. The DataSource implementation may need to execute additional methods to assure a successful run. The additional methods will need to be identified in the Driver Properties.	The delimiter set by the user. For more information, see the Delimiter property below. Valid delimiters are: “<method-name-1>#<param-1>#<param-2>
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.
TNSEntry	Specifies the TNS name for the Oracle instance specified in `TNSNAMES.ORA`. If a TNS name is specified, then the OCI driver is used, which further requires installation of the Oracle client. If a TNS name is not specified, then the thin driver is used.	A valid TNS name if using the OCI driver; otherwise do not enter any value.
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 (with XA support)

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

Table 39 Outbound XA Adapter Environment Connection Retry Settings


Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection with the Oracle 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).