Defining the ad hoc job
To submit an ad hoc job, you must supply a jobToSubmit statement
that describes the job. The statement has the following format:
- jobName
- The name of the job. Wildcard characters are permitted, in which case, all qualifying jobs are submitted.
- workstationName
- The name of the workstation where the job is to run. If you leave blank, the workstation where the command is run becomes the default.
- userLogin
- The login of the user who runs the job.
- taskType
- The task type. It can be one of the following:
- UNIX
- Windows
- Broker
- Other
- taskString
- A string containing the parameters that control the execution of the job.
- priority
- The execution priority for the job. Must be one of the following:
- A number ranging from 0 to 99
- hi
- go
- command
- Specifies if the job is a command. Can be yes or no.
- monitored
- Specifies if the job is to be monitored by event rules. Can be yes or no.
- requiredConfirmation
- Specifies if the completion (failed or successful) of this job requires user confirmation. Can be yes or no.
- recoveryJobName
- The name of a recovery job that is to run if this job ends abnormally.
- recoveryJobWorkstationName
- The name of the workstation where the recovery job is to run. The default is workstationName.
- recoveryOption
- Recovery options for the job. Values can be:
- Stop
- Continue
- Rerun
The default is stop with no recovery job and no recovery prompt.
- recoveryPromptText
- Specifies the text of a recovery prompt, enclosed in double quotes,
to be displayed if the job ends abnormally. The rules are:
- The text can contain up to 64 characters
- If the text begins with a colon (:), the prompt is displayed, but no reply is required to continue processing
- If the text begins with an exclamation mark (!), the prompt is displayed, but it is not recorded in the log file
- returnCodeMapping
- An expression which defines a job final status (successful or
failed) based on a condition on the return code of the execution of
the program or script of the job.
The return code can be provided also to the recovery job that is associated with it in the job definition. This causes the recovery job to perform different processing based on the return code.
- estimatedDuration
- The estimated duration of a job. This value is based on the statistics
collected from previous runs of the job. If the job has never run
before, a default value of one minute is used.
This parameter is relevant if the job is a predecessor of a critical job.
- startTime
- The date and time at which the job must start.
- latestStartTime
- The latest date and time at which the job can start.
- latestStartAction
- The action to take on the job if the latest start time has elapsed.
Values can be:
- Cancel
- Continue
- Suppress
- deadlineTime
- The date and time within which the job must have completed. After this time the job is considered late.
- repeatInterval
- The repetition rate for the job in hours and minutes, in the hhmm format. The job is launched again every time the end of the interval is reached. The interval can be longer than 24 hours.
For more information see the description of the submit job (sbj) command in the User's Guide and Reference.