Datastage Command Line Interface:
The DataStage CLI comprises three groups of commands, those concerned with running DataStage Jobs, those concerned with administering DataStage projects, and those concerned with searching jobs.
The dsjob command can be used from the UNIX command line to execute of the following tasks, All output from the dsjob command is in plain text without column headings on lists, or any other sort of description. This enables the command to be used in shell or batch scripts without extra processing.
These options are described in the following topics:
- The logon clause
- Starting a job
- Stopping a job
- Listing projects, jobs, stages, links, and parameters
- Setting an alias for a job
- Retrieving information
- Accessing log files
- Importing job executables
- Generating a report
By default, the DataStage CLI connects to the DataStage server engine on the local system using the user name and password of the user invoking the command. We can specify a different server, user name, or password using the logon clause.
[–server servername][–user username][–password password]
servername specifies a different server to log on to.
username specifies a different user name to use when logging on.
password specifies a different password to use when logging on.
We can use the logon clause with any dsjob command.
Starting a Job:
We can start, stop, validate, and reset Datastage jobs using the –run option from the UNIX command line
[ –mode [ NORMAL | RESET | VALIDATE ] ]
[ –param name=value ]
[ –warn n ]
[ –rows n ]
[ –wait ]
[ –stop ]
[–opmetadata [TRUE | FALSE]]
[useid] project job| job_id
Explanations of the available options
–mode specifies the type of job run. NORMAL starts a job run, RESET resets the job and VALIDATE validates the job. If –mode is not specified, a normal job run is started.
–param specifies a parameter value to pass to the job. The value is in the format name=value, where name is the parameter name, and value is the value to be set. If we use this to pass a value of an environment variable for a job (as we may do for parallel jobs), we need to quote the environment variable and its value, for example -param '$APT_CONFIG_FILE=sayan.apt' otherwise the current value of the environment variable will be used.
–warn n sets warning limits to the value specified by n
–rows n sets row limits to the value specified by n.
–wait waits for the job to complete.
–stop terminates a running job.
–jobstatus waits for the job to complete, then returns an exit code
derived from the job status.
–userstatus waits for the job to complete, then returns an exit code derived from the user status if that status is defined.
-local use this when running a DataStage job from within a shellscript on a UNIX server.
-opmetadata use this to have the job generate operational meta data as it runs. If we specify FALSE, the job will not generate operational meta data.
-disableprjhandler use this to disable any error message handler that has been set on a project wide basis.
-disablejobhandler use this to disable any error message handler that has been set for this job.
-useid specify this if we intend to use a job alias (jobid) rather than a job name (job) to identify the job.
-project is the name of the project containing the job. job is the name of the job. To run a job invocation, use the format job.invocation_id.
job_id is an alias for the job that has been set using the dsjob -jobid command.
Stopping a Job:
We can stop a Datastage job using the –stop option from UNIX command prompt
dsjob –stop [useid] project job| job_id
Next part is available HERE