UIS Command Action Type

The UIS Command (UisCommand) action type is used to send a UIS Command to a configured device.

UIS Command configuration

Click the thumbnail to see the
UIS Command Action configuration

To configure a UIS Command action

A UIS Command 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 UIS Command action type from the Action type list. The action's properties will appear on the right.
  3. Configure the Command for the UIS Command action.
  4. Optional. Select a relative facility tag from the Relative facility link drop-down menu.
  5. Configure the Status UDC for the UIS Command action.
  6. Configure the Parameters for the Script action:
  1. Click to Add parameter to the Script action. Click the Parameter row to configure the Parts for the parameter as described below.
  2. Click to Add part to the parameter. Configure the part's properties. Repeat as necessary for each part type.
  3. Add as many Parameters as required for this Script action.
  1. Click OK to accept the configuration.

Action Properties

The properties for the UIS Command action type are described below.

Property Description XML

Type

Specifies the action type for the action.

type

Command

Specifies the name of the UIS command to execute, E.g., POLL, SETMSVPOS1, SETMSVPOS2, SETMSVPOS3, SETMSVPOS4, START, etc.

command

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.

E.g., Separator

relativeFacilityLink

Status UDC

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.

statusUDC

Parameters

The Script or UIS Command action type may contain optional Parameters, which are used to pass in additional parameters to the action.

Each Parameter contains one or more Parts, which are used to build strings that allows further configuration of the parameter. There are four types of Parts, each with associated configuration properties:

  • Text — indicates a hard-coded Value that will be used in the parameter
  • PointValue — indicates the UDC and Relative Facility Link that will be used in the parameter
  • PointAttribute — indicates the UDC, Relative Facility Link, and the point attribute that will be used in the parameter
  • FacilityAttribute — indicates the Relative Facility Link, and the facility attribute value that will be used in the parameter

Note: The maximum length of the command parameter string for a Send UIS Command message is 1200 characters. CygNet Software will report if a UIS Command message exceeds the maximum parameter length of 1200 characters.

To add a parameter

  • Click Add parameter to add a new parameter to this action.
  • Select the Parameter (0 parts) row to expand the Parameter configuration to display the Part grid.
  • Add Parts as described below.
  • Click Delete this item to delete a selected parameter, as necessary.

To add a part

  • Click Add part to add a part type and select a Part from the drop-down menu:
  • Text
  • Point Value
  • Point Attribute
  • Facility Attribute
  • Select the Part type row to expand the Part configuration.
  • See the Part Type Properties section below for information about the configuration options.
  • Click Delete this item to delete a selected part, as necessary.

<Parameters>

<Parameter>

<Part>

Part Type Properties

There are four part types, which are used to build strings that allow further configuration of the parameter. Perform the following steps to configure each type of part:

  1. Click the desired part type heading to expand the configuration field.
  2. Configure the properties described below for each part type, and the values will be added to the Configuration String in the part type heading.
  3. Click Delete this item to delete any unnecessary part type.

Text Part Type

Property Description XML

Type

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

type

Value

Specifies the value to be used for the text part type.

value

Point Value Part Type

Property Description XML

Type

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

type

UDC

Specifies the UDC to use to obtain the value for this point, point attribute, or facility attribute. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

udc

Relative facility link

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

relativeFacilityLink

Point Attribute Part Type

Property Description XML

Type

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

type

UDC

Specifies the UDC to use to obtain the value for this point, point attribute, or facility attribute. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

udc

Relative facility link

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

relativeFacilityLink

Attribute

Specifies a value, a point attribute, or a facility attribute. 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.

attribute

Facility Attribute Part Type

Property Description XML

Type

Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.

type

Relative facility link

Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.

relativeFacilityLink

Attribute

Specifies a value, a point attribute, or a facility attribute. 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.

attribute

Back to top