Your use of this download is governed by Stonebranch’s Terms of Use, which are available at Stonebranch Integration Hub - Terms of Use.
IBM DataStage is a powerful data integration and ETL (Extract, Transform, Load) tool by IBM and it helps organizations extract data from various sources, transform it to meet specific business requirements, and load it into target systems such as data warehouses, data marts, and operational data stores. This Universal Task allows Stonebranch users to schedule, trigger, monitor, and orchestrate the InfoSphere DataStage jobs directly from Universal Controller via the InfoSphere DataStage Command-line Interface(CLI). It also helps to set up dependencies between Datastage jobs and other applications or platforms using UAC workflows and trigger DataStage Jobs from UAC either time-based or event-based.
Template Name | Version |
---|---|
CS Datastage CLI | 1.0.0 |
Refer to Changelog for version history information.
This integration requires a Universal Agent and a Python runtime to execute the Universal Task.
Requires Python 3.7.6 or higher. Tested with the Universal Agent bundled Python distribution.
Both Windows and Linux agents are supported.
Universal Controller Version 7.1.0.0 and later.
IBM InfoSphere DataStage Client (CLI) installed in the agent host is configured to connect with the DataStage Server.
This Universal Task provides the following features:
To use the Universal Template, you first must perform the following steps.
This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow these instructions.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Modifications of this integration, applied by users or customers, before or after import, might affect the supportability of this integration. For more information refer to Integration Modifications.
For a new Universal Task, create a new task, and enter the required input fields.
Field | Input type | Default value | Type | Description |
---|---|---|---|---|
Server | Required | - | Text | The DataStage server hostname or the IP address |
Datastage Credentials | Required | - | Credentials | The Datastage user credentials for job execution, The Credentials definition should be as follows.
|
Domain | Required | - | Text | The Domain of the DataStage server. |
Project | Required | - | Text | The Project from where the DataStage job needs to be identified. |
Job Name | Required | - | Text | The IBM Infosphere DataStage Job Name |
Parameters | Optional | - | Large Text | The parameters for the execution of InfoSphere DataStage jobs Example : -param FI_CODE=002 -param DS_DT=2022-05-06 -param ENV_PARAM=DEV -mode RESTART Refer here for the valid dsjob run command parameters. |
Wait for Success or Failure | Required | True | Boolean | If selected, the task will continue running until Job reaches the "SUCCEDED" or "FAILED" state. |
Print Job Logs | Required | False | Boolean | Prints the entire log details by using CLI "dsjob -logdetail" |
Reset Mode | Required | False | Boolean | Resets the IBM Infosphere Datastage Job using the CLI option - "dsjob -run -mode RESET" |
IBM Infosphere DataStage Job Definition
IBM DataStage Orchestrated using UAC Workflow
The exit codes for this Universal Extension are described below.
Exit Code | Status Classification Code | Status Classification Description | Status Description |
---|---|---|---|
0 | SUCCESS | Successful Execution | SUCCESS: Successful Task execution |
1 | FAILED | Failed Execution | Failed: DataStage job execution Failed |
STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.
This document references the following documents.
Document Link | Description |
---|---|
Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
Credentials | User documentation for creating and working with credentials. |
Resolvable Credentials Permitted Property | User documentation for Resolvable Credentials Permitted Property. |
Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.
Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.
Initial Version