> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/rdbms/ibm-db2-zos.md).

# IBM DB2 ZOS

This article outlines the integration with the IBM DB2 ZOS connector, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and lineage building (both automatic and manual). The connector discovers schemas, tables, views, columns, relationships, indexes, functions, and stored procedures, and imports the collected metadata into OvalEdge.

The connector uses a JDBC Driver to establish connectivity with IBM DB2 ZOS. It authenticates using a dedicated IBM DB2 ZOS service account with the required permissions to access metadata and perform the configured connector operations.

<img src="https://1121831267-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFZv5WsZmBfXjiJfMU2zR%2Fuploads%2FMMECWRjfbH6GM3SIiGvX%2Funknown.png?alt=media&amp;token=2fd4b85a-68f4-49c9-bc33-0c87dfb4d00b" alt="" height="413" width="624">

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="447"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>RDBMS</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.x and later</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with IBM DB2 ZOS]</p></td><td>JDBC Driver</td></tr><tr><td>Verified IBM DB2 ZOS Version</td><td>11.1.4.4</td></tr></tbody></table>

{% hint style="info" %}
The IBM DB2 ZOS connector has been validated with the mentioned "Verified IBM DB2 ZOS Versions" and is expected to be compatible with other supported IBM DB2 ZOS versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

### Connector Features

<table data-search="false"><thead><tr><th>Feature</th><th align="center">Availability</th></tr></thead><tbody><tr><td>Crawling</td><td align="center">✅</td></tr><tr><td>Delta Crawling</td><td align="center">❌</td></tr><tr><td>Profiling</td><td align="center">✅</td></tr><tr><td>Sample Profiling</td><td align="center">✅</td></tr><tr><td>Query Sheet</td><td align="center">✅</td></tr><tr><td>Data Preview</td><td align="center">✅</td></tr><tr><td>Auto Lineage</td><td align="center">✅</td></tr><tr><td>Manual Lineage</td><td align="center">✅</td></tr><tr><td>Secure Authentication via Credential Manager</td><td align="center">✅</td></tr><tr><td>Data Quality</td><td align="center">✅</td></tr><tr><td>DAM (Data Access Management)</td><td align="center">❌</td></tr><tr><td>Bridge</td><td align="center">✅</td></tr></tbody></table>

### Metadata Mapping

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

