Job Variable Properties
The Job Variable Properties window allows you to view or modify the definition for a Job Variable.
Properties
Variable Name
Enter a name for this Variable. The name must be unique within the list of variables it is being added to. If the object you are adding the Variable to already has a variable with the same name, you cannot change the name or add a new Variable with the same name. However, you can edit the existing variable to override its value.
Variable names can be up to 255 characters in length and are not case sensitive ("MyVariable" is the same as "myvariable").
Include in program's environment variables
If this option is checked, this variable will be included in the environment variables for any programs run by job steps that use these variables. If the option is not checked, the variable will be available for use within adTempus but will not be in the program's environment variables.
If this option is checked, the value of the variable will not be visible in lists in adTempus. The value will also not be visible in this window unless you unhide it or click the Reveal value button. Only users with permission to modify the variable can reveal the value.
Override Rules
5.0
The Override Rules determine whether the variable can be overridden (redefined) at a lower level. For example, you can define a variable at the Job Group level and set the rule to "Override not allowed" to prevent users from changing the value of this variable in jobs.
Allow override at lower levels
Determines whether the variable can be overridden at lower levels of the job hierarchy. The possible values are:
- Override Allowed: The variable can be overridden at any lower level or on manual execution
- Override Not Allowed: The variable is locked and cannot be overridden at any lower level or on manual execution
- Override Required: The variable must be overridden at a lower level. This can be at a lower level group or queue, or at the job level. If the variable has not been overridden by a group or queue, any job that inherits the variable is required to override it, and the job cannot be saved without doing so. If a variable defined at the job level uses this setting, every step within the job is required to override it.
If you change a variable to require or prevent override, the new rules will be applied to affected jobs, groups, and queues the next time they are edited. If affected jobs are executed before being modified, the rules will be enforced during job execution:
- Any attempt to override a variable that does not allow override will be ignored. A warning message will be recorded in the Job Detail Log but job execution will not be affected.
- If a variable requires override and is not overridden, a warning message will be recorded in the Job Log and the job will fail. This behavior can be configured using the Fail jobs if variables that require override have not been overridden option on the Variables page of the Server Options window.
Allow override on execution
Determines whether the variable can be overridden by users when submitting the job for manual (on-demand) execution or when the job is run by Job Execution Tasks or Job Control Actions. The possible values are:
- Override Allowed: The variable can be overridden when submitting the job for execution
- Override Not Allowed: The variable is locked and cannot be overridden when submitting the job for execution
- Override Required: When a user submits for execution any job that inherits the variable, they are required to override it
Select the type of data this variable holds. If the variable will hold a date, time, or numeric value, setting the type appropriately allows you to format the value when inserting it.
Value
Enter the value for this Variable. There is no limit on the length or content of the value for string variables.
Description
Optionally, enter a description or notes about this Variable.