IBM DataStage

Version Supported: up to v11.7

Tool Permissions Prerequisites

Warning: Missing permissions could end up in broken lineages.

1. IBM DataStage Client version 8.5 or later installed
2. Open Server Port to DataStage Server Machine

How to export IBM DataStage jobs

1. Open DataStage Designer (Client)
2. Choose project and connect
3. Click export -> DataStage Components ->
   
4. Click Add and choose folder jobs from the pop window: Select Items
   
   
5. Configure destination file name and location:
   • At the drop down list of the “Job components to export:” please choose:“Export job designs without executables”
   • Uncheck the Exclude read-only items
   • Choose the Export file destination and type a name for the dsx file – Export to file
   • Click the Export Button
     

The extracted file will appear in the destination defined folder.
Use this file as source for your Octopai metadata DataStage connection in the Octopai Client.

Please make sure to have appropriate permissions to the path to ensure the Octopai Client can access the file with the user running it.

DataStage automation requires the customer to extract the DataStage project using the following methods.

ISX Method:

Each project for each Server needs to be in a separate zip file.
Each project will be displayed as different connection name in the Octopai application:

Octopai Client - DataStage Module’s fields 

 

In the Source Folder, need to be only one ISX file that resembles one project.

In Parameter Set Folder, needs to be the parameters file for that one project. (the format is TXT)

The Parameter Set file should be on this convention “Isx_File_Name_DSPARAMS.txt”.
(For example, if we have a project named project.isx, the Parameter file name will be project_DSPARAMS.txt)

The result from this module should be like the following:

DSX Method:

Each project for each Server needs to be in a separate zip file.
The connection name that has specified in Octopai Client will be the Name of the parameter file:

In the Source Folder, need to be only one DSX that resembles one project.

In Parameter Set Folder, need to be the parameters file for that one project. (the format is TXT)
The Parameter Set file should be on this convention “ConnectionName_DSPARAMS.txt”.
(For example, if the Connection Name that given while creating this connection was DsxProject-Sample, the Parameter file name will be DsxProject-Sample_DSPARAMS.txt)

The result from this module should be like the following:

DataStage: Export of parameter files

1. Go to the Administrator Client
   

2. Choose the relevant Project and click on “Properties”
   
3. Click on the “Environment” button
   
4. Go to “User Defined” and click on “Export to File”
   
5. The new file name (.env) will be created - save it as “Name of Project_DSPARAMS.txt”

Setting up DataStage Metadata Source

Metadata Sources are set on the Octopai Client (OC) 

How to verify the extracted Metadata File

Access the Octopai Target Folder (TGT)

1. Go to the TGT Folder located on the Server where the Octopai Client is installed.
   By default: C:\Program Files (x86)\Octopai\Service\TGT
2. Open the zip file having the Connector Name
   Example:
3. Verify its content
   Quantity & Quality of inner files

Troubleshoot

Error during the extraction:

• Check the permissions
• Send the log with the connector number and name to Octopai Support - C:\Program Files (x86)\Octopai\Service\log