Plug-in Documentation

IBM InfoSphere DataStage

Overview

This plug-in includes steps to import and export .isx and .dsx files, list a .dsx file contents, and compile DataStage projects. This plug-in communicates with various command-line tools, such as: istool and dscc. Each step will require one DataStage tool. Please consult the Knowledge Center if you do not know where the required executable is located on your system.

To add the IBM InfoSphere DataStage plug-in steps to processes, click InfoSphere> DataStage in the step palette of the process editor.

Compatibility

The IBM UrbanCode Deploy automation plug-in for IBM InfoSphere DataStage versions 8.1 and higher.
This plug-in requires version 6.0.1 or later of IBM UrbanCode Deploy.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 8

  • Fixes APAR PI99404 Added options to configure the -qs and -qspa flags for the dscc command in the Compile Job or Routine step.
  • RFE 103645 Added the Delete Assets step.
  • The Default value of the Abort After # Errors property in all istool steps will no longer cause errors.
  • The Export ISX Project will create archives with the timestamp instead of a random number.

Version 7

  • Fixes APAR PI8647 Export ISX Project and Import ISX Project steps fail with Unknown Operation error.

Version 6

The following update has been made to the Export and Import DSX Project steps:

  • RFE 94749 Allow the user to enable the creation of a log file, to which the DataStage script output will be written.

Version 5

The following updates have been made to the Export and Import ISX Project steps:

  • Fixes APAR PI79600 Updated spacing and quotations.
  • All properties are now trimmed.
  • Updated success and error responses.

The following updates have been made to the Export ISX Project steps:

  • Removed extraneous maxArchiveSize property.
  • Updated how the archive file names are generated.
  • Generated archive file names are saved as Output Properties.
  • If the -nodesign flag is set, -includeexecutable will be set automatically.

Version 4

Fixed the following bugs with the Export and Import ISX Project steps:

  • Fixes APAR PI76696 Invalid spacing for additional arguments.
  • The istool path is now used properly to run the istool script.
  • Small updates to reading in .dsx, .xml, or .isx files.

Version 3

Support property file encryption.

Version 2

Added functionality for importing and exporting .isx files.
Support added to either warn or crash if a file is not found for DSX Import Service step.
MissingMethodException error has been resolved for the DSX Import Service step.

Version 1

Initial Release. Added functionality for importing and export .dsx files, listing .dsx contents, and compiling DataStage projects.

Usage

Steps

Process steps in the DataStage plug-in

Compile Job or Routine

Compile a DataStage job or routine silently. Note: All environmental dependencies
must be
set before this step runs, otherwise dialog boxes are displayed on the agent server
and the process stops.
The step continues normally after the dialog boxes are confirmed.

Input properties for the Compile Job or Routine step
Name Type Description Required
Compilation Report String Specify the full name and destination for a compilation report. No
Compile Enumeration:

  • JOB
  • ROUTINE
Select whether to compile a job or a routine. Yes
DataStage Script Path String Specify the full path to the client directory where the DataStage scripts are located. Yes
Domain String The host name of the services tier computer, including an optional port number. For
example: localhost:8080
No
Force Compile Boolean Select to force the compilation of parallel jobs. No
Job or Routine Name String Specify the job or routines to compile. Specify a single name, an asterisk (*)
to compile all jobs or routines in the project, or category_name\* to compile all
jobs or routines in a category. If you specify a category, jobs
and routines in subcategories are not included.
Yes
Only Uncompiled Jobs Boolean Select to compile only jobs that are uncompiled. No
Password Password The password to use to attach to the project. Yes
Project String The project that contains the jobs to compile. Yes
Provision All Rule Sets Boolean Select to provision all rule sets that the job compilation references. No
Rule Set String Specify rule set(s) to provision. Use * to provision all rule sets. No
Username String The user name to use to attach to the project. Yes

DSX Import Service

Import objects from a .dsx file to a repository. This step works only on tiers where
the ASBNode node agent is installed.
You can specify multiple projects and files in the step.

Input properties for the DSX Import Service step
Name Type Description Required
DataStage Script Path String Specify the full path to the node agent \bin directory where the DataStage scripts
are located.
Yes
Domain String Specify the domain of the InfoSphere server. The default port
number, 9080, is used if you do not specify a port number. For
example: server-is.example.com:8080
No
File Pathnames String Specify a list of .dsx files to import. Separate file names with a commas or newline
characters. Complete file paths must be specified. Regex is not
allowed. Alternately, specify a text file that contains a list of files to import.
Yes
Overwrite File Enumeration:

  • 0
  • Overwrite
  • OverwriteReadOnly
Specify how to overwrite existing objects in the repository.
If you do not change this option from the default, attempting to re-import existing
objects causes an error. Yes, Include Read-Only Items additionally
replaces read-only items. By default, existing read-only items are not overwritten.
No
Password Password The password to use to connect to the domain. No
Project String Specify the project to import the .dsx files to. Yes
Selected Imports String Specify options here to import selected objects from a .dsx file.
You specify the object type and the object name. You can specify a full name or anabbreviated
name for the object type. Separate each argument with a space.For
more information see the IBM InfoSphere DataStage Programmers Guide.
No
Stop On Error Boolean Select to stop on errors. No
Username String The user name to use to connect to the domain. No
Verbose Boolean Select to generate a full report of the objects imported. By default, only import
errors are reported.
No

Delete Assets

Delete InfoSphere DataStage or QualityStage assets.

Input properties for the Delete Assets step
Name Type Description Required
Abort After # Errors Enumeration:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 10
  • 20
  • 50
