AddJobStep

Use this service to add a job step to a multi-step job.

Required Parameters

Parameter Key Value Type Parameter Description
jobOwner Alphanumeric string

The owner of the job in the appropriate format.

For example, in Windows, the format might be: DOMAIN\user

Maximum length for strings is 10.

jobName Alphanumeric string The job name.

Maximum length for strings is 10.

token Alphanumeric string The token of job step this data belongs to.
jobStepType Fixed values The type of jobStep. Fixed values are application, universe, user, and menu.
dataArea Alphanumeric string The data area where the job step is stored.

Optional parameters

Parameter Key Value Type Parameter Description
jobStepDescription Alphanumeric string

The description of this job step. If not provided, it will default to the title of the token this job step belongs to.

Maximum length for strings is 30.

jobStepKey Alphanumeric string

The job step key this data belongs to. First jobkey has 0 step number, second has 1, and so on.

jobStepNumber Integer

The job step number this data belongs to. The order or index of this step in the multi-step job. First job step has 0 step number, second has 1, and so on.

productLine Alphanumeric string The productline of the job step to be listed. Maximum length of strings is 14.
jobStepParameters Alphanumeric string Additional arguments to execute job step.
workFilePath Alphanumeric string Path where workfile is located. Maximum length of strings is 60.
machineName Alphanumeric string The machine name of job step where workfiles belong to. Maximum length for strings is10.
jobStepTranSize Integer Tran size of the job step. If the job step is an application type, this value defaults to 50 if the job's program is Update is true. Otherwise, value is 0.
intRptServer Integer The value of interpretive server of the job step where workfiles belong to.
hasParameters Boolean Set to TRUE if the job step's token has parameter screen or the job step is an application type. Otherwise, value is FALSE. Fixed values are TRUE or FALSE.

XML request format:

This is the format of the request XML payload for POST method calls. Note that these must always be wrapped by <ACTION> nodes.

<JOB jobOwner="XXX" jobName="XXX" jobDescription="XXX" jobType="XXX" nextStepKey="XXX" workFilePath="XXX" >
   <JOBSTEP jobOwner="XXX" jobName="XXX" token="XXX" jobStepDescription="XXX" jobStepKey="N" jobStepNumber="N" jobStepType="XXX" productLine="XXX" dataArea="XXX" jobStepParameters="XXX" workFilePath="XXX" jobStepTranSize="N" intRptServer="N" hasParameters="XXX" hasCVSAttributes="XXX"/>
 </JOB>