Configuring connection types: ConnectionTypes element
The ConnectionTypes element has one or more child elements called ConnectionType. Each ConnectionType element specifies how the Integration service connects to a database. You define a name for each connection type using the Name attribute.
The ConnectionType element has two child elements:
The JDBCDriver element contains information used to create JDBC connections. This element has one attribute, DriverName, as shown in Table 8‑1. The JDBCDriver element has three child elements, ConnectionString, ConnectionProperties, and LibraryPath, as shown in Table 8‑2.
Table 8‑1 Attribute of the JDBCDriver element
Attribute
Description
Required
DriverName
Class name of the JDBC driver, for example com.mysql.jdbc.MySQLDriver.
Yes
Table 8‑2 Child elements of the JDBCDriver element
Element
Description
Required
ConnectionString
JDBC connection string syntax. Do not include user name and password.
Yes
Connection Properties
User name and password properties.
Yes
LibraryPath
Paths to search for libraries used by the JDBC driver. Use a separate Location element for each path.
Yes
ConnectionString element
The JDBCDriver element has a ConnectionString child element, for example:
The ConnectionString element provides a template for the JDBC connection string. The parameters enclosed in percent signs (%), for example %server%, are placeholders for the values you type on the Data source connection properties page, shown in Figure 8‑1, when you create a data connection definition. These values are retrieved from the data connection definition (DCD) file when the Integration service creates a connection.
You can exclude a portion of a connection string when no value is provided for a connection parameter by enclosing it in double brackets ( [ [...] ] ). In the following example, to exclude the IANAAppCodePage parameter from the connection string when the value is left blank, define the ConnectionString element as follows:
[ [IANAAppCodePage : CODEPAGE=%IANAAppCodePage%] ] is not included in the connection string unless the IANAAppCodePage parameter is set.
To include the following literal characters in a ConnectionString element, precede the character with a backslash (\):
\
%
[ [
] ]
++
ConnectionType child element: CatalogFilter
The CatalogFilter element filters catalogs returned by the JDBC driver when the IO Design perspective displays a list of tables, views, or stored procedures in the New Maps dialog. By default, all catalogs are returned. Like the template for the JDBC connection string, the catalog filter can contain placeholders for the values of connection parameters, for example:
<CatalogFilter>%database%</CatalogFilter>
ConnectionType child element: ConnectionParams
The ConnectionParams element defines the parameters that are used in the ConnectionString element. The ConnectionParams element has a single child element, ConnectionParam. Here is an example of a ConnectionParam element that defines the server parameter:
<ConnectionParam Name="server"
Display="Server"
Type="String"
DefaultValue="end2243"
Optional="true"
ValueIsCaseSensitive="false">
</ConnectionParam>
One ConnectionParam element is required for each parameter. Each ConnectionParam element has the attributes shown in Table 8‑3.
Table 8‑3 Attributes of the ConnectionParam element
Attribute
Description
Required?
Default value
Name
Name of the connection parameter. This attribute is case-insensitive.
Yes
Display
Display name that appears on the Data source connection properties page in the IO Design perspective.
Yes
Type
Connection parameter type. Must be one of the following:
String
Boolean
Integer
Masked (Use for a string whose value should be hidden, such as a password.)
Yes
DefaultValue
Default value of the parameter.
No
Optional
Specifies whether a parameter is optional.
No
True
ValueIsCaseSensitive
Specifies whether the parameter value is case‑sensitive. Used when comparing two DCD files to see if they are equivalent.
No
True
Configuring database types: DatabaseTypes element
The DatabaseTypes element has one or more child elements called DatabaseType. Each DatabaseType element specifies the connection type and mapping for a database type. Several database types can use the same connection type, provided they use similar JDBC drivers, or the same mapping. For example, two different versions of a MySQL Enterprise database can use the same connection type.
Here is an example of a DatabaseTypes element:
<DatabaseTypes>
<DatabaseType Name="MySQL4"
ConnectionType="MySQL"
DataSourceMapping="MySQL4" />
<DatabaseType Name="Ingres"
ConnectionType="Ingres"
DataSourceMapping="Ingres" />
</DatabaseTypes>
Each DatabaseType element has the attributes shown in Table 8‑4.
Table 8‑4 Attributes of the DatabaseType element
Attribute
Description
Required?
Name
Name of the database type.
Yes
DisplayName
Display name for the database type in the New Data Connection Definition dialog in the IO Design perspective.
No
ConnectionType
Name of the connection type to use with this database type. The connection type is configured using the ConnectionType element.
Yes
DataSourceMapping
Directory where the mappings.xml file is located. This directory must be in the $AC_SERVER_HOME/etc /data_integration and <BDPro_HOME>\eclipse \plugins \com.actuate.ais.embeddable _<version>\Config\aisconfigfiles \etc\data_integration directories.
No. If not specified, the Integration service uses the mappings.xml file in the Generic_ODBC directory.
If you set this attribute to No_Mappings, all operations are executed by the Integration service executor.
JDBCDriver