Stops the deletion after the specified number of errors. No
Assets String Specify a list of InfoSphere DataStage and QualityStage assets to delete. Separate
each asset with newlines or commas. A .txt file may also be specified
that contains the same structure. Example: project/folder/asset_name.suffix.
View the `istool Delete` CLI documentation for a complete list of suffixes. The specified
server will be appended to the beginning of each asset.
Yes
Domain String If you do not specify this parameter, the primary domain server is used for the connection.
Example: is-server.ibm.com:9445
No
Password Password The password for the domain username. No
Server String Specifies that InfoSphere DataStage and QualityStage assets are to be deleted from
the target server. Example: IS-SERVER.
Yes
Username String The name of a user on the domain. No
istool Path String Full path to the InformationServer/istools/cli folder where the istool script is
located.
Yes

Export DSX Project

Export InfoSphere DataStage project level components to a .dsx file.

Input properties for the Export DSX Project step
Name Type Description Required
DataStage Script Path String Specify the full path to the client directory where the DataStage scripts are located. Yes
Destination Folder String Specify the folder for storing the .dsx files. Leave blank to use the working directory. No
Domain String The host name of the application server, including an optional port number.
For example: is-server.example.com:9445
No
Password Password The password to use to connect to the application server. No
Project String Specify a list of projects to export the components from. Separate
project names with commas or newline characters. Specify /ALL to export all projects.
Alternately, specify a text file that contains a list of project names to export from.
Yes
Username String The user name to use to connect to the application server. No
Verbose Boolean Select to switch the verbose option on. No

Export ISX Project

Export InfoSphere DataStage or QualityStage assets to a specified .isx file.

Input properties for the Export ISX Project step
Name Type Description Required
Abort After # Errors Enumeration:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 10
  • 20
  • 50
Stops the export after the specified number of errors. No
Domain String If you do not specify this parameter, the primary domain server is used for the connection.
Example: is-server.ibm.com:9445
No
Password Password The password for the domain username. No
Preview Boolean Select to view run the command without changing the repository. No
Projects String Specify a list of InfoSphere DataStage and QualityStage projects are to be exported.
Separate each project with newlines or commas. A .txt file may
also be specified that contains the same structure. Example: Jobs The archive will
be named after the project.
Yes
Response File String Specifies the name and path of a response file that contains assets that failed
to import during a run of a previous istool import command. Not supported with the
preview parameter.
No
Server String Specifies that InfoSphere DataStage and QualityStage assets are to be export from
the target server. Example: IS-SERVER.
Yes
Update Archive Boolean Updates the archive file if it exists. If you do not specify -updatearchive,
the content of the existing archive file is overwritten.
No
Username String The name of a user on the domain. No
istool Path String Full path to the InformationServer/istools/cli folder where the istool script is
located.
Yes

Import DSX Project

Import InfoSphere DataStage project level components from a .dsx or .xml file into
a repository.
You can specify one project and a list of file names to import. If the DSX Import
Service is available, use it to import .dsx files.

Input properties for the Import DSX Project step
Name Type Description Required
DataStage Script Path String Specify the full path to the client directory where the DataStage scripts are located. Yes
Domain String The host name of the services tier computer, including an optional port number. For
example: localhost:8080
No
File Pathnames String The file(s) to import from. Separate files with commas or newline.
The files must be .dsx files or .xml files, or a combination of both.
The list of import files may given via a .txt file.
Yes
No Environment Variables Boolean Select to prevent the import process from adding environment variables to the project
definitions. Use this option if you plan to add missing job environment
variable definitions to the project manually. By default, the
import process adds missing environment variable definitions to the project.
No
Password Password The password to use to connect to the service tier computer. No
Project String Specify a project to import the components from. Specify /All to import all projects.
Note: The /ASK parameter is not supported by this plug-in.
Yes
Username String The user name to use to connect to the service tier computer. No
Verbose Boolean Select to generate a full report of the objects imported. By default, only import
errors are reported.
No

Import ISX Project

Import InfoSphere DataStage or QualityStage assets from a previously exported .isx
file.

Input properties for the Import ISX Project step
Name Type Description Required
Abort After # Errors Enumeration:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 10
  • 20
  • 50
Stops the import after the specified number of errors. No
Domain String If you do not specify this parameter, the primary domain server is used for the connection.
Example: is-server.ibm.com:9445
No
ISX Archive Files String List the .isx files to import assets from. Seperate each file with a newlines or commas.
A .txt file may also be specified that contains the same structure. Example: Project.isx
Yes
Password Password The password for the domain username. No
Preview or Replace Enumeration:

  • 0
  • PREVIEW
  • REPLACE
Specify Preview to view run the command without changing the repository.
Specify Replace to overwrite existing assets with imported assets of the same identity.
No
Project String Specifies that InfoSphere DataStage and QualityStage assets are to be imported to
the target project. This will be the top level of the DataStage
projects you are importing. Example: Jobs
Yes
Response File String Specifies the name and path of a response file that contains assets that failed
to import during a run of a previous istool import command. Not supported with the
preview parameter.
No
Server String Specifies that InfoSphere DataStage and QualityStage assets are to be imported to
the target server. Example: IS-SERVER
Yes
Username String The name of a user on the domain. No
istool Path String Full path to the InformationServer/istools/cli folder where the istool script is
located.
Yes

List DSX File Contents

List the objects that a .dsx file contains. This step works only on tiers where the
ASBNode node agent is installed.

Input properties for the List DSX File Contents step
Name Type Description Required
DSX File Path String Specify the .dsx file to list. You can specify a full path name,
which can be local or remote. Alternately, specify a text file that contains a list
of file names.
Yes
DataStage Script Path String Specify the full path to the node agent \bin directory where the DataStage scripts
are located.
Yes