Monitor Action Type
The Monitor action type is used in device-based (PLC) mode configurations where the host needs to monitor the device and take action when certain conditions occur. To do this, there are configurable Monitor blocks in the XML structure where a set of conditions are defined and if those conditions are all true then the set of defined actions are executed. All conditions for a monitor block met be met before moving on to the next monitor block.
The Monitor action type supports Steep Time Actions, Timeout Actions, and Monitor Actions.
Sleep Time Action
The Monitor or Test action types support the configuration of sleep time action(s) to specify how long the Test or Monitor action type will "sleep" before updating the actual timeout value and evaluating the conditional expression. If any actions are specified for the Sleep time actions, then for every sleeptime timeout specified, those actions will be executed. For example, wait five seconds and then poll the device. In the XML configuration these conditional actions are specified in the <SleepTimerActions> element.
Timeout Action
The Monitor action type supports the configuration of a timeout value. When the timeout expires, the action(s) specified in the Timeout Actions property will be executed. In the XML configuration these timeout actions are specified in the <TimeoutActions> element.
Monitor Action
A Monitor action type may contain multiple monitor definition blocks, configured within the Monitors Definitions block. Each Definitions block contains one or more Conditions and one or more Actions. In the XML configuration these actions are specified in the <Monitors>, <Conditions> and <Actions> elements.
To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.
Example
|
<Actions> <Action type="Monitor" timeout="0" sleeptime="5000"> <SleepTimerActions> <Action type="UisCommand" command="POLL" relativeFacilityLink="Separator" statusUDC="SYCMDSTAT"> <Parameters /> </Action> </SleepTimerActions> <Monitors> <Monitor> <Conditions> <Condition operator="=" value1="1" value1relativeFacilityLink="" value1type="Self" value2="PONEWTST" value2relativeFacilityLink="Separator" value2type="UDC" /> </Conditions> <Actions> <Action type="SetPoint" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Monitor 1" /> </Actions> </Monitor> <Monitor> <Conditions> <Condition operator="=" value1="2" value1relativeFacilityLink="" value1type="Self" value2="PONEWTST" value2relativeFacilityLink="Separator" value2type="UDC" /> </Conditions> <Actions> <Action type="SetPoint" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Monitor 2" /> </Actions> </Monitor> <Monitor> <Conditions> <Condition operator="=" value1="-1" value1relativeFacilityLink="" value1type="Self" value2="PONEWTST" value2relativeFacilityLink="Separator" value2type="UDC" /> </Conditions> <Actions> <Action type="Exit" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Condition Exit" /> </Actions> </Monitor> </Monitors> <TimeoutActions> <Action type="UisCommand" command="POLL" relativeFacilityLink="Separator" statusUDC="SYCMDSTAT"> <Parameters /> </Action> <Action type="SetPoint" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Sleep" /> </TimeoutActions> </Action> </Actions> |
Monitor Action Type Attributes
The Monitor action type has the following associated configuration attributes:
| Attribute | Required | Description |
|---|---|---|
|
sleeptime |
Yes |
Specifies the time in milliseconds that the Monitor or Test action will "sleep" before updating the actual timeout value and evaluating the defined conditional actions. When the Sleep time timeout (sleeptime) expires, the actions defined in the Sleep Time Actions grid <SleepTimerActions> will be executed. For example, wait five seconds and then poll the device. |
|
timeout |
Yes |
Specifies the time in milliseconds until the Monitor action will timeout. When this timeout occurs, the defined action(s) will execute. A value of "0" means the action will never timeout based on time. When the timeout expires, the actions in the Timeout Actions grid <TimeoutActions> will be executed. |
|
type |
Yes |
Specifies the action type for the action. |
SleepTimerActions
The Monitor or Test action types support the configuration of sleep time action(s) to specify how long the Test or Monitor action type will "sleep" before updating the actual timeout value and evaluating the conditional expression. If any actions are specified for the Sleep time actions, then for every sleeptime timeout specified, those actions will be executed. For example, wait five seconds and then poll the device. In the XML configuration these conditional actions are specified in the <SleepTimerActions> element.
See the SleepTimerActions element for more information.
TimeoutActions
The Monitor action type supports the configuration of a timeout value. When the timeout expires, the action(s) specified in the Timeout Actions property will be executed. In the XML configuration these timeout actions are specified in the <TimeoutActions> element.
See the TimeoutActions element for more information.
Monitors, Monitor
A Monitor action type may contain multiple monitor definition blocks, configured within the Monitors Definitions block. Each Definitions block contains one or more Conditions and one or more Actions. In the XML configuration these actions are specified in the <Monitors>, <Conditions> and <Actions> elements.
See the Monitors element for more information.
