Connection properties for the wizard, WebSphere Adapter for JDBC

IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > JDBC > Reference > Configuration properties > Inbound configuration properties
Connection properties for the wizard

External service connection properties are used to establish a connection between the external service wizard, a tool used to create business objects, and the database. These properties specify such things as connection configuration, bidirectional transformation properties, and logging options for the wizard. Once a connection is established, the wizard can discover in the database the metadata it needs to create business objects.

Some of the properties that you provide for the wizard to discover objects in the database are used as the initial value for the run time properties that you specify later in the wizard. These include resource adapter, managed connection factory, and activation specification properties.
The connection properties for the external service wizard and their purpose is described in the following table. A complete description of each property is provided in the sections that follow the table. For information about how to read the property detail tables in the sections that follow, see Guide to information about properties.

Connection properties for the external service wizard
Property name in the wizard Description
Additional JDBC driver connection properties
Additional properties for connecting to the database using the JDBC driver, which are used in addition to the UserName and Password properties.
Database Specifies the name of the database.
Database software The name and version of the database management software used by the adapter.
Database URL
The database URL used to connect to the database.
Host name The host name or IP address of the database server.
JDBC driver class name The name of the JDBC driver class.
JDBC driver type The type of JDBC driver to use.
Password Password for the corresponding user name.
Port number The port number for connecting to the database instance.
Prefix for business object names A prefix to be added to the name of the business object.
Server name
The name of the Informix database server to which the adapter connects.
Set Auto Commit on database connection
Specify whether the underlying database connection is in the Auto Commit mode.
User name Specifies the database user name for connecting to the database.

The external service wizard uses the bidirectional connection properties to apply the proper bidirectional transformation on the data passed to the enterprise information system.

Additional JDBC driver connection properties

This property contains additional information for connecting to the database using the JDBC driver.
Additional JDBC driver connection properties details
Row Explanation
Required No
Possible values Database connection properties are database-specific.
Default No default value
Property type String
Usage These connection properties are used in addition to the UserName and Password properties to customize the database connection used by the adapter.
Specify the connection properties as one or more name: value pairs separated by the semicolon character (;).
Example
The following value of this property specifies a login timeout interval, makes a read-only database connection, and sets the security mechanism:
loginTimeout:20;readOnly:true;
securityMechanism:USER_ONLY_SECURITY 
In a high availability environment, to get the properties that DB2 driver requires (retryIntervalForClientReroute, maxRetriesForClientReroute, clientRerouteAlternateServerName, clientRerouteAlternatePortNumber) for a reliable connection to the High Availability and Disaster Recovery (HADR) database, configure this property to generate the correct property string as shown in the example below:
retryIntervalForClientReroute:15;
maxRetriesForClientReroute:5;
clientRerouteAlternateServerName:WLOXS01B.svl.ibm.com;
clientRerouteAlternatePortNumber:50000
For more information about using WebSphere Adapter in WebSphere High Availability
Globalized Yes
Bidi supported No
Database

This property specifies the name of the database.

Database name details
Row Explanation
Required Yes
Default The default value is database-specific
Property type String
Usage This is the name of the database you want to access. For an Oracle database, this is the system ID (SID), which identifies the database.
Globalized Yes
Bidi supported Yes

Database software

This property specifies the database management software that manages the database that the adapter will access.

Database software details
Row Explanation
Required Yes
Possible values This property lists common database software by name and version number. If your software is not listed, select Generic JDBC.
Default No default value
Property type String
Usage The external service wizard uses the value of this property to set default values and generate database-specific selection lists for other properties.
For example, if you select DB2 USB Version 9.1, the JDBC driver class field in the wizard displays only the JDBC drivers supported by that version of DB2 UDB. If you select Oracle 10, a different set of JDBC drivers is shown.
Globalized Yes
Bidi supported Yes

Database URL

This property specifies the JDBC driver-specific URL for creating a connection to the database.

Database URL details
Row Explanation
Required Yes
Default No default value
Property type String
Usage This value is specific to the database software and JDBC driver that you are using.
If your database server supports IPv6, you can specify the host name portion of the database URL in IPv6 format. Enclose the IP address in square brackets ( []).
Examples The following are typical values for common database servers.

DB2 universal (type 4) JDBC driver

jdbc:db2://<Host_Name>/DB

DB2 universal JDBC driver with an IPv6 address

jdbc:db2://[fe80::20c:29ff:feea:1361%4]:50000/DB

DB2 Universal Database™ type 2 driver for local connection

jdbc:db2:TEST

DB2 Universal Database type 2 driver for remote connection