<table data-search="false"><thead><tr><th width="183">IBM DB2 ZOS Object</th><th width="336">IBM DB2 ZOS Attribute</th><th width="172">OvalEdge Attribute</th><th width="172">OvalEdge Category</th><th width="168">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>CREATOR / SCHEMA (from SYSTABLES SYSDATATYPES SYSROUTINES SYSTRIGGERS)</td><td>Schema</td><td>Databases</td><td>Schema</td></tr><tr><td>Schema</td><td>Schema comment</td><td>-</td><td>-</td><td>-</td></tr><tr><td>Table</td><td>NAME (SYSIBM.SYSTABLES)</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>TYPE (SYSIBM.SYSTABLES)</td><td>Type</td><td>Tables</td><td>table / view</td></tr><tr><td>Table</td><td>REMARKS (SYSIBM.SYSTABLES)</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>NAME (SYSIBM.SYSCOLUMNS)</td><td>Column</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>COLTYPE (SYSIBM.SYSCOLUMNS)</td><td>Column Type</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>REMARKS (SYSIBM.SYSCOLUMNS)</td><td>Source Description</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>COLNO (SYSIBM.SYSCOLUMNS)</td><td>Column Position</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>LENGTH (SYSIBM.SYSCOLUMNS)</td><td>Data Type Size</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>NULLS (SYSIBM.SYSCOLUMNS)</td><td>Nullable</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>KEYSEQ > 0 (SYSIBM.SYSCOLUMNS)</td><td>Keys</td><td>Table Columns</td><td>-</td></tr><tr><td>Views</td><td>NAME (SYSIBM.SYSTABLES / SYSIBM.SYSVIEWS)</td><td>View</td><td>Tables</td><td>view</td></tr><tr><td>Views</td><td>STATEMENT (SYSIBM.SYSVIEWS)</td><td>View Query</td><td>Views</td><td>view</td></tr><tr><td>Procedures</td><td>NAME (SYSIBM.SYSROUTINES) via STRIP(SUBSTR(NAME 1 to 8))</td><td>Name</td><td>Procedures</td><td>-</td></tr><tr><td>Procedures</td><td>TEXT (SYSIBM.SYSROUTINES)</td><td>Procedure</td><td>Procedures</td><td>-</td></tr><tr><td>Procedures</td><td>ROUTINETYPE = P (SYSIBM.SYSROUTINES)</td><td>Type</td><td>Procedures</td><td>-</td></tr><tr><td>Procedures</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Functions</td><td>NAME (SYSIBM.SYSROUTINES) via STRIP(SUBSTR(NAME 1 to 8))</td><td>Name</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td>TEXT (SYSIBM.SYSROUTINES)</td><td>Function</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td>ROUTINETYPE &#x3C;> P (SYSIBM.SYSROUTINES)</td><td>Type</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Triggers</td><td>SCHEMA (SYSIBM.SYSTRIGGERS)</td><td>-</td><td>-</td><td>-</td></tr><tr><td>Triggers</td><td>trigger_name / trigger_code / action_timing</td><td>-</td><td>-</td><td>-</td></tr><tr><td>Keys / Relationships</td><td>TBNAME COLNAME (SYSFOREIGNKEYS); REFTBNAME RELNAME (SYSRELS); PK COLNAME (SYSCOLUMNS KEYSEQ)</td><td>Keys / Relationships</td><td>Table Columns</td><td>-</td></tr><tr><td>Indexes</td><td>INDNAME (SYSIBM.SYSINDEXES)</td><td>Index</td><td>Indexes</td><td>Index</td></tr><tr><td>Indexes</td><td>COLNAME (SYSIBM.SYSINDEXCOLUMNS)</td><td>Index Columns</td><td>Indexes</td><td>Index</td></tr><tr><td>Indexes</td><td>UNIQUERULE (SYSIBM.SYSINDEXES P/U)</td><td>Yes / No (Unique)</td><td>Indexes</td><td>Index</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**Whitelisting Ports**

Ensure the inbound port “50005” is whitelisted for OvalEdge to connect to the IBM DB2 ZOS.

{% hint style="warning" %}
The default port number for IBM DB2 ZOS is 50005. 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 ZOS is properly established.
{% endhint %}

**External Supporting Files**

