Well Test > Configuring CygNet Well Test > Configuring Well Test Using Canvas > Templates Page > Monitor Action Type

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.

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.

Click the following image for more information:

Click to see a sample Monitor Action configuration
Sample Monitor Action Configuration

To configure a Monitor action

A Monitor action type can be configured from several different places within the well test configuration control. However, the base configuration is always the same. Perform the following steps to configure this type of action, referring to the property definitions below:

  1. Click to Add action from the drop-down menu.
  2. Select the Monitor action type from the Action type list. The action's properties will appear on the right.
  3. Configure the Sleep time properties for the Monitor action:
  1. Type the amount of Time for the sleep action.
  2. Add and configure appropriate sleep time Actions. Repeat as necessary.
  1. Configure the Timeout properties for the Monitor action:
  1. Type the amount of Time for the timeout action.
  2. Add and configure appropriate a timeout Actions. Repeat as necessary.
  1. Configure the Monitors for the Monitor action. Each Monitor can have one or more Definition.
  2. Configure Definitions for the Monitor actions:
  1. Click to Add monitor definition to the Monitor action. Click the Definition row to configure the Conditions and Actions for the definition as described below.
  2. Click to Add condition to the definition. Configure the conditional expression. Repeat as necessary.
  3. Click to Add action to the definition. Configure the action. Repeat as necessary.
  4. Add as many Definitions as required for this Monitor action.
  1. Click OK to accept the configuration.
Back to top

Action Properties

The properties for the Monitor action type are described below.

Property Description XML

Type

Specifies the action type for the action.

type

Sleep time

Time (ms)

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.

sleeptime

Actions

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.

To add a sleep time action

  • Click Add sleep time action to add a new sleep time action to this Monitor action.
  • Select the appropriate action from the drop-down menu. Options include:
  • Click Edit true action or the action type name to edit the action.
  • Click Delete this item to delete the action type, as necessary.
  • Repeat to add as many actions as required.
  • See each action type listed above for user assistance.

<SleeptimerActions>

Timeout

Time (ms)

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.

timeout

Actions

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.

To add a timeout action

  • Click Add timeout action to add a new timeout action to this Monitor action.
  • Select the appropriate action from the drop-down menu. Options include:
  • Click Edit true action or the action type name to edit the action.
  • Click Delete this item to delete the action type, as necessary.
  • Repeat to add as many actions as required.
  • See each action type listed above for user assistance.

<TimeoutActions>

Monitors

Definitions

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 add a monitor definition

  • Click Add monitor definition to add a new definition to this Monitor action.
  • Select the Definitions row to expand the Definitions configuration, which contains two grids: Conditions and Actions.
  • Add Conditions and Actions as described below.
  • Click Delete this item to delete a selected monitor definition, as necessary.

To add a condition

  • Click Add condition to add a new conditional expression to this Definition.
  • Select the Condition row to edit the conditional values.
  • Configure Value 1, the operator, and Value 2.
  • See the Condition Properties section below for information about these configuration options.
  • Click Delete this item to delete a selected condition, as necessary.

To add an action

  • Click Add action to add a new action to this Definition.
  • Select the appropriate action from the drop-down menu. Options include:
  • Click Edit true action or the action type name to edit the action.
  • Click Delete this item to delete the action type, as necessary.
  • Repeat to add as many actions as required.
  • See each action type listed above for user assistance.
 
Back to top

Condition Properties

Each condition in a definition contains three parts: Value 1, the operator and Value 2.

Attribute Description XML
Value 1  

Value

Specifies the first value to use when comparing the point value in the expression:

value1

Value type

Specifies the first value Type (value1Type) property. Options include Self or UDC.

value1Type

Relative facility link

Specifies the first relative facility tag to use for the action.

Note: The facility tag used as the starting point for the relative resolution depends on where this action type is configured. If the action is defined at a position level, then the base facility tag will be the well facility. If defined at the header level, the base facility will be the header facility.

value1RelativeFacilityLink

Operator  
 

Specifies the operation used for the comparison. Acceptable values include:

  • Equal= (operator="=")
  • Greater than> (operator="&gt;")
  • Greater than or equal>= (operator="&gt;=")
  • Less than< (operator="&lt;")
  • Less than or equal<= (operator="&lt;=")
  • Not equal<> (operator="&lt;&gt;")
  • ChangedCHANGED (operator="CHANGED") The CHANGED operation will only check the first set of values (value1, value1Type, and value1RelativeFacilityLink) to determine which point to monitor for change. The second set of values (value2, value2Type, and value2RelativeFacilityLink) are ignored.

operator

Value 2  

Value

Specifies the second value to use when comparing the point value in the expression:

value2

Value type

Specifies the second value Type (value2Type) property. Options include Self or UDC.

value2Type

Relative facility link

Specifies the second relative facility tag to use for the action.

Note: The facility tag used as the starting point for the relative resolution depends on where this action type is configured. If the action is defined at a position level, then the base facility tag will be the well facility. If defined at the header level, the base facility will be the header facility.

value2RelativeFacilityLink

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.