Exit Action Type
The Exit action type is used to stop the current well in test. When executed it will exit out of the entire action sequence. The only required attribute is the action type. An optional set of attributes are available to issue a setpoint. These are the same as defined in the SetPoint action type.
To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.
Example
|
<ExitOnTagValueActions> <Action type="Exit" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="POMSV=1000" /> </ExitOnTagValueActions>
<FalseAction> <Action type="Exit" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Failed 1" /> </FalseAction>
<Actions> <Action type="Exit" exitCommandSetting="True" udc="MSG" relativeFacilityLink="Separator" valueType="Text" attribute="" value="Monitor 2" /> </Actions> |
Exit Action Type Attributes
The Exit action type has the following associated configuration attributes:
| Attribute | Required | Description |
|---|---|---|
|
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. |
|
exitCommandSetting |
No |
Indicates whether to exit out of the entire action sequence. If selected, when the Exit action is performed, the entire command sequence will halt at that point. If not selected, when the Exit action is performed, the sequence just exits to the next item in the command sequence. Example Say you have a Condition in a Monitor or Test action that when met you want to exit the action and continue in the sequence, you would not select the Exit command option. However, if the sequence is in a Monitor or Test action and checking for the communication status of a UIS command, and you want to quit the entire command if the UIS command isn’t successful, then you would select the Exit Command option. |
|
relativeFacilityLink |
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. E.g., Separator |
|
type |
Yes |
Specifies the action type for the action. |
|
udc |
No |
Specifies the UDC to use for the point. Click the browse button to open the Select UDC dialog box and select an appropriate UDC. |
|
value |
No |
If the Value Type (valueType) is Text, then this field specifies the text used in the action. Does not appear/is not required if the Value Type (valueType) is None or Text. |
|
valueType |
Yes |
Specifies the Value type (valueType). There are five possible values:
|


