Job Variable Update Task Properties
The Job Variable Update Task Properties window contains the settings for a job step that executes a Job Variable Update Task.
Property Pages
General
Name for this step (optional)
Optionally, specify a descriptive name for the step.
Enable this step
Uncheck this box to disable the step. If the step is not enabled, it will be skipped at execution.
Description/Notes
Enter any extended descriptive information or notes for this step.
Conditions
The Conditions page defines conditions that must be satisfied before the step is run.
Condition Criteria
The Condition Criteria determine how the conditions should be evaluated:
- Execute only if all conditions are met. The step is only executed if all of the listed conditions are met.
- Execute if any condition is met. The step is executed if any of the listed conditions is met.
If Conditions are not satisfied
The satisfaction options determine what adTempus should do if the conditions are not satisfied:
- Fail the step. The step is not executed; the status is set to Failed.
- Execute anyway. The step is executed anyway.
- Skip the step (do not report as a failure). The step is not run, but it is not treated as a failure. The status of the step is reported as "Skipped (conditions not met)."
Conditions List
The Conditions list lists the conditions that have been defined for the step. You can add, edit, or delete conditions. See the Conditions topic for information on the available condition types.
Variables
The Variables page allows you to define Job Variables for this step. You can add new Variables, or override the values of Variables inherited from the Job. Any Variables you define or override here affect only this step of the Job.
To set Variables that apply to the entire job, use the Variables page in the Job properties.
Responses
The Responses page defines the actions that adTempus should take in response to events that are fired during execution of the step. You can add, edit, delete, or reorder responses.
All job steps support the events listed below. Some tasks may define additional events .
Event | Description |
Step Started | Occurs at the beginning of the step. |
Step Ended | Occurs at the end of the step, regardless of the step result. |
Step Failed | Occurs if the step fails for any reason. |
Step Restarted | Occurs if the step is restarted due to a Response. |
Restart Limit Exceeded | Occurs if the restart limit is exceeded. |
Step skipped | Occurs when the step is skipped, either because conditions were not met (if the Skip... option is selected on the Conditions page) or due to a skip option specific to the task. |
One or more conditions failed | Occurs if one or more Conditions for the step is not satisfied. |
Conditions not met within the specified time |
Occurs if the job or a step within the job has been waiting for conditions for longer than the specified time. |
Variable Update
Variable to Update
Enter the name of the Job Variable to update. Click the ... button to select from a list of already-defined variables. If the variable already exists, the existing value will be updated. Otherwise a new variable will be created.
Note: Do not include percent signs ("%") around the variable name.
Set value to
Select this option to set the variable to a specific value. Enter the value you want to set the variable to.
Check the Expand variable tokens at runtime option if you want to expand any variable tokens found in the value you have specified. For example, suppose you are updating a variable named "BaseVariable" and you specifiy that it should be set to %Variable22%. If Expand variable tokens at runtime is checked, BaseVariable will be set to whatever the value of Variable22 is at runtime. If the option is not checked, BaseVariable will be set to the literal value %Variable22% Variable22 will not be treated as a variable name).
Increase/decrease value by
Select this option to increase or decrease a numeric variable by the amount you specify. If the target variable already exists, it must contain a numeric value type or the update will fail. If the target variable does not exist, it will be created and set to the increment value.
Scope
The Scope determines how broadly the variable update will apply.
- Apply to executing instance only. The new value of the variable will be seen only within the current instance of the job.
For the remaining settings the new value of the variable will be seen within the current instance of the job, and the definition will also be updated in the variable's containing object, so that future job executions will also be affected.
The user who is editing the settings must have permission to modify the target object or the settings cannot be saved. No permission check is made at job execution.
If auditing is turned on for the affected object, adTempus will generate a change log entry for the variable update. You can change this behavior.
- Update definition for Step. The variable is updated in the definition of the Step that is running the update.
- Update definition for Job. The variable is updated in the definition of the Job that is running the update.
- Update definition for Job Group. The variable is updated in the definition of the Job Group that the executing job belongs to. If the variable is already defined for a group in the job's ancestor hierarchy, the variable will be updated at that level. Otherwise, the variable will be created in the Group that is the job's immediate parent.
- Update definition for Server. The variable is updated at the server level.
Related Concepts