Jython script library: JDBC configuration scripts

JDBC configuration scripts

The scripting library provides script procedures to manage Java Database Connectivity (JDBC) configurations in the environment.
AdminJDBC script procedures are located in...
app_server_root/scriptLibraries/resources/JDBC/V70

Do not edit the script procedures in the script library. To avoid overwriting the library, put custom scripts in...
app_server_root/scriptLibraries/new_subdirectory

Scope argument

A cell is optional on node, server, and cluster scopes. A node is required on the server scope. We can delimit the type using a comma (,) or a colon (:). Use first case for the type (cell=, node=, server=, or cluster=).

Scope Containment path Configuration ID Type
Cell /Cell:myCell/ myCell(cells/myCell|cell.xml#Cell_1) Cell=myCell
cell=myCell
Node /Cell:myCell/Node:myNode/
/Node:myNode/ myNode(cells/myCell/nodes/myNode|node.xml#Node_1) Cell=myCell, Node=myNode
Cell=myCell:Node=myNode
cell=myCell, node=myNode
Server /Cell:myCell/Node:myNode/Server:myServer/
/Node:myNode/Server:myServer/ myServer(cells/myCell/nodes/myNode/servers/myServer|server.xml#Server_1) Cell=myCell, Node=myNode, Server=myServer
Node=myNode:Server=myServer
cell=myCell, Node=myNode, Server=myServer
Cluster Cell:myCell/ServerCluster:myCluster/
/ServerCluster:myCluster/ myCluster(cells/myCell/clusters/myCluster|cluster.xml#ServerCluster_1) Cell=myCell, Cluster=myCluster
Cell=myCell:Cluster=myCluster
cell=myCell, Cluster=myCluster

createDataSource

This script creates a new data source in the configuration. The script returns the configuration ID of the new data source. To run the script, specify the node name, server name, JDBC provider, and data source name arguments. We can optionally specify attributes.

Argument Description
nodeName Node of interest.
serverName Server of interest.
jdbcProvider JDBC provider of interest.
dsName Name to assign to the new data source.
attributes Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
authDataAlias Alias used for database authentication at run time. ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

category Category used to classify or group the resource. ['category', 'myCategory']
connectionPool JDBC connection pooling properties for the parent JDBC connection factory instance.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["connectionPool",[["agedTimeout","100"], ["connectionTimeout","1000"], ["freePoolDistributionTableSize",10], ["maxConnections","12"],["minConnections","5"], ["numberOfFreePoolPartitions","3"], ["numberOfSharedPoolPartitions","6"], ["numberOfUnsharedPoolPartitions","3"], ["properties",[["description","My description"], ["name","myName"],["required","false"],["type","String"], ["validationExpression",""],["value","myValue"]]], ["purgePolicy","EntirePool"],["reapTime","10000"], ["struckThreshold","3"],["struckTime","10"], ["struckTimerTime","10"],["surgeCreationInterval","10"], ["surgeThreshold","10"],["testConnection","true"], ["testConnectionInterval","10"], ["unusedTimeout","10000"]]]
datasourceHelperClassname DataStoreHelper implementation class that extends the capabilities of the implementation class of the JDBC driver. The extended capabilities allow the JDBC drive to perform functions specific to the data. com.ibm.websphere.rsadapter.DB2DataStoreHelper
com.ibm.websphere.rsadapter.DerbyDataStoreHelper ...
description Description of the data source. ['description', 'My description']
jndiName JNDI name for this data source. ['jndiName', 'myJndiName']
logMissingTransactionContext Specifies whether missing transaction context logging is enabled. ['logMissingTransactionContext', 'false']
manageCachedHandles Specifies whether this data source is used for container-managed persistence of enterprise beans. Default is true. ['manageCachedHandles', 'false']
mapping When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["mapping",[["authDataAlias","authDataAliasValue"], ["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["preTestConfig",[["preTestConnection", "true"], "retryInterval", "12343"],"retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["properties",[["description","My description"], ["name", "myName"],"required","false"], ["type","String"],["validationExpression",""], "value','myValue"]]]
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[name databaseName][type string][value mys]] [name driverType][type integer][value 4]] [name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
relationalResourceAdapter Relational resource adapter that the data source uses. The available Java 2 Connector (J2C) resource adapter ID of J2CResourceAdapterID can be identified with the AdminConfig.list ('J2CResourceAdapter') command. [relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1| resources.xml#builtin_rra)"]
statementCacheSize Number of statements that the product can cache for each connection. The product optimizes the processing of prepared statements and callable statements by caching statements that are not used in an active connection. Both statement types improve the performance of transactions between an application and a datastore. Caching the statements makes them more readily available. ['statementCacheSize', 5]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication. ['-xaRecoveryAuthAlias', 'myCellManager01/a1']

Attributes Description Example
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Using IBM JCC Driver']

Syntax

providerType optional attribute

Syntax
Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

AdminJDBC.createDataSource(nodeName, serverName, jdbcProvider, dsName, attributes)

Example

Required attributes only:

AdminJDBC.createDataSource("myNode", "myServer", "myJDBCProvider", "myDataSource")

Optional attributes in a string format:
AdminJDBC.createDataSource("MyNode01", "server1", "My JDBC Name2", "MyJDBCDS", "authDataAlias=cellManager01/myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, datasourceHelperClassname=com.ibm.websphere.rsadapter.DB2DataStoreHelper, description='My description', diagnoseConnectionUsage=true, jndiName=myJndiName, logMissingTransactionContext=false, manageCachedHandles=false, providerType='DB2 Using IBM JCC Driver', xaRecoveryAuthAlias=myCellManager01/xa1")

Include optional attributes in a list format:

AdminJDBC.createDataSource("MyNode01", "server1", "My JDBC Name2", "MyJDBCDS", [['authDataAlias', 'cellManager01/myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['connectionPool', [['agedTimeout', 100], ['connectionTimeout', 1000], ['freePoolDistributionTableSize', 10], ['maxConnections', 12], ['minConnections', 5], ['numberOfFreePoolPartitions', 3], ['numberOfSharedPoolPartitions', 6], ['numberOfUnsharedPoolPartitions', 3], ['properties', [[['name', 'name1a'], ['value', 'value1a']], [['name', 'name1b'], ['value', 'value1b']]]], ['purgePolicy', 'EntirePool'], ['reapTime', 10000], ['stuckThreshold', 3], ['stuckTime', 10], ['stuckTimerTime', 10], ['surgeThreshold', 10], ['testConnection', 'true']]], ['datasourceHelperClassname', 'com.ibm.websphere.rsadapter.DB2DataStoreHelper'], ['description', 'My description'], ['diagnoseConnectionUsage', 'true'], ['jndiName', 'myJndiName'], ['logMissingTransactionContext', 'false'], ['manageCachedHandles', 'false'], ['mapping', [['authDataAlias', 'anAlias'], ['mappingConfigAlias', 'anotherTest']]], ['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', 12343], ['retryLimit', 4]]], ['properties', [[['name', 'name1'], ['value', 'value1']], [['name', 'name2'], ['value', 'value2']]]], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'integer'], ['value', 50000]]]]]], ['providerType', 'DB2 Using IBM JCC Driver'], ['relationalResourceAdapter', 'SIB JMS Resource Adapter (cells/MyCell/nodes/MyNode01/servers/server1|resources.xml#J2CResourceAdapter_1232911649746)'], ['statementCacheSize', 5], ['xaRecoveryAuthAlias', 'myCellManager01/xa1']])

createDataSourceUsingTemplate

This script uses a template to create a new data source in the configuration. The script returns the configuration ID of the new data source.

To run the script, specify the node name, server name, JDBC provider, template ID, and data source name arguments. We can optionally specify attributes:

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jdbcProvider Name of the JDBC provider of interest.
templateID Configuration ID of the template to use to create the data source.
dsName Name to assign to the new data source.
attributes
Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
authDataAlias Alias used for database authentication at run time. ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

category Category used to classify or group the resource. ['category', 'myCategory']
connectionPool JDBC connection pooling properties for the parent JDBC connection factory instance.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["connectionPool",[["agedTimeout","100"], ["connectionTimeout","1000"], ["freePoolDistributionTableSize",10], ["maxConnections","12"],["minConnections","5"], ["numberOfFreePoolPartitions","3"], ["numberOfSharedPoolPartitions","6"], ["numberOfUnsharedPoolPartitions","3"], ["properties",[["description","My description"], ["name","myName"],["required","false"],["type","String"], ["validationExpression",""],["value","myValue"]]], ["purgePolicy","EntirePool"],["reapTime","10000"], ["struckThreshold","3"],["struckTime","10"], ["struckTimerTime","10"],["surgeCreationInterval","10"], ["surgeThreshold","10"],["testConnection","true"], ["testConnectionInterval","10"], ["unusedTimeout","10000"]]]
datasourceHelperClassname DataStoreHelper implementation class that extends the capabilities of the implementation class of the JDBC driver. The extended capabilities allow the JDBC drive to perform functions specific to the data. com.ibm.websphere.rsadapter.DB2DataStoreHelper
com.ibm.websphere.rsadapter.DerbyDataStoreHelper
...
description Description of the data source. ['description', 'My description']
jndiName JNDI name for this data source. ['jndiName', 'myJndiName']
logMissingTransactionContext Specifies whether missing transaction context logging is enabled. ['logMissingTransactionContext', 'false']
manageCachedHandles Specifies whether this data source is used for container-managed persistence of enterprise beans. Default is true. ['manageCachedHandles', 'false']
mapping Mapping of the configuration login to a specified authentication alias name. When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["mapping",[["authDataAlias","authDataAliasValue"], ["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["preTestConfig",[["preTestConnection", "true"], "retryInterval", "12343"],"retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["properties",[["description","My description"], ["name", "myName"],"required","false"], ["type","String"],["validationExpression",""], "value','myValue"]]]
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[name databaseName][type string][value mys]] [name driverType][type integer][value 4]] [name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
relationalResourceAdapter Relational resource adapter that the data source uses. The available Java 2 Connector (J2C) resource adapter ID of J2CResourceAdapterID can be identified with the AdminConfig.list('J2CResourceAdapter') command. [relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1| resources.xml#builtin_rra)"]
statementCacheSize Number of statements that the product can cache for each connection. The product optimizes the processing of prepared statements and callable statements by caching statements that are not used in an active connection. Both statement types improve the performance of transactions between an application and a datastore. Caching the statements makes them more readily available. ['statementCacheSize', 5]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication. ['-xaRecoveryAuthAlias', 'myCellManager01/a1']

Attributes Description Example
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Using IBM JCC Driver']

Syntax

providerType optional attribute

Syntax
Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

AdminJDBC.createDataSourceUsingTemplate(nodeName, serverName, jdbcProvider, templateID, dsName, attributes)

Example

Required attributes only:

AdminJDBC.createDataSourceUsingTemplate("myNode", "myServer", "myJDBCProvider", "Derby JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_derby_1)", "myDataSource")

Include optional attributes in a string format:
AdminJDBC.createDataSourceUsingTemplate("MyNode01", "server1", "My JDBC Name2", "DB2 Universal JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_DB2_UNI_1)", "MyJDBCDS", "authDataAlias=cellManager01/myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, datasourceHelperClassname=com.ibm.websphere.rsadapter.DB2DataStoreHelper, description='My description', diagnoseConnectionUsage=true, jndiName=myJndiName, logMissingTransactionContext=false, manageCachedHandles=false, providerType='DB2 Using IBM JCC Driver', xaRecoveryAuthAlias=myCellManager01/xa1")

Include optional attributes in a list format:

AdminJDBC.createDataSourceUsingTemplate("MyNode01", "server1", "My JDBC Name2", "DB2 Universal JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_DB2_UNI_1)", "MyJDBCDS", [['authDataAlias', 'cellManager01/myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['connectionPool', [['agedTimeout', 100], ['connectionTimeout', 1000], ['freePoolDistributionTableSize', 10], ['maxConnections', 12], ['minConnections', 5], ['numberOfFreePoolPartitions', 3], ['numberOfSharedPoolPartitions', 6], ['numberOfUnsharedPoolPartitions', 3], ['properties', [[['name', 'name1a'], ['value', 'value1a']], [['name', 'name1b'], ['value', 'value1b']]]], ['purgePolicy', 'EntirePool'], ['reapTime', 10000], ['stuckThreshold', 3], ['stuckTime', 10], ['stuckTimerTime', 10], ['surgeThreshold', 10], ['testConnection', 'true']]], ['datasourceHelperClassname', 'com.ibm.websphere.rsadapter.DB2DataStoreHelper'], ['description', 'My description'], ['diagnoseConnectionUsage', 'true'], ['jndiName', 'myJndiName'], ['logMissingTransactionContext', 'false'], ['manageCachedHandles', 'false'], ['mapping', [['authDataAlias', 'anAlias'], ['mappingConfigAlias', 'anotherTest']]], ['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', 12343], ['retryLimit', 4]]], ['properties', [[['name', 'name1'], ['value', 'value1']], [['name', 'name2'], ['value', 'value2']]]], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'integer'], ['value', 50000]]]]]], ['providerType', 'DB2 Using IBM JCC Driver'], ['relationalResourceAdapter', 'SIB JMS Resource Adapter(cells/MyCell/clusters/c1|resources.xml#J2CResourceAdapter_1232911649746)'], ['statementCacheSize', 5], ['xaRecoveryAuthAlias', 'myCellManager01/xa1']])

createDataSourceAtScope

Create a New data source in the configuration at the scope specified. The script returns the configuration ID of the new data source. The script procedure uses the createDatasource administrative command to create a new data source. The createDataSource script creates a new data source using the AdminConfig create command.

To run the script, specify the scope, JDBC provider, data source name, database name arguments, and a description. We can optionally specify attributes.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JDBC provider.
JDBCName Name of the JDBC provider of interest.
datasourceName Name to assign to the new data source.
jndiName JNDI name for this data source.
dataStoreHelperClassName DataStoreHelper implementation class that extends the capabilities of the selected JDBC driver implementation class to perform data-specific functions.
dbName (URL for the Oracle database) Name to assign the database for the JDBC provider. For a JDBC provider that uses the Oracle database, the argument specifies the URL of the database from which the datasource obtains connections. Examples are jdbc:oracle:thin:@localhost:1521:sample for a thin driver and jdbc:oracle:oci8:@sample for a thick driver.

description Description of the data source.
otherAttributes Additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format
ue2"

resoureAttributes Attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

failonerror Administrative utilities that process an error condition.

Attributes Description
category Classify or group the resource.
componentManagedAuthenticationAlias Alias used for database authentication at runtime.
containerManagedPersistence When true container managed persistence is enabled
description Description of the data source.
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

Attributes Description
driverType Data source type. The data source type is valid only for JDBC providers that have a database type of DB2.
portNumber Port number of the database server. The port number is valid only for JDBC providers that have a database type of DB2, Informix, Sybase, or SQLServer.
serverName Host name of the database server or IP address. The server name is valid only for JDBC providers that have a database type of DB2, Informix, Sybase, or SQLServer.
ifxIFHOST Connection wait time for obtaining a lock on the database. By default, the Informix database returns an error when it cannot acquire a lock, rather than wait for the current owner of the lock to release it. To modify the behavior, set the property to the number of seconds to wait for a lock. The default is 2 seconds. Any negative value translates into an unlimited wait time. This attribute is valid only for JDBC providers that have a database type of Informix.
informixLockModeWait Physical machine name of the server hosting the Informix instance. We can enter a host name or IP address. We can also enter an Internet Protocol v6 (IPv6) if the host database supports it. This attribute is valid only for JDBC providers that have a database type of Informix.

Syntax

AdminJDBC.createDataSourceAtScope(scope, jdbcProvider, dsName, databaseName, attributes)

Example

Required attributes only:

AdminJDBC.createDataSourceAtScope("myScope", "myJDBCProvider", "myDataSource", "myDatabase")

Examples scripts for the DB2 database type:

Include optional attributes in a string format:
AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "MyTestJDBCProviderName", "newds2", "newds2/jndi", "com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper", "db1", " category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description='My description', xaRecoveryAuthAlias=CellManager01/xaAliase", "serverName=localhost, driverType=4,portNumber=50000")

Include optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "MyTestJDBCProviderName", "newds2", "newds2/jndi", "com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper", "db1", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']], [['serverName', 'localhost'], ['driverType', 4], ['portNumber', 50000]])

Examples scripts for the Derby database:

Optional attributes in a string format:
AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Derby JDBC Provider", "Derby DataSource", "newds2/jndi", "com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper", "db1", " category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description=My description, xaRecoveryAuthAlias=CellManager01/xaAliase")

Include optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Derby JDBC Provider", "Derby DataSource", "newds2/jndi", "com.ibm.websphere.rsadapter.DB2UniversalDataStoreHelper", "db1", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']])

Example scripts for Informix database:

Include optional attributes in a string format:
AdminJDBC.createDataSourceAtScope("Cell=MyCell", "Informix JDBC Driver Test", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.InformixDataStoreHelper", "MyDB", " category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description='My description', xaRecoveryAuthAlias=CellManager01/xaAliase", "serverName=ol_myserver, portNumber=50000, ifxIFXHOST=localhost, informixLockModeWait=2")

Include optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell", "Informix JDBC Driver Test", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.InformixDataStoreHelper", "MyDB", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']], [['serverName', 'ol_myserver'], ['portNumber', 1526], ['ifxIFXHOST', 'localhost'], ['informixLockModeWait', 2]])

Example scripts for Oracle database:

Optional attributes in a string format:
AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Oracle JDBC Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.OracleDataStoreHelper", "http://myURL.com", "category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description='My description', xaRecoveryAuthAlias=CellManager01/xaAliase")

Optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Oracle JDBC Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.OracleDataStoreHelper", "http://myURL.com", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']])

Example scripts for SQLServer database:

Optional attributes in a string format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Microsoft SQL Server JDBC Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.SQLserverDataStoreHelper", "myDBName", " category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description='My description', xaRecoveryAuthAlias=CellManager01/xaAliase", "serverName=localhost, portNumber=1433")

Include optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Microsoft SQL Server JDBC Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.SQLserverDataStoreHelper", "myDBName", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']], [['serverName', 'localhost'], ['portNumber', 1433]])

Example scripts for Sybase database:

Optional attributes in a string format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Sybase JDBC 3 Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.SybaseserverDataStoreHelper", "myDBName", " category=myCategory, componentManagedAuthenticationAlias=CellManager01/AuthDataAliase, containerManagedPersistence=true, description='My description', xaRecoveryAuthAlias=CellManager01/xaAliase", "serverName=localhost, portNumber=1433")

Include optional attributes in a list format:

AdminJDBC.createDataSourceAtScope("Cell=MyCell,Node=MyNode01,Server=server1", "Sybase JDBC 3 Driver", "My DataSource", "My JNDIName", "com.ibm.websphere.rsadapter.SybaseserverDataStoreHelper", "myDBName", [['category', 'myCategory'], ['componentManagedAuthenticationAlias', 'CellManager01/AuthDataAliase'], ['containerManagedPersistence', 'true'], ['description', 'My description'], ['xaRecoveryAuthAlias', 'CellManager01/xaAliase']], [['serverName', 'localhost'], ['portNumber', 2638]])

createDataSourceUsingTemplateAtScope

Use a template to create a new data source in the configuration at the scope specified. The script returns the configuration ID of the new data source. To run the script, specify the scope, JDBC provider, template ID, and data source name arguments. We can optionally specify attributes.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JDBC provider.
jdbcProvider Name of the JDBC provider of interest.
templateID Configuration ID of the template to use to create the data source.
dsName Name to assign to the new data source.
attributes Additional attributes

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
authDataAlias Alias used for database authentication at run time. ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

category Category used to classify or group the resource. ['category', 'myCategory']
connectionPool JDBC connection pooling properties for the parent JDBC connection factory instance.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["connectionPool",[["agedTimeout","100"], ["connectionTimeout","1000"], ["freePoolDistributionTableSize",10], ["maxConnections","12"],["minConnections","5"], ["numberOfFreePoolPartitions","3"], ["numberOfSharedPoolPartitions","6"], ["numberOfUnsharedPoolPartitions","3"], ["properties",[["description","My description"], ["name","myName"],["required","false"],["type","String"], ["validationExpression",""],["value","myValue"]]], ["purgePolicy","EntirePool"],["reapTime","10000"], ["struckThreshold","3"],["struckTime","10"], ["struckTimerTime","10"],["surgeCreationInterval","10"], ["surgeThreshold","10"],["testConnection","true"], ["testConnectionInterval","10"], ["unusedTimeout","10000"]]]
datasourceHelperClassname DataStoreHelper implementation class that extends the capabilities of the implementation class of the JDBC driver. The extended capabilities allow the JDBC drive to perform functions specific to the data. com.ibm.websphere.rsadapter.DB2DataStoreHelper
com.ibm.websphere.rsadapter.DerbyDataStoreHelper
...
description Description of the data source. ['description', 'My description']
jndiName JNDI name for this data source. ['jndiName', 'myJndiName']
logMissingTransactionContext Specifies whether missing transaction context logging is enabled. ['logMissingTransactionContext', 'false']
manageCachedHandles Specifies whether this data source is used for container-managed persistence of enterprise beans. Default is true. ['manageCachedHandles', 'false']
mapping Mapping of the configuration login to a specified authentication alias name.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["mapping",[["authDataAlias","authDataAliasValue"], ["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["preTestConfig",[["preTestConnection", "true"], "retryInterval", "12343"],"retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
["properties",[["description","My description"], ["name", "myName"],"required","false"], ["type","String"],["validationExpression",""], "value','myValue"]]]
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[name databaseName][type string][value mys]] [name driverType][type integer][value 4]] [name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
relationalResourceAdapter Relational resource adapter that the data source uses. The available Java 2 Connector (J2C) resource adapter ID of J2CResourceAdapterID can be identified with the AdminConfig.list('J2CResourceAdapter') command. [relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1| resources.xml#builtin_rra)"]
statementCacheSize Number of statements that the product can cache for each connection. The product optimizes the processing of prepared statements and callable statements by caching statements that are not used in an active connection. Both statement types improve the performance of transactions between an application and a datastore. Caching the statements makes them more readily available. ['statementCacheSize', 5]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication. ['-xaRecoveryAuthAlias', 'myCellManager01/a1']

Attributes Description Example
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Using IBM JCC Driver']

Syntax

providerType optional attribute

Syntax
Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

AdminJDBC.createDataSourceUsingTemplateAtScope(nodeName, serverName, jdbcProvider, templateID, dsName, attributes)

Example

Required attributes only:

AdminJDBC.createDataSourceUsingTemplateAtScope("myNode", "myServer", "myJDBCProvider", "Derby JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_derby_1)", "myDataSource")

Optional attributes in a string format:

AdminJDBC.createDataSourceUsingTemplateAtScope("/Cell:MyCell/Node:MyNode01/Server:server1", "My JDBC Name2", "DB2 Universal JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_DB2_UNI_1)", "MyJDBCDS", "authDataAlias=cellManager01/myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, datasourceHelperClassname=com.ibm.websphere.rsadapter.DB2DataStoreHelper, description='My description', diagnoseConnectionUsage=true, jndiName=myJndiName, logMissingTransactionContext=false, manageCachedHandles=false, providerType='DB2 Using IBM JCC Driver', xaRecoveryAuthAlias=myCellManager01/xa1")

Optional attributes in a list format:

AdminJDBC.createDataSourceUsingTemplateAtScope("/Cell:MyCell/Node:MyNode01/Server:server1", "My JDBC Name2", "DB2 Universal JDBC Driver DataSource(templates/system|jdbc-resource-provider-templates.xml#DataSource_DB2_UNI_1)", "MyJDBCDS", [['authDataAlias', 'cellManager01/myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['connectionPool', [['agedTimeout', 100], ['connectionTimeout', 1000], ['freePoolDistributionTableSize', 10], ['maxConnections', 12], ['minConnections', 5], ['numberOfFreePoolPartitions', 3], ['numberOfSharedPoolPartitions', 6], ['numberOfUnsharedPoolPartitions', 3], ['properties', [[['name', 'name1a'], ['value', 'value1a']], [['name', 'name1b'], ['value', 'value1b']]]], ['purgePolicy', 'EntirePool'], ['reapTime', 10000], ['stuckThreshold', 3], ['stuckTime', 10], ['stuckTimerTime', 10], ['surgeThreshold', 10], ['testConnection', 'true']]], ['datasourceHelperClassname', 'com.ibm.websphere.rsadapter.DB2DataStoreHelper'], ['description', 'My description'], ['diagnoseConnectionUsage', 'true'], ['jndiName', 'myJndiName'], ['logMissingTransactionContext', 'false'], ['manageCachedHandles', 'false'], ['mapping', [['authDataAlias', 'anAlias'], ['mappingConfigAlias', 'anotherTest']]], ['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', 12343], ['retryLimit', 4]]], ['properties', [[['name', 'name1'], ['value', 'value1']], [['name', 'name2'], ['value', 'value2']]]], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'integer'], ['value', 50000]]]]]], ['providerType', 'DB2 Using IBM JCC Driver'], ['relationalResourceAdapter', 'SIB JMS Resource Adapter(cells/MyCell/clusters/c1|resources.xml#J2CResourceAdapter_1232911649746)'], ['statementCacheSize', 5], ['xaRecoveryAuthAlias', 'myCellManager01/xa1']] )

createJDBCProvider

Create a New JDBC provider in the environment. The script returns the configuration ID of the new JDBC provider. To run the script, specify the node name, server name, JDBC provider, and implementation class arguments. We can optionally specify attributes.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jdbcProvider Name to assign to the new JDBC provider.
implementationClass Name of the implementation class to use.
attributes Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths.
['-classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar']

description Description of the resource adapter. ['description', 'My description']
isolatedClassLoader If true, specify that the resource provider is loaded in its own class loader.
A provider cannot be isolatedClassLoader when a native library path is specified.
['isolatedClassLoader', 'false']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). ['-nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}']

Attributes Description Example
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[[name databaseName][type string][value mys]] [[name driverType][type integer][value 4]] [[name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Universal JDBC Driver Provider']
xa Possible values are true and false. If true, data sources for the provider produce connections that applications use in two-phase commit, global transactions. If set to false, the data sources produce connections that applications use in single-phase commit, local transactions. true false

Syntax

Implementation class optional attribute

Syntax
Find the implementationClassName attribute by specifying the JDBC provider template ID for JDBCProvID:
AdminConfig.showAttribute(JDBCProvID,'implementationClassName')
implementationClassName attribute example usage:
print AdminConfig.showAttribute("DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)", "implementationClassName")

Result:
com.ibm.db2.jcc.DB2XADataSource

Some possible implementation class names:

com.ibm.db2.jcc.DB2ConnectionPoolDataSource
com.ibm.db2.jcc.DB2XADataSource
com.ibm.db2.jdbc.app.UDBConnectionPoolDataSource
com.ibm.db2.jdbc.app.UDBXADataSource
com.ibm.as400.access.AS400JDBCConnectionPoolDataSource
com.ibm.as400.access.AS400JDBCXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource
org.apache.derby.jdbc.ClientXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource40
org.apache.derby.jdbc.ClientXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40
org.apache.derby.jdbc.EmbeddedXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource
org.apache.derby.jdbc.EmbeddedXADataSource
com.informix.jdbcx.IfxConnectionPoolDataSource
com.informix.jdbcx.IfxXADataSource oracle.jdbc.pool.OracleConnectionPoolDataSource
oracle.jdbc.xa.client.OracleXADataSource
com.sybase.jdbc3.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc3.jdbc.SybXADataSource
com.sybase.jdbc4.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc4.jdbc.SybXADataSource
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
com.ddtek.jdbcx.sqlserver.SQLServerDataSource

providerType optional attribute

Syntax

Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

AdminJDBC.createJDBCProvider(nodeName, serverName, jdbcProvider, implementationClass, attributes)

Example

Required attributes only:

AdminJDBC.createJDBCProvider("myNode", "myServer", "myJDBCProvider", "myImplementationClass")

Include optional attributes in a string format:
AdminJDBC.createJDBCProvider("MyNode01", "server1", "My JDBC Name", "com.ibm.db2.jcc.DB2ConnectionPoolDataSource", " classpath=${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar, description='My description', isolatedClassLoader=false, nativepath=${DB2_JCC_DRIVER_NATIVEPATH}, providerType='DB2 Univesal JDBC Driver Provider', xa=true ")

Include optional attributes in a list format:

AdminJDBC.createJDBCProvider("MyNode01", "server1", "My JDBC Name", "com.ibm.db2.jcc.DB2ConnectionPoolDataSource", [['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My description'], ['isolatedClassLoader', 'false'], ['nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}'], ['providerType', 'DB2 Univesal JDBC Driver Provider'], ['xa', 'true'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'Integer'], ['value', 50000]]]]]]])

createJDBCProviderUsingTemplate

Use a template to create a new JDBC provider in the environment. The script returns the configuration ID of the new JDBC provider. To run the script, specify the node name, server name, template ID, JDBC provider name, and implementation class arguments. We can optionally specify attributes:

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
templateID Configuration ID of the template to use to create the JDBC provider.
jdbcProvider Name to assign to the new JDBC provider.
implementationClass Name of the implementation class to use.
attributes Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. ['-classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar']
description Description of the resource adapter. ['description', 'My description']
isolatedClassLoader If true, specify that the resource provider is loaded in its own class loader.
A provider cannot be isolatedClassLoader when a native library path is specified.
['isolatedClassLoader', 'false']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). ['-nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}']

Attributes Description Example
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[[name databaseName][type string][value mys]] [[name driverType][type integer][value 4]] [[name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Universal JDBC Driver Provider']
xa Possible values are true and false. If true, data sources for the provider produce connections that applications use in two-phase commit, global transactions. If set to false, the data sources produce connections that applications use in single-phase commit, local transactions. true false

Syntax

Implementation class optional attribute

Syntax
Find the implementationClassName attribute by specifying the JDBC provider template ID for JDBCProvID:
AdminConfig.showAttribute(JDBCProvID,'implementationClassName')

implementationClassName attribute example usage:
print AdminConfig.showAttribute("DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)", "implementationClassName")

Result:
com.ibm.db2.jcc.DB2XADataSource

Some possible implementation class names:

com.ibm.db2.jcc.DB2ConnectionPoolDataSource
com.ibm.db2.jcc.DB2XADataSource
com.ibm.db2.jdbc.app.UDBConnectionPoolDataSource
com.ibm.db2.jdbc.app.UDBXADataSource
com.ibm.as400.access.AS400JDBCConnectionPoolDataSource
com.ibm.as400.access.AS400JDBCXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource
org.apache.derby.jdbc.ClientXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource40
org.apache.derby.jdbc.ClientXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40
org.apache.derby.jdbc.EmbeddedXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource
org.apache.derby.jdbc.EmbeddedXADataSource
com.informix.jdbcx.IfxConnectionPoolDataSource
com.informix.jdbcx.IfxXADataSource oracle.jdbc.pool.OracleConnectionPoolDataSource
oracle.jdbc.xa.client.OracleXADataSource
com.sybase.jdbc3.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc3.jdbc.SybXADataSource
com.sybase.jdbc4.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc4.jdbc.SybXADataSource
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
com.ddtek.jdbcx.sqlserver.SQLServerDataSource

providerType optional attribute

Syntax

Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

AdminJDBC.createJDBCProviderUsingTemplate(nodeName, serverName, templateID, jdbcProvider, implementationClass, attributes)

Example

Required attributes only:

AdminJDBC.createJDBCProviderUsingTemplate("myNode", "myServer", "Derby JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#JDBCProvider_1124467079638)", "myJDBCProvider", "myImplementationClass")

Include optional attributes in a string format:
AdminJDBC.createJDBCProviderUsingTemplate("MyNode01", "server1", "DB2 Universal JDBC Driver Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_1)", "My JDBC Name", "com.ibm.db2.jcc.DB2ConnectionPoolDataSource", "classpath= ${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar, description='My description', isolatedClassLoader=false, nativepath=${DB2_JCC_DRIVER_NATIVEPATH}, providerType='DB2 Univesal JDBC Driver Provider', xa=true ")

Include optional attributes in a list format:

AdminJDBC.createJDBCProviderUsingTemplate("MyNode01", "server1", "DB2 Universal JDBC Driver Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_1)", My JDBC Name", "com.ibm.db2.jcc.DB2ConnectionPoolDataSource", [['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My description'], ['isolatedClassLoader', 'false'], ['nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}'], ['providerType', 'DB2 Univesal JDBC Driver Provider'], ['xa', 'true'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'Integer'], ['value', 50000]]]]]]])

createJDBCProviderAtScope

Create a New JDBC provider in the environment at the scope specified. The script returns the configuration ID of the new JDBC provider. The script procedure uses the createJDBCProvider administrative command to create a new JDBC provider. The createJDBCProvider script procedure creates a new JDBC provider using the AdminConfig create command.

To run the script, specify the scope, JDBC provider, database type, provider type, and implementation types arguments. We can optionally specify attributes:

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JDBC provider.
databaseType Database type that this JDBC provider uses. Valid values include DB2, Derby, Informix, Oracle, Sybase, SQL Server, and user-defined values.
providerType The JDBC provider type that this JDBC provider uses.
implType The implementation type that this JDBC provider uses. Valid values are Connection pool datasource and XA data source.
jdbcProvider Name to assign to the new JDBC provider.
attributes
Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. ['-classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar']
description Description of the resource adapter. ['description', 'My description']
isolatedClassLoader If true, specify that the resource provider is loaded in its own class loader. A provider cannot be isolatedClassLoader when a native library path is specified. ['isolatedClassLoader', 'false']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). ['-nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}']

Attributes Description
implementationClassName The implementation class to use for a given JDBC provider template.

providerType optional attribute

Syntax

Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)
DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)
DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"
DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

implementationClassName attribute

Syntax

Find the implementationClassName attribute by specifying the JDBC provider template ID for JDBCProvID:
AdminConfig.showAttribute(JDBCProvID,'implementationClassName')

implementationClassName attribute example usage:
print AdminConfig.showAttribute("DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)", "implementationClassName")

Result:
com.ibm.db2.jcc.DB2XADataSource
Some possible implementation class names:

com.ibm.db2.jcc.DB2ConnectionPoolDataSource
com.ibm.db2.jcc.DB2XADataSource
com.ibm.db2.jdbc.app.UDBConnectionPoolDataSource
com.ibm.db2.jdbc.app.UDBXADataSource
com.ibm.as400.access.AS400JDBCConnectionPoolDataSource
com.ibm.as400.access.AS400JDBCXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource
org.apache.derby.jdbc.ClientXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource40
org.apache.derby.jdbc.ClientXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40
org.apache.derby.jdbc.EmbeddedXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource
org.apache.derby.jdbc.EmbeddedXADataSource
com.informix.jdbcx.IfxConnectionPoolDataSource
com.informix.jdbcx.IfxXADataSource oracle.jdbc.pool.OracleConnectionPoolDataSource
oracle.jdbc.xa.client.OracleXADataSource
com.sybase.jdbc3.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc3.jdbc.SybXADataSource
com.sybase.jdbc4.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc4.jdbc.SybXADataSource
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
com.ddtek.jdbcx.sqlserver.SQLServerDataSource

createJDBCProviderAtScope script

Syntax

AdminJDBC.createJDBCProviderAtScope(scope, jdbcProvider, databaseType, providerType, implementationType, attributes)

Example

Required attributes only:

AdminJDBC.createJDBCProviderAtScope("myScope", "myJDBCProvider", "myDatabaseType","myProviderType", "myImplementationClass")

Include optional attributes in a string format:
AdminJDBC.createJDBCProviderAtScope("/Cell:MyCell/Node:MyNode01", "DB2", "DB2 Universal JDBC Driver Provider", "Connection pool data source", "My JDBCProvider Name", "description='My description', implementationClassName=com.ibm.db2.jcc.DB2ConnectionPoolDataSource, classpath=${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar, nativePath=${DB2_JCC_DRIVER_NATIVEPATH}, isolatedClassLoader=false")

Include optional attributes in a list format:

AdminJDBC.createJDBCProviderAtScope("/Cell:MyCell/Node:MyNode01", "DB2", "DB2 Universal JDBC Driver Provider", "Connection pool data source", "My JDBCProvider Name", [['description', 'My description'], [ 'implementationClassName ', 'com.ibm.db2.jcc.DB2ConnectionPoolDataSource'], [ 'classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], [ 'nativePath', '${DB2_JCC_DRIVER_NATIVEPATH}'], ['isolatedClassLoader', 'false'] ])

createJDBCProviderUsingTemplateAtScope

Create a new JDBC provider in the environment at the scope specified. The script returns the configuration ID of the new JDBC provider. To run the script, specify the scope, template ID, JDBC provider name, and implementation class arguments. We can optionally specify attributes:

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JDBC provider.
templateID Configuration ID of the template to use to create the JDBC provider.
jdbcProvider Name to assign to the new JDBC provider.
implementationClassName Name of the implementation class to use.
attributes Optionally specify additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. ['-classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar']
description Description of the resource adapter. ['description', 'My description']
isolatedClassLoader If true, specify that the resource provider is loaded in its own class loader. A provider cannot be isolatedClassLoader when a native library path is specified. ['isolatedClassLoader', 'false']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). ['-nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}']

Attributes Description Example
propertySet Optionally specify resource properties in the following format:
[propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]]
When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.
[propertySet [[resourceProperties [[[name databaseName][type string][value mys]] [[name driverType][type integer][value 4]] [[name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
providerType The JDBC provider type that this JDBC provider uses. ['providerType', 'DB2 Universal JDBC Driver Provider']
xa Possible values are true and false. If true, data sources for the provider produce connections that applications use in two-phase commit, global transactions. If set to false, the data sources produce connections that applications use in single-phase commit, local transactions. true|false

Implementation class optional attribute

Syntax

Find the implementationClassName attribute by specifying the JDBC provider template ID for JDBCProvID:

AdminConfig.showAttribute(JDBCProvID,'implementationClassName')

implementationClassName attribute example usage:

print AdminConfig.showAttribute("DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)", "implementationClassName")

Result:
com.ibm.db2.jcc.DB2XADataSource

Some possible implementation class names:

com.ibm.db2.jcc.DB2ConnectionPoolDataSource
com.ibm.db2.jcc.DB2XADataSource
com.ibm.db2.jdbc.app.UDBConnectionPoolDataSource
com.ibm.db2.jdbc.app.UDBXADataSource
com.ibm.as400.access.AS400JDBCConnectionPoolDataSource
com.ibm.as400.access.AS400JDBCXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource
org.apache.derby.jdbc.ClientXADataSource
org.apache.derby.jdbc.ClientConnectionPoolDataSource40
org.apache.derby.jdbc.ClientXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40
org.apache.derby.jdbc.EmbeddedXADataSource40
org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource
org.apache.derby.jdbc.EmbeddedXADataSource
com.informix.jdbcx.IfxConnectionPoolDataSource
com.informix.jdbcx.IfxXADataSource oracle.jdbc.pool.OracleConnectionPoolDataSource
oracle.jdbc.xa.client.OracleXADataSource
com.sybase.jdbc3.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc3.jdbc.SybXADataSource
com.sybase.jdbc4.jdbc.SybConnectionPoolDataSource
com.sybase.jdbc4.jdbc.SybXADataSource
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
com.microsoft.sqlserver.jdbc.SQLServerXADataSource
com.ddtek.jdbcx.sqlserver.SQLServerDataSource

providerType optional attribute

Syntax

Find the JDBC provider type name. Only JDBC provider template IDs that contain the templates/system|jdbc-resource-provider-templates.xml substring have valid JDBC Provider type names. The JDBC provider type name and its substring form the JDBC provider template ID.
AdminConfig.listTemplates('JDBCProvider')

Example partial result showing the JDBC provider template ID for the JDBC provider type name of Derby JDBC Provider (XA):
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

Some JDBC provider template IDs:
Derby JDBC Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)

DB2 Legacy CLI-based Type 2 JDBC Driver (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_4)

DB2 UDB for iSeries (Native - V5R1 and earlier) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_db2400_5)"

DB2 Universal JDBC Driver Provider (XA) (templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_2)

createJDBCProviderUsingTemplateAtScope script

Syntax

AdminJDBC.createJDBCProviderUsingTemplateAtScope(scope, templateID, jdbcProvider, implementationClass, attributes)

Example

Required attributes only:

AdminJDBC.createJDBCProviderUsingTemplateAtScope("myScope", "Derby JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#JDBCProvider_1124467079638)", "myJDBCProvider", "myImplementationClass")

Include optional attributes in a string format:
AdminJDBC.createJDBCProviderUsingTemplateAtScope("/Cell:MyCell/ServerCluster:cluster1", "DB2 Universal JDBC Driver Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_1)", "My JDBC Name001", " com.ibm.db2.jcc.DB2ConnectionPoolDataSource", "classpath= ${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar, description='My description', isolatedClassLoader=false, nativepath=${DB2_JCC_DRIVER_NATIVEPATH}, providerType='DB2 Univesal JDBC Driver Provider', xa=true ")

Include optional attributes in a list format:

AdminJDBC.createJDBCProviderUsingTemplateAtScope("/Cell:MyCell/ServerCluster:cluster1", "DB2 Universal JDBC Driver Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_DB2_UNI_1)", "My JDBC Name001", " com.ibm.db2.jcc.DB2ConnectionPoolDataSource", [['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My description'], ['isolatedClassLoader', 'false'], ['nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}'], ['providerType', 'DB2 Univesal JDBC Driver Provider'], ['xa', 'true'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'integer'], ['value', 4]], [['name', 'serverName'], ['type', 'String'], ['value', 'localhost']], [['name', 'portNumber'], ['type', 'Integer'], ['value', 50000]]]]]]])

See also

Use the script library to automate the application serving environment
Automating data access resource configuration
JDBC query scripts
JMS query scripts
JMS configuration scripts
J2C configuration scripts
J2C query scripts

Scope	Containment path	Configuration ID	Type
Cell	/Cell:myCell/	myCell(cells/myCell\|cell.xml#Cell_1)	Cell=myCell cell=myCell
Node	/Cell:myCell/Node:myNode/ /Node:myNode/	myNode(cells/myCell/nodes/myNode\|node.xml#Node_1)	Cell=myCell, Node=myNode Cell=myCell:Node=myNode cell=myCell, node=myNode
Server	/Cell:myCell/Node:myNode/Server:myServer/ /Node:myNode/Server:myServer/	myServer(cells/myCell/nodes/myNode/servers/myServer\|server.xml#Server_1)	Cell=myCell, Node=myNode, Server=myServer Node=myNode:Server=myServer cell=myCell, Node=myNode, Server=myServer
Cluster	Cell:myCell/ServerCluster:myCluster/ /ServerCluster:myCluster/	myCluster(cells/myCell/clusters/myCluster\|cluster.xml#ServerCluster_1)	Cell=myCell, Cluster=myCluster Cell=myCell:Cluster=myCluster cell=myCell, Cluster=myCluster

Argument	Description
nodeName	Node of interest.
serverName	Server of interest.
jdbcProvider	JDBC provider of interest.
dsName	Name to assign to the new data source.
attributes	Optionally specify additional attributes in a particular format: List format [["attr1", "value1"], ["attr2", "value2"]] String format "attr1=value1, attr2=value2"

Attributes	Description	Example
authDataAlias	Alias used for database authentication at run time.	['authDataAlias', 'myAuthDataAlias']
authMechanismPreference	Authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.
category	Category used to classify or group the resource.	['category', 'myCategory']
connectionPool	JDBC connection pooling properties for the parent JDBC connection factory instance. When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.	["connectionPool",[["agedTimeout","100"], ["connectionTimeout","1000"], ["freePoolDistributionTableSize",10], ["maxConnections","12"],["minConnections","5"], ["numberOfFreePoolPartitions","3"], ["numberOfSharedPoolPartitions","6"], ["numberOfUnsharedPoolPartitions","3"], ["properties",[["description","My description"], ["name","myName"],["required","false"],["type","String"], ["validationExpression",""],["value","myValue"]]], ["purgePolicy","EntirePool"],["reapTime","10000"], ["struckThreshold","3"],["struckTime","10"], ["struckTimerTime","10"],["surgeCreationInterval","10"], ["surgeThreshold","10"],["testConnection","true"], ["testConnectionInterval","10"], ["unusedTimeout","10000"]]]
datasourceHelperClassname	DataStoreHelper implementation class that extends the capabilities of the implementation class of the JDBC driver. The extended capabilities allow the JDBC drive to perform functions specific to the data.	com.ibm.websphere.rsadapter.DB2DataStoreHelper com.ibm.websphere.rsadapter.DerbyDataStoreHelper ...
description	Description of the data source.	['description', 'My description']
jndiName	JNDI name for this data source.	['jndiName', 'myJndiName']
logMissingTransactionContext	Specifies whether missing transaction context logging is enabled.	['logMissingTransactionContext', 'false']
manageCachedHandles	Specifies whether this data source is used for container-managed persistence of enterprise beans. Default is true.	['manageCachedHandles', 'false']
mapping	When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.	["mapping",[["authDataAlias","authDataAliasValue"], ["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig	Pretest connection configuration settings. When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.	["preTestConfig",[["preTestConnection", "true"], "retryInterval", "12343"],"retryLimit", "4"]]]
properties	Specifies either a typed property type or a descriptive property type. When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.	["properties",[["description","My description"], ["name", "myName"],"required","false"], ["type","String"],["validationExpression",""], "value','myValue"]]]
propertySet	Optionally specify resource properties in the following format: [propertySet[[resourceProperties[[[name₁ nameValue₁][type₁ typeValue₁][value₁ valueValue₁]]... [[name_n nameValue_n][type_n typeValue_n][value_n valueValue_n]] ]]]] When using this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type.	[propertySet [[resourceProperties [[name databaseName][type string][value mys]] [name driverType][type integer][value 4]] [name serverName][type string][value localhost]] [[name portNumber][type integer][value 50000]] ]]]]
relationalResourceAdapter	Relational resource adapter that the data source uses. The available Java 2 Connector (J2C) resource adapter ID of J2CResourceAdapterID can be identified with the AdminConfig.list ('J2CResourceAdapter') command.	[relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1\| resources.xml#builtin_rra)"]
statementCacheSize	Number of statements that the product can cache for each connection. The product optimizes the processing of prepared statements and callable statements by caching statements that are not used in an active connection. Both statement types improve the performance of transactions between an application and a datastore. Caching the statements makes them more readily available.	['statementCacheSize', 5]
xaRecoveryAuthAlias	Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.	['-xaRecoveryAuthAlias', 'myCellManager01/a1']

Argument	Description
nodeName	Name of the node of interest.
serverName	Name of the server of interest.
jdbcProvider	Name of the JDBC provider of interest.
templateID	Configuration ID of the template to use to create the data source.
dsName	Name to assign to the new data source.
attributes	Optionally specify additional attributes in a particular format: List format [["attr1", "value1"], ["attr2", "value2"]] String format "attr1=value1, attr2=value2"

Argument	Description
scope	Specifies a scope of cell, node, server, or cluster for the JDBC provider.
JDBCName	Name of the JDBC provider of interest.
datasourceName	Name to assign to the new data source.
jndiName	JNDI name for this data source.
dataStoreHelperClassName	DataStoreHelper implementation class that extends the capabilities of the selected JDBC driver implementation class to perform data-specific functions.
dbName (URL for the Oracle database)	Name to assign the database for the JDBC provider. For a JDBC provider that uses the Oracle database, the argument specifies the URL of the database from which the datasource obtains connections. Examples are jdbc:oracle:thin:@localhost:1521:sample for a thin driver and jdbc:oracle:oci8:@sample for a thick driver.
description	Description of the data source.
otherAttributes	Additional attributes in a particular format: List format [["attr1", "value1"], ["attr2", "value2"]] String format ue2"
resoureAttributes	Attributes in a particular format: List format [["attr1", "value1"], ["attr2", "value2"]] String format "attr1=value1, attr2=value2"
failonerror	Administrative utilities that process an error condition.

Attributes	Description
category	Classify or group the resource.
componentManagedAuthenticationAlias	Alias used for database authentication at runtime.
containerManagedPersistence	When true container managed persistence is enabled
description	Description of the data source.
xaRecoveryAuthAlias	Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

Attributes	Description
driverType	Data source type. The data source type is valid only for JDBC providers that have a database type of DB2.
portNumber	Port number of the database server. The port number is valid only for JDBC providers that have a database type of DB2, Informix, Sybase, or SQLServer.
serverName	Host name of the database server or IP address. The server name is valid only for JDBC providers that have a database type of DB2, Informix, Sybase, or SQLServer.
ifxIFHOST	Connection wait time for obtaining a lock on the database. By default, the Informix database returns an error when it cannot acquire a lock, rather than wait for the current owner of the lock to release it. To modify the behavior, set the property to the number of seconds to wait for a lock. The default is 2 seconds. Any negative value translates into an unlimited wait time. This attribute is valid only for JDBC providers that have a database type of Informix.
informixLockModeWait	Physical machine name of the server hosting the Informix instance. We can enter a host name or IP address. We can also enter an Internet Protocol v6 (IPv6) if the host database supports it. This attribute is valid only for JDBC providers that have a database type of Informix.

Attributes	Description	Example
classpath	List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths.	['-classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; ${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar']
description	Description of the resource adapter.	['description', 'My description']
isolatedClassLoader	If true, specify that the resource provider is loaded in its own class loader. A provider cannot be isolatedClassLoader when a native library path is specified.	['isolatedClassLoader', 'false']
nativepath	Specifies an optional path to any native libraries, such as .dll and .so. Native path entries are separated by a semicolon (;).	['-nativepath', '${DB2_JCC_DRIVER_NATIVEPATH}']

Argument	Description
scope	Specifies a scope of cell, node, server, or cluster for the JDBC provider.
databaseType	Database type that this JDBC provider uses. Valid values include DB2, Derby, Informix, Oracle, Sybase, SQL Server, and user-defined values.
providerType	The JDBC provider type that this JDBC provider uses.
implType	The implementation type that this JDBC provider uses. Valid values are Connection pool datasource and XA data source.
jdbcProvider	Name to assign to the new JDBC provider.
attributes	Optionally specify additional attributes in a particular format: List format [["attr1", "value1"], ["attr2", "value2"]] String format "attr1=value1, attr2=value2"