# IBM InfoSphere DataStage

This article outlines the integration with the IBM InfoSphere DataStage connector, enabling streamlined metadata management through features such as crawling and lineage building (both automatic and manual). 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%2FLk9GIJnGJ7zVAj3opKud%2Fimage.png?alt=media&#x26;token=6f1ee89f-d1b6-4da8-a0df-0be5153c0333" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="415.6666259765625"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>ETL Tool</td></tr><tr><td>Connector Version</td><td>Release6.3.X</td></tr><tr><td>Releases Supported (Available from)</td><td>Release6.3.X</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with IBM InfoSphere DataStage]</p></td><td>NFS</td></tr></tbody></table>

### 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 InfoSphere DataStage and mapped to the corresponding UI assets.

<table><thead><tr><th width="179.83331298828125">DataStage Object</th><th width="212.83331298828125">DataStage Attribute</th><th width="185.5">OvalEdge Attribute</th><th width="168.8333740234375">OvalEdge Category</th><th>OvalEdge Type</th></tr></thead><tbody><tr><td><code>sourcecode.pjb</code></td><td><code>sourcecode.pjb</code></td><td>Code Name</td><td>Codes</td><td>DTS_Component</td></tr><tr><td><code>sourcecode.pjb</code></td><td>Extracted SQL from Xml</td><td>Code Name</td><td>Codes</td><td>DTS_SQL</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

**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 IBM InfoSphere DataStage administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operations | Objects      | Access Permission |
| ---------- | ------------ | ----------------- |
| Crawling   | `.pjb` files | Read              |

### 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 **DataStage**, 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.83331298828125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "DataStage" 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</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the DataStage connection              </p><p>(Example: "DataStagedb").</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>Path*</td><td>Enter the folder path that contains subfolders with <code>.pjb</code> files. When the Crawl button is selected, each subfolder is displayed as a schema, and the <code>.pjb</code> files within those subfolders are crawled.</td></tr></tbody></table>

**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"></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"></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

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

The **Crawl/Profile** button allows users to select one or more schemas for crawling.&#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.
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/<>Codes** tab.

The Schedule checkbox allows automated crawling 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 **crawl** operation at the scheduled time.

#### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

**Managing connectors includes:**

* **Connector 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 Codes, Schemas, and Tasks.

**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.
  * **Lineage**: Select server dialects for parsing and setting connector priority for table lineage.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector**: Remove a connector with confirmation.

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="84.8333740234375">S.No.</th><th width="212.6666259765625">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Please provide valid path</td><td><p><strong>Description</strong>: The specified folder path is invalid or inaccessible.</p><p><strong>Resolution</strong>: Provide a valid folder path with read permissions.</p></td></tr></tbody></table>

***

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