Actions, Action, Action Types

A <Command> contains one or more <Actions> elements.

To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.

Example

See each of the Action Types listed below for examples.

Actions

The <Actions> element has one type of child element, <Action>, and has no attributes.

Action

Each <Actions> element contains a list of <Action> elements associated with the command. The actions defined in each command will be executed when the header queue point is updated with one of these values.

Action Properties

The <Action> element has the following properties:

Property	Description
Case Sensitive	Yes
Required	Yes
Number of Instances Allowed	Unlimited
Parent Element	<Actions>
Child Elements	<ExitOnTagValueActions> <FalseAction> <Monitors> <Parameters> <SleepTimerActions> <TimeoutActions> <TrueAction> Note: Not every action type supports all these child elements. See each action type for more information.
Attributes	type

Action Attributes

An <Action> element has the following attributes, and each attribute is associated with a particular action type. All attributes are listed below, but see the action type for a full explanation of its usage.

Attribute	Required	Description	Used with Action Type
type	Yes	Specifies the action type for the action. The type of action to be performed with this <Action>. There are eight (8) possible <Action> types, which correspond to the Well Test Device Logic Building Blocks. Note: All points referenced in these actions must be manually created.	Exit HeaderCommand PointValueCompare Monitor Script SetPoint Test UisCommand
Attribute	No	Specifies a value, a point attribute, or a facility attribute. If the Value Type (valueType) is PointAttribute or FacilityAttribute, then this field indicates which attribute will be used. The available values to use for this field can be found in the CygNet.API Help file under the CygNet.Data.Core > CygNetCoreProperties.CygNetProperty Enumeration section.	Exit SetPoint
command	Yes	Specifies the name of the command defined at the header level. or Specifies the name of the UIS command to execute, E.g., POLL, SETMSVPOS1, SETMSVPOS2, SETMSVPOS3, SETMSVPOS4, START, etc.	HeaderCommand UisCommand
conditionRelativeFacilityLink	No	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.	Test
operator	No	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="<>")	Monitor PointValueCompare Test
relativeFacilityLink	No	See the action type for definition.	Exit SetPoint Script UisCommand
script	Yes	Specifies a path to a file to perform additional scripted actions, including processing the well test data and producing the values needed for the well test record. For example: Local — c:\temp\GetHistoricalWellTest_Calculation.vbs BSS — MYSITE.BSS\WELLTEST\ProcessCalculationsGeneric.vbs Point — MYSITE.HSS:WELLTEST_SCRIPT	Script
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.	Monitor Test
source	Yes	Specifies the path to the script file. Options include Local, BSS, or Point.	Script
statusUDC	Yes	Specifies the name of the status UDC (if configured) where the status of the UIS Command will be posted. E.g., SYCMDSTAT. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.	UisCommand
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.	Monitor
timeoutRelativeFacilityLink	No	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.	Test
timeoutValue	Yes	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.	Test
timeoutValueType	Yes	Specifies the timeout value type. Values include Self or UDC.	Test
timeoutValueUpdate	No	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.	Test
udc	No	See the action type for definition.	Exit SetPoint Script Test
value	No	See the action type for definition.	Exit SetPoint Test
value1	Yes	Specifies the first value to use when comparing the point value in the expression: if the Value 1 Type (value1Type) is Self, then the value of this property will be used in the comparison. if the Value 1 Type (value1Type) is UDC, then the value from the point will be used in the comparison. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.	PointValueCompare
value1relativeFacilityLink	No	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.	PointValueCompare
value1type	Yes	Specifies the first value Type (value1Type) property. Options include Self or UDC.	PointValueCompare
value2	Yes	Specifies the second value to use when comparing the point value in the expression: if the Value 2 Type (value2Type) is Self, then the value of this property will be used in the comparison. if the Value 2 Type (value2Type) is UDC, then the value from the point will be used in the comparison. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.	PointValueCompare
value2relativeFacilityLink	N	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.	PointValueCompare
value2type	Yes	Specifies the second value Type (value2Type) property. Options include Self or UDC.	PointValueCompare
valueType	Yes	Specifies the Value type (valueType). There are five possible values: None — indicates no value will be used in the action. The Value and Attributes properties are not required. Text — indicates a hard-coded value that will be used in the action. Specify the value in the Value property. PointValue — indicates that the point value will be used in the action. The Value and Attributes properties are not required. PointAttribute — indicates that a point attribute will be used in the action. The Attribute property displays a drop-down menu of available point attributes. FacilityAttribute — indicates that a facility attribute will be used in the action. The Attribute property displays a drop-down menu of available facility attributes.	SetPoint

Exit Action Type

HeaderCommand Action Type

Monitor Action Type

PointValueCompare Action Type

Script Action Type

SetPoint Action Type

Test Action Type

UisCommand Action Type