Overview
The Variable Monitor task allows you to monitor the value of a Global Variable.
Variable Values to Monitor
The Variable Monitor task lets you monitor for:
- Current value of a Global Variable.
- Change in the value of a Global Variable.
- Both current value and change in the value of a Global Variable.
Monitoring for the Current Value of a Variable
- If the Variable To Monitor exists and its current value matches the Variable Monitor conditions, the Variable Monitor task instance will transition to a Success status; otherwise, it will transition to a Failed status.
- If the Variable To Monitor does not exist (or the Execution User does not have Read permission for the Global Variable) and the Value Condition field is undefined, the Variable Monitor task instance will transition to a Success status; otherwise, it will transition to a Failed status.
Monitoring for a Change in the Value of a Variable
- The Variable Monitor task instance will not check the current value of the Variable To Monitor, but it will monitor for changes to the Variable To Monitor value. If a change to the Variable To Monitor value matches the Variable Monitor conditions, the Variable Monitor task instance will transition to a Success status; otherwise, it will to continue to monitor for changes to the Variable To Monitor value.
- The Variable Monitor task instance will monitor indefinitely for the Variable Monitor conditions to be met unless you specify a value in the Time Limit field. The Variable Monitor task instance will transition to a Failed status if the Variable Monitor conditions are not met within the specified Time Limit.
Note
- A Variable Monitor task instance will not detect changes to a Global Variable Value if the Execution User does not have Read permission for the Global Variable.
- Setting the Global Variable Value to the same value from the Universal Controller user interface, CLI, or web service is not considered a change.
- Only changes to the Global Variable Name (case-insensitive) and Global Variable Value will be considered a change in value to the Global Variable. That is, changes to the Description and/or Member of Business Services fields alone will not be considered a change in value to the Global Variable.
Monitoring for Current Value of a Variable and a Change in the Value of a Variable
- If the Variable To Monitor exists and its current value matches the Variable Monitor conditions, the Variable Monitor task instance will transition to a Success status; otherwise, it will continue to monitor as though Variable To Monitor is Change.
- If the Variable To Monitor does not exist (or the Execution User does not have Read permission for the Global Variable) and the Value Condition is undefined, the Variable Monitor task instance will transition to a Success status; otherwise, it will continue to monitor as though Value Monitor Type is Change.
Built-In Variables
When the Variable Monitor conditions are met, the following built-in variables will be set for the Variable Monitor task instance:
Creating a Variable Monitor Task
Step 1 | From the Automation Center navigation pane, select Tasks > Variable Monitor Tasks. The Variable Monitor Tasks list displays a list of all currently defined Variable Monitor tasks. |
---|---|
Step 2 | Enter/select Details for a new Variable Monitor task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click a Save button. The task is added to the database, and all buttons and tabs in the Task Details are enabled. |
Note
To open an existing record on the list, either:
- Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
- Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
- Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
Variable Monitor Task Details
The following Variable Monitor Task Details is for an existing Variable Monitor task.
Depending on the values that you enter / select for these fields, and whether or not the Variable Monitor task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Variable Monitor Task Details.
Variable Monitor Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the Variable Monitor Task Details.
Field Name | Description |
---|---|
General | This section contains general information about the task. |
Name | Unable to render {include} The included page could not be found. |
Version | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Resolve Name Immediately | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Hold on Start | Unable to render {include} The included page could not be found. |
Hold Reason | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Variable Monitor Details | This section contains assorted detailed information about the task. |
Variable to Monitor | Unable to render {include} The included page could not be found. |
Value Monitor Type | Unable to render {include} The included page could not be found. |
Value Condition | Unable to render {include} The included page could not be found. |
Value | Unable to render {include} The included page could not be found. |
Time Limit | If Value Monitor Type = Change or Current/Change; Used for Variable Monitor tasks not associated with a trigger; Amount of time (in units specified by Time Limit Unit) to monitor for the Variable Monitor conditions to be met. The Time Limit duration is always relative to the start time of the Variable Monitor task instance. Note If the Variable Monitor task was created from a Variable Monitor trigger, Time Limit is not allowed, since Variable Monitor Type is Change and cannot be updated. |
Time Limit Unit | If Value Monitor Type = Change or Current/Change; Unit of time to use for Time Limit.
|
Expiration Action | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Workflow Only | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related specifications for the task. |
Late Start | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
User Estimated Duration | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for task instances of the task. |
First Execution | Unable to render {include} The included page could not be found. |
Last Execution | Unable to render {include} The included page could not be found. |
Last Instance Duration | Unable to render {include} The included page could not be found. |
Lowest Instance Time | Unable to render {include} The included page could not be found. |
Average Instance Time | Unable to render {include} The included page could not be found. |
Highest Instance Time | Unable to render {include} The included page could not be found. |
Number of Instances | Unable to render {include} The included page could not be found. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Buttons | This section identifies the buttons displayed above and below the Task Details that let you perform various actions. |
Save | Saves a new task record in the Controller database. |
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. |
Save & View | Saves a new record in the Controller database and continues to display that record. |
New | Displays empty (except for default values) Details for creating a new task. |
Update | Unable to render {include} The included page could not be found. |
Launch Task | Unable to render {include} The included page could not be found. |
View Parents | Unable to render {include} The included page could not be found. |
Copy | Creates a copy of this task, which you are prompted to rename. |
Delete | Unable to render {include} The included page could not be found. Note You cannot delete a task if it is either:
|
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task. |
Tabs | This section identifies the tabs across the top of the Task Details that provide access to additional information about the task. |
Variables | Unable to render {include} The included page could not be found. |
Actions | Unable to render {include} The included page could not be found. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Mutually Exclusive | Unable to render {include} The included page could not be found. |
Instances | Lists all instances of the task. |
Variable Monitor Triggers | Unable to render {include} The included page could not be found. |
Triggers | Unable to render {include} The included page could not be found. |
Notes | Unable to render {include} The included page could not be found. |
Versions | Unable to render {include} The included page could not be found. |
Viewing a Variable Monitor Task Instance
When a Variable Monitor task is launched, the Controller creates a task instance record of that task.
A task instance contains detailed information about a single execution of that task.
You can access a task instance from:
- Instances tab on the Variable Monitor Task Details for that task
- Activity Monitor
- Task Instances list
Variable Monitor Task Instance Details
The following Variable Monitor Task Instance Details contains information on the execution of the task shown in the Variable Monitor Task Details.
Variable Monitor Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in Variable Monitor Task Instance Details.
Field Name | Description |
---|---|
General | This section contains general information about the task instance. |
Instance Name | Name of this task instance. |
Instance Number | Unable to render {include} The included page could not be found. |
Description | Unable to render {include} The included page could not be found. |
Member of Business Services | Unable to render {include} The included page could not be found. |
Task | Unable to render {include} The included page could not be found. |
Source Version | Unable to render {include} The included page could not be found. |
Launch Source | Unable to render {include} The included page could not be found. |
Source Instance | Unable to render {include} The included page could not be found. |
Invoked by | Unable to render {include} The included page could not be found. |
Execution User | Unable to render {include} The included page could not be found. |
Calendar | Unable to render {include} The included page could not be found. |
Time Zone Preference | Unable to render {include} The included page could not be found. |
Virtual Resource Priority | Unable to render {include} The included page could not be found. |
Hold Resources on Failure | Unable to render {include} The included page could not be found. |
Status | This section contains information about the current status of the task instance. |
Status | Unable to render {include} The included page could not be found. |
Exit Code | Unable to render {include} The included page could not be found. |
Status Description | Unable to render {include} The included page could not be found. |
Operational Memo | Unable to render {include} The included page could not be found. |
Evaluation Time | Unable to render {include} The included page could not be found. |
Critical | Unable to render {include} The included page could not be found. |
Wait Until Time | Unable to render {include} The included page could not be found. |
Queued Time | Unable to render {include} The included page could not be found. |
Trigger Time | Unable to render {include} The included page could not be found. |
Launch Time | Unable to render {include} The included page could not be found. |
Start Time | Unable to render {include} The included page could not be found. |
End Time | Unable to render {include} The included page could not be found. |
Duration | Unable to render {include} The included page could not be found. |
Variable Monitor Details | This section contains assorted detailed information about the task instance. |
Variable to Monitor | Unable to render {include} The included page could not be found. |
Value Monitor Type | Unable to render {include} The included page could not be found. |
Value Condition | Unable to render {include} The included page could not be found. |
Value | Unable to render {include} The included page could not be found. |
Time Limit | If Value Monitor Type = Change or Current/Change; Used for Variable Monitor tasks not associated with a trigger; Amount of time (in units specified by Time Limit Unit) to monitor for the Variable Monitor conditions to be met. The Time Limit duration is always relative to the start time of the Variable Monitor task instance. Note If the Variable Monitor task was created from a Variable Monitor trigger, Time Limit is not allowed, since Variable Monitor Type is Change and cannot be updated. |
Time Limit Unit | If Value Monitor Type = Change or Current/Change; Unit of time to use for Time Limit.
|
Expiration Action | Unable to render {include} The included page could not be found. |
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. |
Wait To Start | Unable to render {include} The included page could not be found. |
Wait Time | Unable to render {include} The included page could not be found. |
Wait Day Constraint | Unable to render {include} The included page could not be found. |
Wait Duration | Unable to render {include} The included page could not be found. |
Wait Duration In Seconds | Unable to render {include} The included page could not be found. |
Delay On Start | Unable to render {include} The included page could not be found. |
Delay Duration | Unable to render {include} The included page could not be found. |
Delay Duration In Seconds | Unable to render {include} The included page could not be found. |
Time Options | This section contains time-related specifications for the task instance. |
Late Start | Unable to render {include} The included page could not be found. |
Started Late | Unable to render {include} The included page could not be found. |
Late Start Type | Unable to render {include} The included page could not be found. |
Late Start Time | Unable to render {include} The included page could not be found. |
Late Start Day Constraint | Unable to render {include} The included page could not be found. |
Late Start Nth Amount | Unable to render {include} The included page could not be found. |
Late Start Duration | Unable to render {include} The included page could not be found. |
Computed Late Start Time | Unable to render {include} The included page could not be found. |
Late Finish | Unable to render {include} The included page could not be found. |
Finished Late | Unable to render {include} The included page could not be found. |
Late Finish Type | Unable to render {include} The included page could not be found. |
Late Finish Offset Type | Unable to render {include} The included page could not be found. |
Late Finish Percentage Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset ( + ) | Unable to render {include} The included page could not be found. |
Late Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Late Finish Time | Unable to render {include} The included page could not be found. |
Late Finish Day Constraint | Unable to render {include} The included page could not be found. |
Late Finish Nth Amount | Unable to render {include} The included page could not be found. |
Late Finish Duration | Unable to render {include} The included page could not be found. |
Computed Late Finish Time | Unable to render {include} The included page could not be found. |
Early Finish | Unable to render {include} The included page could not be found. |
Finished Early | Unable to render {include} The included page could not be found. |
Early Finish Type | Unable to render {include} The included page could not be found. |
Early Finish Offset Type | Unable to render {include} The included page could not be found. |
Early Finish Percentage Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset ( - ) | Unable to render {include} The included page could not be found. |
Early Finish Duration Offset Unit | Unable to render {include} The included page could not be found. |
Early Finish Time | Unable to render {include} The included page could not be found. |
Early Finish Day Constraint | Unable to render {include} The included page could not be found. |
Early Finish Nth Amount | Unable to render {include} The included page could not be found. |
Early Finish Duration | Unable to render {include} The included page could not be found. |
Projected Late | Unable to render {include} The included page could not be found. |
Critical Path Options | This section contains Critical Path-related specifications for the task. |
CP Duration | Unable to render {include} The included page could not be found. |
CP Duration (Resolved) | Unable to render {include} The included page could not be found. |
CP Duration Unit | Unable to render {include} The included page could not be found. |
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. |
Execution Restriction | Unable to render {include} The included page could not be found. |
Restriction Period | Unable to render {include} The included page could not be found. |
Before Date | Unable to render {include} The included page could not be found. |
Before Time | Unable to render {include} The included page could not be found. |
After Date | Unable to render {include} The included page could not be found. |
After Time | Unable to render {include} The included page could not be found. |
Date List | Unable to render {include} The included page could not be found. |
Statistics | This section contains time-related statistics for the the task instance. |
User Estimated End Time | Unable to render {include} The included page could not be found. |
Lowest Estimated End Time | Unable to render {include} The included page could not be found. |
Average Estimated End Time | Unable to render {include} The included page could not be found. |
Highest Estimated End Time | Unable to render {include} The included page could not be found. |
Projected End Time | System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. |
Metadata | This section contains Metadata information about this record. |
UUID | Universally Unique Identifier of this record. |
Updated By | Name of the user that last updated this record. |
Updated | Date and time that this record was last updated. |
Created By | Name of the user that created this record. |
Created | Date and time that this record was created. |
Status History | History of all statuses that the task instance has gone through. |
Buttons | This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. |
Update | Unable to render {include} The included page could not be found. |
Force Finish | Unable to render {include} The included page could not be found. |
Hold | Unable to render {include} The included page could not be found. |
Skip | Unable to render {include} The included page could not be found. |
Re-run | Unable to render {include} The included page could not be found. |
View Parent | Unable to render {include} The included page could not be found. |
Delete | Unable to render {include} The included page could not be found. |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this task instance. |
Tabs | This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance. |
Virtual Resources | Unable to render {include} The included page could not be found. |
Exclusive Requests | Unable to render {include} The included page could not be found. |
Notes | Unable to render {include} The included page could not be found. |
Running a Variable Monitor Task
You can run a Variable Monitor task:
- Manually, by clicking the Launch Task or Launch Task with Variables button in the Variable Monitor Tasks list or Variable Monitor Task Details Action menu.
- As part of a workflow.
- Specify triggers that run the task automatically based on times or events.
Monitoring Task Execution
You can monitor all system activity from the Activity Monitor and can view activity history from the History list.