SetPoint Action Type

The Set Point (SetPoint) action type is used to issue a SetPoint to a CygNet point. This action can be used to provide status throughout the command sequence.

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

Example

</Actions>

SetPoint Action Type Attributes

The SetPoint action type has the following associated configuration attributes:

Attribute	Required	Description
attribute (used with ValueType)	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.
relativeFacilityLink (used with Action)	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.
sourceRelativeFacilityLink (used with ValueType)	Yes	If the Value Type (valueType) is PointValue, PointAttribute, or FacilityAttribute, use this field to indicate the source Relative Facility Link. If you want to use the Value Type feature, you must make sure that the sourceRelativeFacilityLink correctly resolves to a valid facility. 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.
type (used with Action)	Yes	Specifies the action type for the action. E.g., type="SetPoint"
udc (used with Action)	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.
sourceUdc (used with ValueType)	Yes	If the Value Type (valueType) is PointValue or PointAttribute, use this field to indicate the source UDC. If you want to use the Value Type feature, you must make sure that the sourceUdc correctly resolves to a valid point. 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 (used with ValueType)	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: 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.