Retrieving information

The dsjob command can be used to retrieve and display the available information about specific projects, jobs, stages, or links.

The different versions of the syntax are described in the following sections.

Displaying job information

The following syntax displays the available information about a specified job:


dsjob -jobinfo [-useid] project job|job_id

-useid specify this if you 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 job.

job is the name of the job. To identify 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.

The following information is displayed:

  • The current status of the job
  • The name of any controlling job for the job
  • The date and time when the job started
  • The wave number of the last or current run (internal InfoSphere® DataStage® reference number)
  • User status

This syntax is equivalent to the DSGetJobInfo function.

Displaying stage information

The following syntax displays all the available information about a stage:


dsjob -stageinfo [-useid] project job|job_id stage

-useid specify this if you 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 job.

job is the name of the job containing stage. To identify 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.

stage is the name of the stage.

The following information is displayed:

  • The last error message reported from any link to or from the stage
  • The stage type name, for example, Transformer or Aggregator
  • The primary links input row number

This syntax is equivalent to the DSGetStageInfo function.

Displaying link information

The following syntax displays information about a specified link to or from a stage:


dsjob -linkinfo [-useid] project job|job_id stage link

-useid specify this if you 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 job.

job is the name of the job containing stage. To identify 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 (see Setting an alias for a job).

stage is the name of the stage containing link.

link is the name of the stage.

The following information is displayed:

  • The last error message reported by the link
  • The number of rows that have passed down a link

This syntax is equivalent to the DSGetLinkInfo function.

Displaying parameter information

This syntax displays information about the specified parameter:


dsjob -paraminfo [-useid] project job|job_id param

-useid specify this if you 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 job.

job is the name of the job containing parameter. To identify 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.

parameter is the name of the parameter.

The following information is displayed:

  • The parameter type
  • The parameter value
  • Help text for the parameter that was provided by the job's designer
  • Whether the value should be prompted for
  • The default value that was specified by the job's designer
  • Any list of values
  • The list of values provided by the job's designer

This syntax is equivalent to the DSGetParamInfo function.