Job Variable Update Action Properties

The Job Variable Update Action Properties window contains the settings for a Job Variable Update Action.

Property Pages

General

Name for this action (optional)

Optionally, specify a descriptive name for the action.

Enabled

Uncheck this box to disable the action. If the action is not enabled, it will be skipped at execution.

Description/Notes

Enter any extended descriptive information or notes for this action.

Action

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.