jdbc:db2://<Host_Name>/TEST

Informix V10

jdbc:informix-sql://<Host_Name>/symaster:INFORMIXSERVER=server

Oracle V10

jdbc:oracle:thin:@9.26.248.148:1521:dev

Derby JDBC driver (non-remote)

jdbc:derby://<runtime home>/runtimes/bi_v6/derby/databases/JDBCTEST

If using a remote test environment on z/OS , use the following value for the Derby database URL:

Derby JDBC driver (remote z/OS test environment)

jdbc:db2j:net://<HOST_NAME>:1527// <remote_derbydb_path>/JDBCTEST</remote_derbydb_path></HOST_NAME>

Globalized Yes
Bidi supported Yes

Host name

This property specifies the host name or IP address of the database server.

Host name details
Row Explanation
Required Yes
Default No default value
Property type String
Usage This is the host name or IP address of the database server. If the database server supports IPv6, you can specify the host name in IPv6 format.
Globalized Yes
Bidi supported Yes

JDBC driver class name

This property specifies the name of the JDBC driver class.

JDBC driver class name details
Row Explanation
Required Yes
Possible values The possible values depend on the database type and version. The wizard displays a list of known drivers.
Default The default depends on the database type and version.
Property type String
Usage Although the wizard displays the default class name for the JDBC driver type you select, you can type another class name if needed. If you select Other as the JDBC driver value, no default is provided, and you need to type the class name. The class name must be in the JDBC driver files you provide when you start the wizard.
Globalized Yes
Bidi supported No

JDBC driver type

This property specifies the type of JDBC driver to use.

JDBC driver type details
Row Explanation
Required Yes
Possible values The possible values depend on the database type and version. The wizard displays a list of known drivers.
Default The default depends on the database type and version
Property type String
Usage This is the type of JDBC driver to use. While the basic question is whether you want a type 2 or type 4 (universal) driver, each database system has its own name for the driver. The wizard displays a list of drivers known for each database system. Select Other if your driver is not listed. The information in this field must agree with the JDBC driver files you provide when you start the wizard.
Globalized Yes
Bidi supported No

Password (Password)

Password for the corresponding user name.

Password details
Row Explanation
Required Yes
Default No default value
Property type String
Usage The password associated with the user name entered to connect to the database for the purpose of discovering objects.
Globalized Yes
Bidi supported Yes

Port number

This property specifies the port number for the database instance.

Port number details
Row Explanation
Required Yes
Default
The default value is database-specific, and is initialized by the wizard if you select a named driver in JDBC driver type.
Property type String
Usage This is the port number for connecting to the database instance.
This property is not enabled if you select Other for the JDBC driver type.
Globalized Yes
Bidi supported No

Prefix for business object names

The prefix to be added to the name of the business object.

Prefix details
Row Explanation
Required No
Default No default value
Property type String
Usage Use a prefix to help distinguish between the types of business objects.
Example You might specify a prefix of JDBC for generic business objects and %AppName% for an application-specific business object.
Globalized Yes
Bidi supported No

Server name

Specifies the default name of the Informix database server to which the adapter connects.

Server name details
Row Explanation
Required Yes
Default server
Property type String
Usage
The value of the server name can be a local or remote server, but must correspond to a valid dbservername entry in the $INFORMIXDIR/etc/sqlhosts file on the computer running the application.
The dbservername must begin with a lowercase letter and cannot exceed 128 bytes. It can include any printable characters except uppercase characters, field delimiters (blank space or tab), the newline character, and the hyphen (or minus) symbol.
Globalized No
Bidi supported No

Set Auto Commit on database connection

Specify whether the underlying database connection is in the Auto Commit mode. It overrides the default setting in the Sybase database for the transaction mode for the stored procedure.

Set auto commit on database connection details
Row Explanation
Required Yes, for specific JDBC drivers and fork a certain stored procedure configuration.
Default False
Property type Boolean
Usage Set this value to specify whether the underlying database connection is in Auto Commit mode. If this property is set to True, any change to the underlying database will not roll back after the wizard is complete.
Setting this property is necessary if you are performing discovery on a Sybase database using the jConnect driver, and the transaction mode setting for stored procedure on the Sybase database is set to "unchained mode" or "Transact-SQL mode".
By setting this property to True, you override a Sybase transaction mode configuration that prevents the adapter from discovering result sets.
Globalized Yes
Bidi supported No

User name (UserName)

This property specifies the database user name for connecting to the database.

User name details
Row Explanation
Required Yes
Default No default value
Property type String
Usage The user name is the name entered to connect to the database for discovering objects.
Globalized Yes
Bidi supported Yes

