When adTempus runs a job, it sets several job variables automatically. These variables can be used within the job by using substitution tokens. For example, you can include the following text in the command-line parameters for a program to pass it the name of the job:
%ADTJobDescription%
These variables are also available to scripts, and are defined as environment variables for any programs run by the job.
The following variables are set for all jobs run by adTempus:
|
Variable Name |
Description |
|
ADJobInstance |
A GUID identifying this instance of the job. This value is used by the adtchkpt utility program. |
|
ADTExecutionReason |
A message indicating why the job is being run, e.g., "scheduled execution". |
|
ADTExecutionAttempt |
The execution attempt number. This value will be 1 for the first attempt and is incremented each time the job is restarted by a Job Control Action. |
|
ADTJobDescription |
The name of the job. |
|
ADTInstanceID |
The instance number for this instance. |
|
ADTJobOID |
The unique identifier for this job. |
|
ADTTriggerClass |
The name of the trigger that started the job. |
|
ServerName |
The name of the computer where the job is running. |
|
ADTQueueName |
The name of the Job Queue that the job is assigned to. |
|
ADTGroupName |
The full name of the Job Group that contains the job. |
|
ADTJobStep |
The unique identifier for this job step. |
|
ADTStepNumber |
The step number. |
|
ADTJobCheckpoint |
The checkpoint being passed to the program. |
|
ADTStepRestartCount |
The restart count. This value will be 0 for the first attempt and is incremented each time the step is restarted by a Job Control Action. |
|
ADTStepDescription |
The description of the step. |
Additional variables may be set by the Trigger that starts the job. See the help topic for the specific trigger for information on the variables it sets.
Additional variables may be set based on the outcome of a task:
|
Variable Name |
Description |
|
TaskResult |
Contains the result of the task. Depending on the type of task, this may be a numeric exit code or a string result. |
|
ProcessExitCode |
Set only by the Program Execution Task. Contains the numeric exit code returned by the executed program. |
|
ConsoleOutputFileName |
Set only by the Program Execution Task if the step was run in "Capture Console" window mode. Contains the complete path and name of the file that contains the captured console output from the program. |