Configuration Descriptor: Database

This key contains the bundle name of the property file that contains the configuration specific to Database connectivity:

Config Key

Mandatory/ Optional

Type

Purpose

CT_FW_IBATIS_DATASOURCE_KEY

Mandatory

String

This key is used to provide the iBatis data source key for CT framework.

CT_FW_DATASOURCE

Mandatory

String

This key is used to provide data source that must be used by the CT framework for connecting to its data model.

CT_FW_DATABASE_VENDOR

Mandatory

String

This key is used to provide the database vendor for which vendor-specific-scripts will be loaded. The possible valid values for this option are:

  • oracle
  • mssql

This is used for switching the underlying database between Oracle or Microsoft SQL Server where the users and objects related to Canvas framework are created.

DATASOURCE_NAME

Mandatory

String

This key is used to provide the name of the implementation data source.

PROVIDER_URL

Mandatory

String

This key is used to provide the provider URL.

JNDI_FACTORY

Mandatory

String

This key is used to provide the default JNDI API for data source connection.The value must be org.apache.naming.NamingContext

CT_IBATIS_DATASOURCE_KEYS

Mandatory

Comma separated String

This key provides the list of Logical data sources that the application wishes to use. You must ensure to not include the Data Source name provided under the key CT_FW_IBATIS_DATASOURCE_KEY.

In order to use the external data source, you have to define the data source key in this property and add two additional keys for the configuration. Refer Fetching Data from a Schema Different from Implementation Schema for more information.

CT_MODEL_HOUSE_DSXML

Mandatory

Resource Path

For every data source configured under CT_IBATIS_DATASOURCE_KEYS, it is expected that the iBatis configuration XML that corresponds to this Logical data source is pointed out here.

CT_DEFAULT_IBATIS_DATASOURCE_KEY

Mandatory

String

This is the Logical data source that must be taken as the default by the framework whenever a developer tries to execute a Database request without explicitly providing the Logical Data Source. This must be one of the data sources defined under the key CT_IBATIS_DATASOURCE_KEYS.

USER_TXN_NAME.JNDIName

Mandatory

String

This key is used to provide the JNDIName for the user transaction that is getting created.

Note

The USER_TXN_NAME.JNDIName must be specified in databaseconfig.properties file, in accordance with the respective application server being used. The sample values for Tomcat, JBoss, WebLogic and WebSphere application servers are provided as follows: 

# For Tomcat
USER_TXN_NAME.JNDIName = java:comp/UserTransaction

# For JBoss 
USER_TXN_NAME.JNDIName = java:jboss/UserTransaction

# For WebLogic
USER_TXN_NAME.JNDIName = java:comp/UserTransaction

# For WebSphere 
USER_TXN_NAME.JNDIName = java:comp/UserTransaction

REMOTE_TXN_NAME.JNDIName

Mandatory

String

This key is used to provide the JNDIName for the remote user transaction that is getting created.

CT_MYBATIS_DATASOURCEOptionalStringThis key is needed in case of MyBatis usage to indicate the name of the implementation data source.
CT_MYBATIS_CONFIG_XMLOptionalResource PathThis key is needed in case of MyBatis usage to indicate the configuration XML that corresponds to the Logical data source.


The following is a sample data base configuration databaseconfig.properties (as per the name given in the default descriptor):

# The FW Datasource key, framework datasource name and database vendor.
#######################################################################
CT_FW_IBATIS_DATASOURCE_KEY = CT_DS

# The data source that should be used by the CT framework for connecting to 
# its data model.
# CT_FW_DATASOURCE = java:/comp/env/jdbc/OraSource
CT_FW_DATASOURCE = java:/OraSource

# The database vendor for which vendor specific scripts will be loaded.
#CT_FW_DATABASE_VENDOR = mysql
# CT_FW_DATABASE_VENDOR = db2
#CT_FW_DATABASE_VENDOR = mssql
CT_FW_DATABASE_VENDOR = oracle 

#######################################################################
# The Impl Datasource key Name
#######################################################################

#WebLogic
#DATASOURCE_NAME = ImplOraSource
#PROVIDER_URL = localhost:7001
#JNDI_FACTORY = weblogic.jndi.WLInitialContextFactory

#######################################################################

#JBOSS
# DATASOURCE_NAME = java:/comp/env/jdbc/ImplOraSource
DATASOURCE_NAME = java:/ImplOraSource
PROVIDER_URL = localhost:9080
JNDI_FACTORY = org.apache.naming.NamingContext

#######################################################################
# The Impl Datasource keys and its corresponding iBATIS SQL MAP file.
#######################################################################

#CT_IBATIS_DATASOURCE_KEYS =
#[CT_IBATIS_DATASOURCE_KEY]_DSXML =
CT_IBATIS_DATASOURCE_KEYS = CT_MODEL_HOUSE 
CT_MODEL_HOUSE_DSXML = com/intellectdesign/modelhouse/database/ibatis/config/CTIMPLDatabaseConfig.xml
 
#######################################################################
# The default iBATIS datasource key for the implementation SQL MAP file.
#######################################################################
CT_DEFAULT_IBATIS_DATASOURCE_KEY=CT_MODEL_HOUSE 
#######################################################################
# The JNDIName for the user transaction which is getting created.
#######################################################################

USER_TXN_NAME.JNDIName = java:comp/UserTransaction
REMOTE_TXN_NAME.JNDIName = java:comp/UserTransaction

CT_MYBATIS_DATASOURCE = java:/ModelHouse
CT_MYBATIS_CONFIG_XML = com/intellectdesign/modelhouse/database/mybatis/config.xml