Creating a database definition (.dbm file) by using the New Database Definition File wizard

Use the New Database Definition File wizard to add database definitions to the IBM® App Connect Enterprise Toolkit.

Before you begin

Note: Your database server must be configured to listen on a static port; dynamic ports are not supported with the New Database Definition File wizard. Contact your database administrator for information on how to verify port configuration.

About this task

A database definition file holds the physical data model that details all the database resources, such as the schema, the tables, and other resources, that you need access to.

If you can connect to your database server by using the IBM App Connect Enterprise Toolkit, you can create a database definition (.dbm file) when you create your database mapping. For more information, see Mapping database content.

If you cannot connect to your database server by using the IBM App Connect Enterprise Toolkit, you must create a database definition file from scratch before you can create your database mapping. For more information, see Creating a database definition from scratch.

You can also use database definitions in other nodes, such as the Compute node, to validate references to database sources and tables. You must include a data design project in an application, or reference it from an Integration project, before you can use the database definitions that your data design project contains.

Database definition files in the IBM App Connect Enterprise Toolkit are not automatically updated. If you modify your database, you must re-create the database definition files.

Complete the following steps to create a database definition (.dbm file) by using the New Database Definition File wizard:

Procedure

  1. Click File > New > Database Definition.
    The New Database Definition File wizard is displayed.
  2. Select an existing data design project, or click New to create a data design project.
  3. From the Database drop-down list, select the type of database that you want to model and, if applicable, select the Version. Click Next.
    Important: Ensure that you select a database from the list that is supported by IBM App Connect Enterprise; you can use this wizard in a shell-share environment with other Rational® products that support other databases or versions. For a list of databases supported by IBM App Connect Enterprise, see IBM App Connect Enterprise requirements.

    If your database is supported by IBM App Connect Enterprise, but is not included in the list of selectable databases, you might need to create a database definition from scratch; see Creating a database definition from scratch.

    When using specific database servers, you might need to set the paths of your JDBC JAR files before you can use them with the New Database Definition File wizard. To set the paths of your JDBC JAR files:

    1. Click Window > Preferences.
      The Preferences window opens.
    2. Expand Data ManagementConnectivityDriver Definitions.
    3. In the Driver Definitions pane, select the database server that you want to connect to, and click Edit....
      The Edit Driver Definition window opens.
    4. Select the JAR List tab, and click Add JAR/Zip....
    5. Browse to the JDBC JAR file that was supplied with your database product, select the JAR file, and then click Open.
      The Edit Driver Definition window closes.
    6. In the Preferences window, click OK to close the window, and return to the New Database Definition File wizard.
  4. Select a connection to use from the list of existing connections, or click New to create a database connection.
    If you select to use an existing connection, the existing database definition is overwritten.
  5. If you selected to create a connection:
    1. Optional: If you want to enter a custom value for the Connection Name, clear Use default naming convention.
    2. Enter values for the Connection to the database, for example, Database name, Host name and Port number.
    3. Enter values for the User ID and Password to connect to the database.
      Click Test Connection to verify the settings that you selected for your database. The default Port number for a DB2® database is 50000.
    4. Click Next.
      If your data design project already contains a database definition for the database that you selected, and you want to overwrite this database definition, click Yes in the Confirm file overwrite window.
      Tip: If you cannot connect to your database by using the New Database Definition File, you might need to create you database definition from scratch; see Creating a database definition from scratch.
  6. Alternatively, if you selected to use an existing connection:
    1. To overwrite the existing database definition, click Yes in the Confirm file overwrite dialog.
    2. Enter values for the User ID and Password to connect to the database, and then click Next.
  7. Select one or more database schemas from the list and click Next.
    When you create a database definition for use in a graphical data map called from a Mapping node, the database schema name that is displayed in the map is the one that you select here, but might be overridden by the corresponding JDBC Providers policy.
  8. Select the elements that you require on the Database Elements page.
    You can select any option, in addition to Tables, on the Database Elements page.
    1. Select Views to see all the database views in the Data Project Explorer
    2. Select Routines to add stored procedures and user-defined functions to the database definition file.

    If you select additional options, the database definition files that you create contain more information than the Compute, Database, or Mapping nodes require.

  9. Click Finish.

Results

A new database definition (.dbm file) is added to your data design project. If you opened the New Database Definition File wizard while creating a database transform in the graphical data mapping editor, you are returned to the database transform wizard.

What to do next

Before you can use your database definition in a messaging solution, you must complete one of the following tasks: