# IBM DB2 ODBC

This article outlines the integration with IBM DB2 ODBC, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and manual lineage building. It also ensures secure authentication via Credential Manager.

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2F80dPkVlq9xDhK9xx48dx%2Fimage.png?alt=media&#x26;token=4e4492bf-92b4-4d98-8f22-663a021a3ea4" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                               | RDBMS            |
| -------------------------------------------------------------------------------- | ---------------- |
| Connector Version                                                                | Release7.1.1     |
| Releases Supported (Available from)                                              | Legacy Connector |
| <p>Connectivity</p><p>\[How the connection is established with RDBMS System]</p> | ODBC driver      |

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ✅      |
| Query Sheet                                  |       ✅      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from IBM DB2 ODBC and mapped to the corresponding UI assets.

<table><thead><tr><th width="170.6666259765625">DB2 ODBC Object</th><th width="190.6666259765625">DB2 ODBC Attribute</th><th width="186.333251953125">OvalEdge Attribute</th><th width="186.3333740234375">OvalEdge Category</th><th width="166.3333740234375">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>Schema name</td><td>schema</td><td>Databases</td><td>Schema</td></tr><tr><td>Table</td><td>TabName</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table Type</td><td>Type</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table Comments</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>Col Name</td><td>Column</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Type Name</td><td>Column Type</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Length</td><td>Data Type Size</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Views</td><td>View Name</td><td>View</td><td>Tables</td><td>view</td></tr><tr><td>Views</td><td>text</td><td>View Query</td><td>Views</td><td>View</td></tr><tr><td>Procedures</td><td>Routine_Name</td><td>Name</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Procedures</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Procedures</td></tr><tr><td>Procedures</td><td>Routine_Definition</td><td>Procedure</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Functions</td><td>Routine_Name</td><td>Name</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Routine_Definition</td><td>Function</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Functions</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**Whitelisting Ports**

Ensure the inbound port is whitelisted for OvalEdge to connect to the IBM DB2 ODBC database.

{% hint style="warning" %}
If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and IBM DB2 ODBC  is properly established.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻 Who can provide these permissions? These permissions are typically granted by the Microsoft SQL Server administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Objects                | System Tables                         | Access Permission |
| ---------------------- | ------------------------------------- | ----------------- |
| Schema                 | Sysibm.Sysschemata                    | Select            |
| Tables                 | Sysibm.Systables                      | Select            |
| Table Columns          | Sysibm.Syscolumns                     | Select            |
| Relationships          | Sysibm.Sysrels                        | Select            |
| Procedures & Functions | Sysibm.Sysroutines                    | Select            |
| Views                  | Sysibm.Sysviews                       | Select            |
| Schema Users           | Syscat.Schemata, Sysibmadm.Privileges | Select            |
| Table Users            | Syscat.Tabauth, Sysibmadm.Privileges  | Select            |

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to Administration > Connectors, click **+ (New Connector)**, search for **DB2 ODBC,** and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219.00006103515625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "DB2 ODBC" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the DB2 ODBC connection              </p><p>(Example: "DB2 ODBC_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Connectivity Type*</td><td><p>The following three types of connectivity are supported for DB2 ODBC:</p><ul><li>DB2ODBC_DB_PARAMS</li><li>DSN</li><li>DSN with Password</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="DB2ODBC\_DB\_PARAMS" %}

<table><thead><tr><th width="219.83331298828125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>DB2 ODBC OE Application Instance URL*</td><td>Enter the instance URL of the server where the DB2 ODBC App was installed.</td></tr><tr><td>Server*</td><td>Enter the DB2 ODBC database server name or IP address.</td></tr><tr><td>Port*</td><td>Enter the port number of the DB2 ODBC database.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the DB2 ODBC.</td></tr><tr><td>Driver*</td><td>By default, the DB2 ODBC driver details are auto-populated.</td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the DB2 ODBC database (Example: "oesauser").</td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}

{% tab title="DSN" %}

<table><thead><tr><th width="219.8333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>DB2 ODBC OE Application Instance URL*</td><td>Enter the instance URL of the server where the DB2 ODBC App was installed.</td></tr><tr><td>DSN*</td><td>Enter the Data Source Name (DSN) configured on the system for the DB2 ODBC connection.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}

{% tab title="DSN with Password" %}

<table><thead><tr><th width="219.8333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>DB2 ODBC OE Application Instance URL*</td><td>Enter the instance URL of the server where the DB2 ODBC App was installed.</td></tr><tr><td>DSN*</td><td>Enter the Data Source Name (DSN) configured on the system for the DB2 ODBC connection.</td></tr><tr><td>Password*</td><td>Enter the password associated with the DSN configuration.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219.8333740234375"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="219.83331298828125"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="219.8333740234375"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="219.8333740234375"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.&#x20;

1. Navigate to the Connectors page and click **Crawl/Profile.**
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. Click the **Crawl & Profile** radio button if both operations are required.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Databases tab**.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select Period drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

#### Other Operations

The **Connectors page** in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connectors Health**: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the **Nine Dots menu**.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector:** Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Profiler**: Customize data profiling rules and methods.
  * **Query Policies:** Define query execution rules based on roles.
  * **Access Instructions:** Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Connection Pooling**: Allows configuring parameters such as maximum pool size, idle time, and timeouts directly within the application.&#x20;
  * **Others**: Configure notification recipients for metadata changes.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector:** Remove a connector with confirmation.

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.