odbc.ini type

Use the odbc.ini type to create configurations that the integration server or integration runtime can use for an Open Database Connectivity (ODBC) connection to a database.

ODBC is a common standard that is used to connect to databases. IBM® App Connect includes ODBC libraries with ODBC drivers, which you can use to configure an ODBC connection for a database.


Summary of key details for the configuration type

File name or type Contains secrets Path extracted/imported to Maximum allowed per integration server or integration runtime
odbc.ini No /home/aceuser/ace-server/odbc.ini 1

About the odbc.ini file

The odbc.ini type requires an odbc.ini file that the integration server or integration runtime can use. This file is made up of stanzas (or sections) that contain settings in the format key=value for connecting to user-specific data sources:

  1. [ODBC Data Sources] stanza

    Lists the data source name (DSN) and associated description of each database.

  2. [DSN] stanzas

    Requires a stanza for each DSN that is listed in the [ODBC Data Sources] stanza. Each DSN stanza defines the ODBC driver and other necessary database settings, which can vary based on the database manager.

  3. [ODBC] stanza

    Lists mandatory information.

Note: Ensure that your odbc.ini file contains the correct path to ODBC drivers.
  • IBM App Connect Enterprise 12 is installed into /opt/ibm/ace-12, so if you want to apply an ODBC configuration to an integration server or integration runtime at version 12.0.1.0-r1 or later, you must update all the driver path properties in the odbc.ini file to point to this path. For example:

    DRIVER=/opt/ibm/ace-12/server/ODBC/dsdriver/odbc_cli/clidriver/lib/libdb2o.so

  • IBM App Connect Enterprise 11 is installed into /opt/ibm/ace-11, so if you want to apply an ODBC configuration to an integration server at version 11.0.0.F-rX (or rX-eus), you must update all the driver path properties in the odbc.ini file to point to this path.

To help you complete your odbc.ini file with the necessary settings for a database vendor, see Connecting to a database from Linux® and UNIX systems by using the IBM Integration ODBC Database Extender in the IBM App Connect Enterprise documentation. The procedure in this topic provides information about the stanza entries that are applicable for different database managers and includes examples of these entries.

A sample odbc.ini file is provided in the attached .zip file archive for reference: odbc.zip.

Only one odbc.ini file can be specified per integration server or integration runtime. (The file is placed in the integration server or integration runtime work directory for use by the integration server or integration runtime when it starts.)

For examples of how to use this configuration type, see Tutorials and examples.

Creating a configuration for the odbc.ini type by using the configuration panel

You can create an odbc.ini-type configuration while creating an integration server or integration runtime, or independently, as follows:

  1. Open the Configuration page by clicking the Configuration icon Configuration icon in the navigation pane, or go to the Configuration view of an integration server or integration runtime that you are creating. Then, click Create configuration. For more information, see Managing configuration objects from the Configuration page.
  2. From the Create configuration panel, select odbc.ini from the Type list.
  3. In the Name field, specify a name for this configuration.
  4. In the Description field, specify text that will help you identify the integration server or integration runtime that will use this odbc.ini file when connecting to a database.
    Create configuration panel
  5. Complete the odbc.ini section by completing either of the following steps:
    • Copy the contents of an existing odbc.ini file and then paste it into the odbc.ini text editor.
      odbc.ini text editor with pasted contents
    • Import a valid odbc.ini file from your file system:
      1. Click the Import odbc file icon Import icon.
      2. Click within the boxed area to select the file from a file browser, or drag-and-drop the file.
        Import odbc.ini view

        The content of the odbc.ini file is displayed.

        odbc.ini text editor with pasted contents
  6. Click Create. The configuration is added to the configurations table and can be selected for use with an integration server or integration runtime.

Updating or deleting a configuration

If you need to update the content or settings in a configuration, or delete a configuration that's no longer needed, see Managing configuration objects from the Configuration page.