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.

Overview

Connector Details

Connector Category

RDBMS

OvalEdge Release Supported

Release6.x and later

Connectivity

[How the connection is established with IBM DB2 ZOS]

JDBC Driver

Verified IBM DB2 ZOS Version

11.1.4.4

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.

Connector Features

Feature

Availability

Crawling

✅

Delta Crawling

❌

Profiling

✅

Sample 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 ZOS and mapped to the corresponding UI assets.

IBM DB2 ZOS Object

IBM DB2 ZOS Attribute

OvalEdge Attribute

OvalEdge Category

OvalEdge Type

Schema

CREATOR / SCHEMA (from SYSTABLES SYSDATATYPES SYSROUTINES SYSTRIGGERS)

Schema

Databases

Schema

Schema comment

Table

NAME (SYSIBM.SYSTABLES)

Table

Tables

table

Table

TYPE (SYSIBM.SYSTABLES)

Type

Tables

table / view

Table

REMARKS (SYSIBM.SYSTABLES)

Source Description

Descriptions

Source Description

Columns

NAME (SYSIBM.SYSCOLUMNS)

Column

Table Columns

Columns

COLTYPE (SYSIBM.SYSCOLUMNS)

Column Type

Table Columns

Columns

REMARKS (SYSIBM.SYSCOLUMNS)

Source Description

Table Columns

Columns

COLNO (SYSIBM.SYSCOLUMNS)

Column Position

Table Columns

Columns

LENGTH (SYSIBM.SYSCOLUMNS)

Data Type Size

Table Columns

Columns

NULLS (SYSIBM.SYSCOLUMNS)

Nullable

Table Columns

Columns

KEYSEQ > 0 (SYSIBM.SYSCOLUMNS)

Keys

Table Columns

Views

NAME (SYSIBM.SYSTABLES / SYSIBM.SYSVIEWS)

View

Tables

view

Views

STATEMENT (SYSIBM.SYSVIEWS)

View Query

Views

view

Procedures

NAME (SYSIBM.SYSROUTINES) via STRIP(SUBSTR(NAME 1 to 8))

Name

Procedures

TEXT (SYSIBM.SYSROUTINES)

Procedure

Procedures

ROUTINETYPE = P (SYSIBM.SYSROUTINES)

Type

Procedures

Description

Source Description

Descriptions

Functions

NAME (SYSIBM.SYSROUTINES) via STRIP(SUBSTR(NAME 1 to 8))

Name

Functions

TEXT (SYSIBM.SYSROUTINES)

Function

Functions

ROUTINETYPE <> P (SYSIBM.SYSROUTINES)

Type

Functions

Description

Source Description

Descriptions

Triggers

SCHEMA (SYSIBM.SYSTRIGGERS)

Triggers

trigger_name / trigger_code / action_timing

Keys / Relationships

TBNAME COLNAME (SYSFOREIGNKEYS); REFTBNAME RELNAME (SYSRELS); PK COLNAME (SYSCOLUMNS KEYSEQ)

Keys / Relationships

Table Columns

Indexes

INDNAME (SYSIBM.SYSINDEXES)

Index

Indexes

Index

Indexes

COLNAME (SYSIBM.SYSINDEXCOLUMNS)

Index Columns

Indexes

Index

Indexes

UNIQUERULE (SYSIBM.SYSINDEXES P/U)

Yes / No (Unique)

Indexes

Index

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.

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.

External Supporting Files

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. Please contact the OvalEdge Team for assistance related to the driver files and configuration setup.

Service Account User Permissions

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.

👨‍💻 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.

Operation

Objects

Sys Tables

Access Permissions

Connection Validation

Connection

SYSIBM.SYSDUMMY1

Select

Crawling

Schemas

SYSIBM.SYSTABLES, SYSIBM.SYSDATATYPES, SYSIBM.SYSROUTINES, SYSIBM.SYSTRIGGERS

Select

Crawling

Tables / Views

SYSIBM.SYSTABLES

Select

Crawling / Profiling

Table Columns

SYSIBM.SYSCOLUMNS

Select

Crawling

Primary Keys

SYSIBM.SYSCOLUMNS

Select

Crawling / Lineage

Views

SYSIBM.SYSVIEWS

Select

Crawling / Lineage

Functions / Stored Procedures

SYSIBM.SYSROUTINES

Select

Schema Discovery

Triggers

SYSIBM.SYSTRIGGERS

Select

Crawling

Relationships

SYSIBM.SYSFOREIGNKEYS, SYSIBM.SYSRELS, SYSIBM.SYSCOLUMNS

Select

Crawling (Optional)

Indexes

SYSIBM.SYSINDEXES, SYSIBM.SYSINDEXCOLUMNS, SYSIBM.SYSTABLES

Select

Profiling

Row Count

SYSIBM.SYSTABLES

Select

Profiling / Data Preview

User Tables

Select

Full Profiling

User Tables

Select

Crawling (Optional – RDAM)

User / Schema Permissions

SYSCAT.SCHEMATA, SYSIBMADM.PRIVILEGES

Select

Crawling (Optional – RDAM)

User / Table Permissions

SYSCAT.TABAUTH, SYSIBMADM.PRIVILEGES

Select

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.

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

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

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name

Description

Connector Type

By default, "IBM DB2 ZOS" is displayed as the selected connector type.

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.

Supported Credential Managers:

OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault

For more details, click here.

License Add Ons

Select the checkbox for Auto Lineage Add-On to build data lineage automatically.

For more details, click here.

Connector Name*

Enter a unique name for the IBM DB2 ZOS connection

(Example: "IBM DB2 ZOS_Prod").

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector.

For more details, click here.

Connector description

Enter a brief description of the connector.

Server*

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).

Port*

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

Database*

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.

Driver*

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.

Username*

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.

Password*

Enter the password associated with the specified IBM DB2 ZOS service account. This password is used to authenticate the connection to the database.

Connection String

Configure the connection string for the IBM DB2 ZOS:

Automatic Mode: The system generates a connection string based on the provided credentials.
Manual Mode: Enter a valid connection string manually.

Replace placeholders with actual database details.

{sid} refers to Database Name.

Plugin Server

Enter the server’s name when running as a plugin server.

Plugin Port

Enter the port number on which the plugin is running.

Default Governance Roles*

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.

Admin Roles*

Select one or more users from the drop-down list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

No Of Archive Objects*

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.

Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Select Bridge*

If applicable, select the bridge from the drop-down list.

The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

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.
The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

To perform crawl and profile operations, users must be assigned the Integration Admin role.

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

Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
The Crawl option is selected by default. Click the Crawl & Profile radio button to perform both crawling and profiling operations.
Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
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.

Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.

PreviousIBM DB2

NextDREMIOICEBERG

Last updated 1 month ago

Was this helpful?