Variable Monitor Task
Overview
The Variable Monitor task allows you to monitor the value of a Global Variable.
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.
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.
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.
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.
When the Variable Monitor conditions are met, the following built-in variables will be set for the Variable Monitor task instance:
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).
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.
