Parameters, Parameter, Part
The UisCommand and Script action type can contain optional <Parameters> elements. These are used to pass in any parameters to the UIS Command or the VBScript. 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.
To learn about how these elements relate to other elements in a well test configuration XML structure, see Well Test Hierarchy.
Example
|
<Action type="Script" script="c:\temp\ProcessCalculations.vbs" source="Local" udc="WELLTEST" relativeFacilityLink=""> <Parameters> <Parameter> <Part type="Text" value="value=" /> <Part type="PointValue" udc="POMSV" relativeFacilityLink="Separator" attribute="Value" /> </Parameter> </Parameters> </Action> |
Parameters
The <Parameters> element has one type of child element, <Parameter>, and has no attributes.
Parameter
A <Parameters> element has one or more <Parameter> child elements, each containing one or more <Part> elements. The <Parameter> element has no attributes.
Parameter Properties
The <Parameter> element has the following properties:
| Property | Description |
|---|---|
|
Case Sensitive |
Yes |
|
Required |
Yes |
|
Number of Instances Allowed |
Unlimited |
|
Parent Element |
<Parameters> |
|
Child Elements |
<Part> |
|
Attributes |
None |
Part
The <Part> element is used to build configuration strings that are used to further configure the parameter.
Part Properties
The <Part> element has the following properties:
| Property | Description |
|---|---|
|
Case Sensitive |
Yes |
|
Required |
Yes |
|
Number of Instances Allowed |
Unlimited |
|
Parent Element |
<Parameter> |
|
Child Elements |
None |
|
Attributes |
Attribute relativeFacilityLink type udc value |
Part Type Attributes
|
<Parameters> <Parameter> <Part type="Text" value="OIL=" /> <Part type="PointValue" udc="ROIL" relativeFacilityLink="Separator" attribute="" /> </Parameter> <Parameter> <Part type="Text" value="WATER=" /> <Part type="PointValue" udc="RH2O" relativeFacilityLink="Separator" attribute="" /> </Parameter> <Parameter> <Part type="Text" value="GAS=" /> <Part type="PointValue" udc="RGAS" relativeFacilityLink="Separator" attribute="" /> </Parameter> <Parameter> <Part type="Text" value="DURATION=" /> <Part type="PointValue" udc="TMWTACT" relativeFacilityLink="" attribute="" /> </Parameter> <Parameter> <Part type="Text" value="FACILITYTAG=" /> <Part type="FacilityAttribute" relativeFacilityLink="" attribute="FacilityTag" /> </Parameter> <Parameter> <Part type="Text" value="TIMESTAMP=" /> <Part type="PointAttribute" udc="TMWTACT" relativeFacilityLink="" attribute="Timestamp" /> </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. |