Inbound configuration properties

Property name in the wizard	Description
Additional JDBC driver connection properties	Additional properties for connecting to the database using the JDBC driver, which are used in addition to the UserName and Password properties.
Database	Specifies the name of the database.
Database software	The name and version of the database management software used by the adapter.
Database URL	The database URL used to connect to the database.
Host name	The host name or IP address of the database server.
JDBC driver class name	The name of the JDBC driver class.
JDBC driver type	The type of JDBC driver to use.
Password	Password for the corresponding user name.
Port number	The port number for connecting to the database instance.
Prefix for business object names	A prefix to be added to the name of the business object.
Server name	The name of the Informix database server to which the adapter connects.
Set Auto Commit on database connection	Specify whether the underlying database connection is in the Auto Commit mode.
User name	Specifies the database user name for connecting to the database.

Row	Explanation
Required	No
Possible values	Database connection properties are database-specific.
Default	No default value
Property type	String
Usage	These connection properties are used in addition to the UserName and Password properties to customize the database connection used by the adapter. Specify the connection properties as one or more name: value pairs separated by the semicolon character (;).
Example	The following value of this property specifies a login timeout interval, makes a read-only database connection, and sets the security mechanism: loginTimeout:20;readOnly:true; securityMechanism:USER_ONLY_SECURITY In a high availability environment, to get the properties that DB2 driver requires (retryIntervalForClientReroute, maxRetriesForClientReroute, clientRerouteAlternateServerName, clientRerouteAlternatePortNumber) for a reliable connection to the High Availability and Disaster Recovery (HADR) database, configure this property to generate the correct property string as shown in the example below: retryIntervalForClientReroute:15; maxRetriesForClientReroute:5; clientRerouteAlternateServerName:WLOXS01B.svl.ibm.com; clientRerouteAlternatePortNumber:50000 For more information about using WebSphere Adapter in WebSphere High Availability
Globalized	Yes
Bidi supported	No

Row	Explanation
Required	Yes
Default	The default value is database-specific
Property type	String
Usage	This is the name of the database you want to access. For an Oracle database, this is the system ID (SID), which identifies the database.
Globalized	Yes
Bidi supported	Yes

Row	Explanation
Required	Yes
Possible values	This property lists common database software by name and version number. If your software is not listed, select Generic JDBC.
Default	No default value
Property type	String
Usage	The external service wizard uses the value of this property to set default values and generate database-specific selection lists for other properties. For example, if you select DB2 USB Version 9.1, the JDBC driver class field in the wizard displays only the JDBC drivers supported by that version of DB2 UDB. If you select Oracle 10, a different set of JDBC drivers is shown.
Globalized	Yes
Bidi supported	Yes

Row	Explanation
Required	Yes
Possible values	The possible values depend on the database type and version. The wizard displays a list of known drivers.
Default	The default depends on the database type and version.
Property type	String
Usage	Although the wizard displays the default class name for the JDBC driver type you select, you can type another class name if needed. If you select Other as the JDBC driver value, no default is provided, and you need to type the class name. The class name must be in the JDBC driver files you provide when you start the wizard.
Globalized	Yes
Bidi supported	No

Row	Explanation
Required	Yes
Default	The default value is database-specific, and is initialized by the wizard if you select a named driver in JDBC driver type.
Property type	String
Usage	This is the port number for connecting to the database instance. This property is not enabled if you select Other for the JDBC driver type.
Globalized	Yes
Bidi supported	No

Row	Explanation
Required	Yes
Default	server
Property type	String
Usage	The value of the server name can be a local or remote server, but must correspond to a valid dbservername entry in the $INFORMIXDIR/etc/sqlhosts file on the computer running the application. The dbservername must begin with a lowercase letter and cannot exceed 128 bytes. It can include any printable characters except uppercase characters, field delimiters (blank space or tab), the newline character, and the hyphen (or minus) symbol.
Globalized	No
Bidi supported	No

Row	Explanation
Required	Yes, for specific JDBC drivers and fork a certain stored procedure configuration.
Default	False
Property type	Boolean
Usage	Set this value to specify whether the underlying database connection is in Auto Commit mode. If this property is set to True, any change to the underlying database will not roll back after the wizard is complete. Setting this property is necessary if you are performing discovery on a Sybase database using the jConnect driver, and the transaction mode setting for stored procedure on the Sybase database is set to "unchained mode" or "Transact-SQL mode". By setting this property to True, you override a Sybase transaction mode configuration that prevents the adapter from discovering result sets.
Globalized	Yes
Bidi supported	No