Configuring Java CAPS Environment Components for Database Adapters

Configuring SQL Server Adapter Environment Properties

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

Inbound SQL Server Adapter Properties

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

Table 40 Inbound SQL Server Adapter Environment Properties


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is SQLServer 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 1433.
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 SQL Server Adapter Properties

The Outbound SQL Server 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 SQL Server Environment contains the top-level parameters displayed in the following table.

Table 41 Outbound Adapter Environment JDBC Connector Settings


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is SQLServer 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 1433.
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	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> #.........<param-n>##<method-name-2>#<param-1> #<param-2>#........<param-n>##......##”. For example: to execute the method setSpyAttributes, give the method a String for the URL “setSpyAttribute#<url>##”. Note – The setSpyAttributes (for Data Direct drivers) that are contained in the following examples (between the last set of double octothorps [##] within each example), are used for debugging purposes and need not be used on every occasion. Optional—if you are using Spy Log: “setURL#jdbc:Seebeyond:SQLServer://<server>:4100; DatabaseName=<database>##setSpyAttributes#log= (file)c:/temp/spy.log;logTName=yes##”
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.

Connection Retry Settings

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

Table 42 Outbound Adapter Environment Connection Retry Settings


Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection with the SQL Server 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.	A valid numeric value. The default is 1000.

Outbound SQL Server Non-Transactional Adapter Properties

The Outbound SQL Server Non-Transactional 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 SQL Server Non-Transactional Environment contains the top-level parameters displayed in the following table.

Table 43 Outbound Adapter Environment JDBC Connector Settings


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default is SQLServer 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 1433.
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	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> #.........<param-n>##<method-name-2>#<param-1> #<param-2>#........<param-n>##......##”. For example: to execute the method setSpyAttributes, give the method a String for the URL “setSpyAttribute#<url>##”. Note – The setSpyAttributes (for Data Direct drivers) that are contained in the following examples (between the last set of double octothorps [##] within each example), are used for debugging purposes and need not be used on every occasion. Optional—if you are using Spy Log: “setURL#jdbc:Seebeyond:SQLServer://<server>:4100;” DatabaseName=<database>##setSpyAttributes#log= (file)c:/temp/spy.log;logTName=yes##
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.

Connection Retry Settings

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

Table 44 Outbound Adapter Environment Connection Retry Settings


Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection with the SQL Server 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.	A valid numeric value. The default is 1000.

Outbound SQL Server XA Adapter Properties

The Outbound SQL Server XA Adapter properties, 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 SQL Server Environment contains the top-level parameters displayed in the following table.

Table 45 Outbound SQL Server XA Adapter Environment JDBC Connector Settings


Name	Description	Required Value
Description	Enter a description for the database.	A valid string. The default value is SQLServer 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 1433.
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	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># .........<param-n>##<method-name-2># <param-1>#<param-2>#........<param-n>##......##”. For example: to execute the method setSpyAttributes, give the method a String for the URL “setSpyAttribute#<url>##”. Note – The setSpyAttributes (for Data Direct drivers) that are contained in the following examples (between the last set of double octothorps [##] within each example), are used for debugging purposes and need not be used on every occasion. Optional—if you are using Spy Log: “setURL#jdbc:Seebeyond:SQLServer://<server>:4100; DatabaseName=<database>##setSpyAttributes#log= (file)c:/temp/spy.log;logTName=yes##”
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.

Connection Retry Settings (with XA support)

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

Table 46 Outbound SQL Server XA Adapter Environment Connection Retry Settings


Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection with the SQL Server database upon a failure to acquire one.	an integer indicating the number of attempts allowed to establish a connection. The configured default is 0.
ConnectionRetryInterval	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.	A valid numeric value. The default is 1000.