{% hint style="info" %}
The required external JAR files are included as part of the OvalEdge installation artifacts. For driver installation and configuration details, refer to the [Connector Drivers Setup Guide](https://docs.ovaledge.com/connectors/additional-requirements/connector-drivers-setup-guide). Please contact the OvalEdge Team for assistance related to the driver files and configuration setup.
{% endhint %}

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a dedicated 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 IBM DB2 ZOS administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table data-search="false"><thead><tr><th width="179">Operation</th><th width="167">Objects</th><th width="293">Sys Tables</th><th width="146">Access Permissions</th></tr></thead><tbody><tr><td>Connection Validation</td><td>Connection</td><td>SYSIBM.SYSDUMMY1</td><td>Select</td></tr><tr><td>Crawling</td><td>Schemas</td><td>SYSIBM.SYSTABLES, SYSIBM.SYSDATATYPES, SYSIBM.SYSROUTINES, SYSIBM.SYSTRIGGERS</td><td>Select</td></tr><tr><td>Crawling</td><td>Tables / Views</td><td>SYSIBM.SYSTABLES</td><td>Select</td></tr><tr><td>Crawling / Profiling</td><td>Table Columns</td><td>SYSIBM.SYSCOLUMNS</td><td>Select</td></tr><tr><td>Crawling</td><td>Primary Keys</td><td>SYSIBM.SYSCOLUMNS</td><td>Select</td></tr><tr><td>Crawling / Lineage</td><td>Views</td><td>SYSIBM.SYSVIEWS</td><td>Select</td></tr><tr><td>Crawling / Lineage</td><td>Functions / Stored Procedures</td><td>SYSIBM.SYSROUTINES</td><td>Select</td></tr><tr><td>Schema Discovery</td><td>Triggers</td><td>SYSIBM.SYSTRIGGERS</td><td>Select</td></tr><tr><td>Crawling</td><td>Relationships</td><td>SYSIBM.SYSFOREIGNKEYS, SYSIBM.SYSRELS, SYSIBM.SYSCOLUMNS</td><td>Select</td></tr><tr><td>Crawling (Optional)</td><td>Indexes</td><td>SYSIBM.SYSINDEXES, SYSIBM.SYSINDEXCOLUMNS, SYSIBM.SYSTABLES</td><td>Select</td></tr><tr><td>Profiling</td><td>Row Count</td><td>SYSIBM.SYSTABLES</td><td>Select</td></tr><tr><td>Profiling / Data Preview</td><td>User Tables</td><td>&#x3C;schema>.&#x3C;table></td><td>Select</td></tr><tr><td>Full Profiling</td><td>User Tables</td><td>&#x3C;schema>.&#x3C;table></td><td>Select</td></tr><tr><td>Crawling (Optional – RDAM)</td><td>User / Schema Permissions</td><td>SYSCAT.SCHEMATA, SYSIBMADM.PRIVILEGES</td><td>Select</td></tr><tr><td>Crawling (Optional – RDAM)</td><td>User / Table Permissions</td><td>SYSCAT.TABAUTH, SYSIBMADM.PRIVILEGES</td><td>Select</td></tr></tbody></table>

{% hint style="info" %}

* Schema discovery combines metadata from SYSIBM.SYSTABLES, SYSIBM.SYSDATATYPES, SYSIBM.SYSROUTINES, and SYSIBM.SYSTRIGGERS.
* Trigger metadata is used only for schema discovery. Trigger definitions are not crawled as separate metadata objects or included in lineage generation.
* Row count profiling uses the catalog cardinality (CARDF) from SYSIBM.SYSTABLES instead of executing live COUNT(\*) queries.
* Index metadata is retrieved only when index crawling is enabled. This option may not be available in the connector configuration for IBM DB2 ZOS.
  {% endhint %}

### 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 **IBM DB2 ZOS**, and complete the required parameters.

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

<table data-search="false"><thead><tr><th width="221">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "IBM DB2 ZOS" 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 the 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><p>For more details, click<a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration"> here</a>. </p></td></tr><tr><td>License Add Ons</td><td><p>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</p><p>For more details, click<a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/license-types-and-add-ons"> here</a>. </p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the IBM DB2 ZOS connection              </p><p>(Example: "IBM DB2 ZOS_Prod").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click<a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment"> here</a>. </p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the fully qualified host name or IP address of the IBM DB2 ZOS server that hosts the Distributed Data Facility (DDF) listener (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Port*</td><td>Enter the port number configured for the IBM DB2 ZOS DDF listener. The default value is 50005. Update this value if your environment uses a different DDF port</td></tr><tr><td>Database*</td><td>Enter the IBM DB2 ZOS Location Name configured for the target database. The value is case-sensitive and must be specified in uppercase as required by the IBM Db2 JDBC Type 4 driver.</td></tr><tr><td>Driver*</td><td>Displays the JDBC driver class used to establish the connection. The default value is com.ibm.db2.jcc.DB2Driver and cannot be modified. Ensure that the required db2jcc4.jar driver is available in the configured JDBC driver location before validating the connection.</td></tr><tr><td>Username*</td><td>Enter the username of the IBM DB2 ZOS service account used by the connector. Ensure that the account has the required permissions to access metadata and perform the configured connector operations.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified IBM DB2 ZOS service account. This password is used to authenticate the connection to the database.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the IBM DB2 ZOS:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to Database Name.</p></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>

<table data-header-hidden data-search="false"><thead><tr><th width="219"></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 and teams configured in OvalEdge Security are displayed for selection.</td></tr><tr><td>Admin Roles*</td><td>Select one or more users from the drop-down list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr><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><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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering 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 to perform both crawling and profiling operations.
4. Click **Run** to collect metadata from the connected source and load it into the **OvalEdge 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 schema, tables, columns, and views.

**Nine Dots Menu Options:**

To view, edit, validate, build lineage, 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.
  * **Anomaly Detection Settings:** Configure anomaly detection preferences at the connector level.
  * **Lineage**: Select server dialects for parsing and setting connector priority for table lineage.
  * **Others**: Configure notification recipients for metadata changes.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector:** Remove a connector with confirmation.

For more details on connector settings, click [here](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/rdbms/ibm-db2-zos.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.