Script Action Type

Well Test > Configuring CygNet Well Test > Configuring Well Test Using XML > Elements and Attributes > Script Action Type

Script Action Type

The Script action type is used to run a specified VB script that will process well test data and produce the values needed for the well test record. See Processing and Storing Well Test Results for more information about how the Well test results are written out to the VHS.

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

Example

</Parameter>

</Parameter>

</Parameter>

</Parameter>

</Parameters>

</Action>

</TrueAction>

Script Action Type Attributes

The Script action type has the following associated configuration attributes:

Attribute	Required	Description
relativeFacilityLink	No	Used with the UDC for the override point to use when posting the well test record.
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
source	Yes	Specifies the path to the script file. Options include Local, BSS, or Point.
type	Yes	Specifies the action type for the action. E.g., type="Script"
udc	No	Specifies the UDC for the point to use when posting the well test record. This is an optional override value. The "Result" UDC defined in the UdcDef element will be used by default. E.g., WELLTEST. Click the browse button to open the Select UDC dialog box and select an appropriate UDC.

Parameters, Parameter, Part

The Script action type can contain optional <Parameters> elements. These are used to pass in any parameters to the VB script. A <Parameters> element has defined <Parameter> elements, each containing one or more <Part> elements. Parts are used to build strings that are used to further configure the action.

Parameters, Parameter, and Part elements can also be used with the UisCommand action type.

Part Type Attributes

Example

</Parameter>

</Parameter>

</Parameter>

</Parameter>

</Parameter>

</Parameter>

</Parameters>

There are four types of <Part> elements, with the following associated configuration attributes:

Text Part Type

Attribute	Required	Description
type	Yes	Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.
value	Yes	Specifies the value to be used for the text part type.

PointValue Part Type

Attribute	Required	Description
type	Yes	Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.
attribute	Yes	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.
relativeFacilityLink	No	Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.
udc	Yes	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.

PointAttribute Part Type

Attribute	Required	Description
type	Yes	Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.
attribute	Yes	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.
relativeFacilityLink	No	Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.
udc	Yes	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.

FacilityAttribute Part Type

Attribute	Required	Description
type	Yes	Specifies the type of value for the part type. There are four part types: Text, Point Value, Point Attribute, and Facility Attribute.
attribute	Yes	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.
relativeFacilityLink	No	Specifies the base facility tag to use to determine the resolved relative facility tag to use for this point, point attribute, or facility attribute.
udc	Yes	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.