VSAM Adapter Environment Properties

Adapter External System properties must be configured from within the Environment. Until you have successfully configured all Adapters for your Java CAPS project, your project cannot be properly executed or deployed. The following list identifies the VSAM Adapter properties. There are two Environment Configuration categories that the VSAM Adapter implements.

Inbound VSAM Adapter Properties
Outbound VSAM CP Adapter Properties
Outbound VSAM non-Transactional Adapter Properties

Inbound VSAM Adapter Properties

Before deploying your Adapter, you will need to set the Environment properties.

Details for the Inbound VSAM Adapter Parameter Settings are listed in the following table.

Table 61 Inbound VSAM Adapter—Parameter Settings

Name	Description	Required Value
Description	The description of the database.	A valid string.
ServerName	This setting 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.
DatabaseName	Specifies the name of the database instance. This parameter is configured in conjunction with the Data Catalogue name you created in WebSphere Classic Federation’s Data Mapper.	Any valid string.
User	Specifies the user name the Adapter uses to connect to the database.	Any valid string.
Password	Specifies the password used to access the database.	Any valid string.

Outbound VSAM CP Adapter Properties

The Outbound VSAM CP Adapter includes the following configuration sections:

JDBC Connector Settings
Connection Retry Settings

JDBC Connector Settings

Details for the VSAM CP Adapter JDBC Connector Settings used by the external database are detailed in the following table.

Table 62 VSAM CP Adapter—JDBC Connector Settings

Name	Description	Required Value
Description	The description of the database.	A valid string. The configured default is VSAM Connection Pool Datasource.
ServerName	This setting 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.
DatabaseName	Specifies the name of the database instance.	Any valid string.
User	Specifies the user name 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 Connection Pool 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. You must ensure that the driver is installed on both the application server machine and Java CAPS IDE. 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:VSAM://<server>: 4100;DatabaseName=<database>## setSpyAttributes#log=(file) c:/temp/spy.log;logTName=yes##`	A list of properties, delimited by the specific character. For more information, see the Delimiter property below. The default 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 a longer connection time 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. If the pool size is too big, you may end up with too many connections with the database. The pool size depends on the transaction volume and response time.	A valid numeric value. The default is 10.
MaxIdleTime	Specifies 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

Details for the VSAM CP Adapter Connection Retry Settings used by the external database are detailed in the following table.

Table 63 VSAM CP Adapter—Connection Retry Settings

Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection upon failure to acquire one.	A valid numeric value. The default is 0.
ConnectionRetryInterval	Specifies the milliseconds of pause before each attempt to reaccess 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 apart when the Connection Retries is 10 and the Connection Retry Interval is 5000.	A valid numeric value. The default is 1000.

Outbound VSAM non-Transactional Adapter Properties

The Outbound VSAM non-Transactional Adapter includes the following configuration sections:

JDBC Connector Settings
Connection Retry Settings

JDBC Connector Settings

Details for the VSAM non-Transactional Adapter JDBC Connector Settings used by the external database are detailed in the following table.

Table 64 VSAM non-Transactional Adapter—JDBC Connector Settings

Name	Description	Required Value
Description	The description of the database.	A valid string. The configured default is VSAM non-Transactional Connection Pool Datasource.
ServerName	This setting 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.
DatabaseName	Specifies the name of the database instance.	Any valid string.
User	Specifies the user name 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 Connection Pool 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. You must ensure that the driver is installed on both the application server machine and Java CAPS IDE. 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:VSAM://<server>: 4100;DatabaseName=<database>## setSpyAttributes#log=(file) c:/temp/spy.log;logTName=yes##`	A list of properties, delimited by the specific character. For more information, see the Delimiter property below. The default 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 a longer connection time 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. If the pool size is too big, you may end up with too many connections with the database. The pool size depends on the transaction volume and response time.	A valid numeric value. The default is 10.
MaxIdleTime	Specifies 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

Details for the VSAM non-Transactional Adapter Connection Retry Settings used by the external database are detailed in the following table.

Table 65 VSAM non-Transactional Adapter—Connection Retry Settings

Name	Description	Required Value
ConnectionRetries	Specifies the number of retries to establish a connection upon failure to acquire one.	A valid numeric value. The default is 0.
ConnectionRetryInterval	Specifies the milliseconds of pause before each attempt to reaccess 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 apart when the Connection Retries is 10 and the Connection Retry Interval is 5000.	A valid numeric value. The default is 1000.

Skip Navigation Links
Exit Print View
	Configuring Environment Components for Oracle Java CAPS Database Adapters Java CAPS Documentation