Well Test Config - Test Action Type

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

Test Action Type

The Test action type is used in Host-based command sequencing to wait for a specified period. The primary use of this action is to halt the process until the well test time has elapsed before processing the well test record. This is also useful is a variety of situations such as waiting for the purge time to complete and testing if a point value changed to a desired value after a UIS command action.

Condition Action

The Test action type also supports a series of conditional properties that can be used to interact with the primary test action. They represent the values of an expression and when the expression is true, the conditional actions defined will be executed. For example, specify an Exit action to exit the well test sequence. In the XML configuration these conditional actions are specified in the <ExitOnTagValueActions> element.

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.

Click the following image for more information:

Sample Test Action Configuration

To configure a Test action

A Test 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:

Click to Add action from the drop-down menu.
Select the Test action type from the Action type list. The action's properties will appear on the right.
Configure the Timeout properties for the Test action:

Select the Type for the value: Self or UDC.
Type the Value (UDC or ms) for the timeout Test action.

If the Type is Self, enter an alphanumeric value.
If the Type is UDC, click the browse button to open the Select UDC dialog box and select an appropriate UDC.

Optional. Select a relative facility tag from the Relative facility link drop-down menu. Note: If the Type is set to Self, the Relative facility link property is hidden from view.
Indicate whether to Update the timeout.
Select the Actual UDC.

Configure the Condition properties for the Test action:

Select the UDC to use for the conditional expression. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.
Optional. Select a relative facility tag from the Relative facility link drop-down menu.
Select the desired Operator from the drop-down menu.
Type the alphanumeric Value for the conditional expression.
Add and configure appropriate a conditional Actions. Repeat as necessary.

Configure the Sleep time properties for the Test action:

Type the Value (ms) for the sleep action.
Add and configure appropriate sleep time Actions. Repeat as necessary.

Click OK to accept the configuration.

Action Properties

The properties for the Test action type are described below.

Property	Description	XML
Type	Specifies the action type for the action.	type
Timeout
Value (UDC or sec)	Specifies how the amount of time the test action will wait. Options include an actual value in seconds or a value from an associated point: if the Timeout Value type (timeoutValueType) is Self, then this value the amount of time the test action will wait. "0" indicates infinite amount of time. if the Timeout Value type (timeoutValueType) is UDC, then the value associated with the configured point will be used in the wait action.	timeoutValue
Type	Specifies the timeout value type. Values include Self or UDC.	timeoutValueType
Relative facility link	Specifies the relative facility tag to use for the action. E.g., Separator 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.	timeoutRelativeFacilityLink
Update	Indicates whether to update the actual timeout. Click the check box to enable the update. Options include True or False. If this value is set to True, then the point resolved in this action will be updated with the actual time spent waiting.	timeoutValueUpdate
Actual UDC	Specifies the actual UDC to use to post as a running count of how long the actions have been in the timeout. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.	timeoutActualUdc
Condition
UDC	Specifies the UDC to use for the conditional expression. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.	udc
Relative facility link	Specifies the relative facility tag to use for the conditional expression for this 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.	conditionRelativeFacilityLink
Operator	Specifies the operation used for the comparison. Acceptable values include: Equal — = (operator="=") Greater than — > (operator=">") Greater than or equal — >= (operator=">=") Less than — < (operator="<") Less than or equal — <= (operator="<=") Not equal — <> (operator="<>")	operator
Value	Specifies the alphanumeric value to compare to the point value in the conditional expression.	value
Actions	The Test action type also supports a series of conditional properties that can be used to interact with the primary test action. They represent the values of an expression and when the expression is true, the conditional actions defined will be executed. For example, specify an Exit action to exit the well test sequence. In the XML configuration these conditional actions are specified in the <ExitOnTagValueActions> element. To add a condition action Click to add a new conditional action to this Test action. Select the appropriate action from the drop-down menu. Options include: Exit Action Type Header Command Action Type Monitor Action Type Point Value Compare Action Type Script Action Type Set Point Action Type Test Action Type UIS Command Action Type Click or the action type name to edit the action. Click to delete the action type, as necessary. Repeat to add as many actions as required. See each action type listed above for user assistance.	<ExitOnTagValueActions>
Sleep time
Value (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 to add a new sleep time action to this Test action. Select the appropriate action from the drop-down menu. Options include: Exit Action Type Header Command Action Type Monitor Action Type Point Value Compare Action Type Script Action Type Set Point Action Type Test Action Type UIS Command Action Type Click or the action type name to edit the action. Click 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>