Summary
When adTempus runs a program or script, it defines Job Variablesthat the program or script can use. These variables are discussed in the Predefined Variables topic in the adTempus 3.x help document.
Some new variables have been added to adTempus since the last update of the documentation. This article provides the current list of variables.
More Information
The list below includes all of the predefined variables as of adTempus version 3.0.8.1.
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 system-generated description of the step. Use ADTStepName to get the user-supplied name of the step. |
ADTFullyQualifiedJobName | The fully-qualified name of the job, including the names of its ancestor groups, e.g., "Group 1\Group 1a\My Job". |
ADTJobNotes | The contents of the Description/Notes field from the job properties. |
ADTStepNotes | The contents of the Description/Notes field from the job step properties. |
ADTStepName | The name of the step, if specified. |
ADTTaskResult | The exit code of the most recent Program Execution Task to be executed. |
ScriptResult | The Result value provided by the most recent script to be executed. |
ConsoleOutputFileName | The name of the file containing the captured console output from the most recent step that captured console output. |
Various triggers may also add additional variables. See the documentation for the individual triggers for more information.