Predefined Variables
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.
When you are editing a text field that supports Job Variables, you can use the Insert Variables button (
) to open a text edit window that lets you selected the predefined variables from a list.
Miscellaneous
Miscellaneous variables
| Variable | Description |
| NotificationFromName | The display name to use as the sender for notification messages. Overrides setting in SMTP server properties. |
| NotificationFromAddress | The address to use as the sender for notification messages. Overrides setting in SMTP server properties. |
| DefaultMessage | The default notification message generated for a Notification Action. |
| DefaultSubject | The default notification subject generated for a Notification Action. |
| Message | The current notification message for a notification operation. |
| MessageTimestamp | The timestamp for a notification message. |
| ComputerName | The name of the computer on which adTempus is running. |
| ServerName | The name of the computer on which adTempus is running. |
| adTempus.InstanceName | The adTempus instance name. |
| adTempus.ServerAndInstanceName | The name of the server and instance, e.g., "computername\instancename". If this is the default instance, will be only "computername". |
| ADTServerPath | The path where adTempus is installed. |
Job
Variables defined for all jobs
| Variable | Description |
| ADTJobID | The unique identifier for the job. |
| JobStatus | The current status of the job. |
| ADTFullyQualifiedJobName | The fully-qualified name of the job, including the group name. |
| ADTJobName | The name of the job, without the group name. |
| ADTTriggerClass | The type of trigger that started the job. |
| ADTQueueName | The name of the Queue to which the job is assigned. |
| ADTGroupName | The full name of the Group to which the job is assigned. |
| ADTExecutionReason | Text description of the reason the job is being executed. |
| ADTJobRestartCount | The restart attempt number. Will be 0 for first execution attempt, then incremented each time the job is restarted by a Restart action. |
| ADTExecutionAttempt | The execution attempt number. Will be 1 for first execution attempt, then incremented each time the job is restarted by a Restart action. |
| ADTJobNotes | The Description/Notes information for the job. |
| ADJobInstance | The OID of the ExecutionHistoryItem representing this instance of the job. |
| ADTInstanceID | The instance number for this instance of the job. |
| ADTJobTemp | A temporary directory that is automatically deleted at the end of the job. |
| ADTCycleID | The Cycle ID, if any, assigned to the job. |
| Job.ExecutionStart | The date/time at which the job started |
| Job.ExecutionFinish | The date/time at which the job ended, if it has |
Job Step
Variables defined for job steps. These variables are defined only if a step is currently executing.
| Variable | Description |
| StepStatus | The current status of the Step. |
| ADTJobStep | The OID of the step. |
| ADTStepNumber | The step number. |
| ADTStepDescription | The description of the step, including name if defined, and task description. |
| ADTStepNotes | The Description/Notes information for the step |
| ADTStepName | The name of the step, if defined. |
| ADTJobCheckpoint | The current checkpoint for the step. |
| ADTStepRestartCount | The restart attempt number. Will be 0 for first execution attempt, then incremented each time the job is restarted by a Restart action. |
| ADTServerPath | The path in which the adTempus server executable and related tools are located. |
| JobStep.ExecutionStart | The date/time at which the current step started |
| JobStep.ExecutionFinish | The date/time at which the current step ended, if it has |
Task: E-Mail
Variables set by E-Mail Processing Tasks
| Variable | Description |
| EmailProcessing.MessageLocation | Semicolon-delimited list of directories created by message save operations |
| EmailProcessing.SelectedMessageCount | The number of messages selected by the message filter |
Task: File Operation
Variables set by File Transfer and File Compression Tasks
| Variable | Description |
| FileOperationTask.ProcessedFileCount | The number of messages successfully processed by the task |
Task: Process Termination
Variables set by Process Termination Tasks
| Variable | Description |
| ProcessTermination.KilledProcessCount | The number of processes matching the target process name that were successfully terminated |
| ProcessTermination.FailedToKillProcessCount | The number of processes matching the target process name that were not successfully terminated |
| ProcessTermination.KilledChildProcessCount | The number of processes terminated that were child processes of target processes |
| ProcessTermination.FailedToKillChildProcessCount | The number of processes not terminated that were child processes of target processes |
| ProcessTermination.KilledChildProcesses | Comma-separated list of the names of the child processes that were terminated |
| ProcessTermination.FailedToKillChildProcesses | Comma-separated list of the names of the child processes that could not be terminated |
Task: Program Execution
Variables set by Program Execution Tasks
| Variable | Description |
| ProcessExitCode | The exit code from the process run by the task. |
| ADTProcessID | The Windows process ID (PID) for the executable started by the task. |
| ADTTaskResult | The exit code from the process run by the task. |
Task: Script Execution
Variables set by Script Execution Tasks
| Variable | Description |
| ScriptResult | The result returned by the script. |
| ADTTaskResult | The result returned by the script. |
Task: Web Request
Variables set by Web Request Tasks.
| Variable | Description |
| WebRequest.RequestURL | The URL requested by the task. |
| WebRequest.StatusCode | The HTTP status code returned by the remote server. |
| WebRequest.ResponseFileName | The name of the file where the server response (file or page) was saved, if the save to file option was selected. |
Trigger: Computer Monitor
Variables set by Computer Monitor triggers
| Variable | Description |
| ComputerMonitor.ErrorMessage | The error message if the connection has failed. |
| ComputerMonitor.ConnectionStatusCode | The numeric error code if the connection has failed, or 0 if it succeeded. |
| ComputerMonitor.Action | The action that caused the trigger: ConnectionFailed or ConnectionRestored. |
| ComputerMonitor.FailureCount | Total number of failed connection attempts since the last successful connection, |
| ComputerMonitor.Target | The target URL |
| ComputerMonitor.LastSuccessTime | The date/time of the last successful connection, in UTC |
Trigger: File
Variables set by File Triggers
| Variable | Description |
| FileTrigger.FileName | The name of the file(s) that matched the selection criteria. If the trigger is configured to list all matching files, and not configured to trigger separately for each file, the FileName variable will contain a list of all matching files, separated by semicolons. |
| FileTrigger.FileSize | The size of the file. |
| FileTrigger.FileCreationTime | The file's creation timestamp, in UTC. |
| FileTrigger.FileLastAccessTime | The file's last access timestamp, in UTC. |
| FileTrigger.FileLastWriteTime | The file's last write timestamp, in UTC. |
| FileTrigger.FileAttributes | The file's file attributes |
| FileTrigger.FileAction | The reason the file was selected: FileCreated, FileDeleted, FileExists, FileModified, or FileNoExist. |
Trigger: Process
Variables set by Process Triggers
| Variable | Description |
| ProcessTrigger.ProcessName | The name of the process |
| ProcessTrigger.ProcessID | The Windows process ID for the process |
| ProcessTrigger.ProcessEvent | The action that caused the trigger: "TriggerProcessStarted", "TriggerProcessEnded", "TriggerProcessMemExceeds" |
| ProcessTrigger.ProcessEventDescription | Description of the action that caused the trigger: "started", "ended", or "exceeded memory threshold" |
Trigger: Event Log
Variables set by Event Log Triggers
| Variable | Description |
| EventLog | The name of the log where the event was reported. |
| EventLogMonitor.EventSource | The source of the event. |
| EventLogMonitor.EventCategory | The event category. |
| EventLogMonitor.EventCategoryDescription | The text description of the event category. |
| EventLogMonitor.EventType | The type/severity of the event. |
| EventLogMonitor.EventTypeName | The text description of the type/severity of the event. |
| EventLogMonitor.EventTimestamp | The timestamp of the event. |
| EventLogMonitor.EventID | The event ID. |
| EventLogMonitor.EventMessage | The message logged for the event. |
| EventLogMonitor.EventKeywords | Comma-delimited list of keywords for the event. |
Trigger: E-Mail
Variables set by E-Mail Triggers
| Variable | Description |
| EmailProcessing.SelectedMessageCount | The number of messages selected by the message filter |
| EmailProcessing.MessageId | The message ID of the selected e-mail message. Set only if the trigger is configured to trigger separately for each message. |
| EmailProcessing.MessageSubject | The subject of the selected e-mail message. Set only if the trigger is configured to trigger separately for each message. |
| EmailProcessing.MessageLocation |
The name(s) of the files folders where the e-mail messages have been saved, if message saving is selected for the trigger. If multiple messages are selected, the EmailMessageLocation will contain multiple values, separated by semicolons. Each message is saved in a uniquely-named folder. |
Alert Notification
Variables that are available in alert notification subjects and messages
| Variable | Description |
| computername | The name of the computer issuing the alert |
| adTempus.InstanceName | The adTempus instance name. |
| adTempus.ServerAndInstanceName | The name of the server and instance, e.g., "computername\instancename". If this is the default instance, will be only "computername". |
| message | The alert message text |
| messageclass | The alert class (category) |
| messageid | The alert message ID |
| messagetype | The alert severity |
| messagecode | The message resource ID string |
| timestamp | The message timestamp |
| jobname | The name of the job associated with the alert |