Parameters
- Last UpdatedJul 13, 2023
- 4 minute read
The <Parameter> element defines the attributes that will be displayed as Presentation Options to the user when they insert a Composite Genie on to a graphics page. It is comprised of the following attributes for each parameter:
|
Attribute |
Description |
|---|---|
|
Name |
Unique name for the parameter. |
|
Label |
Display name for the parameter. |
|
Type |
Data type of the parameter – Boolean, Integer or String. |
|
MinLength |
Minimum number of characters that the parameter value needs to contain. |
|
MaxLength |
Maximum allowable characters for the parameter value |
|
MinValue |
Minimum value that can be specified for the parameter |
|
MaxValue |
Maximum allowable value for the parameter |
|
DefaultValue |
Default value set for the parameter |
|
NamingRules |
Naming rules can be used to force the user to enter parameter values in a particular format. For example, to use equipment naming rules, set this attribute to "Equipment". Refer to the Equipment Naming Rules and Tag Naming Rules sections for more information. |
|
Description |
Description of the parameter. This appears at the bottom of the Parameter Options dialog box when the operator clicks to specify the value for a parameter. It is recommended that you enter a description for the parameter in order to help engineers to specify valid values for the parameters. |
|
Values |
List of selectable values if an option is to be displayed as a dropdown list in the Parameter Options dialog box. To create a list of values, each value needs to be declared with a unique ID and Label. The label will appear as one of the values the user can select. For example, if you need an option titled "Orientation" with the values "Vertical" and "Horizontal" available for selection, the following code needs to be included in the Parameters element:
|
Parameter definitions can include the <Dependency> element to show or hide parameters. This element can use Global, Parameter or Composite conditions to show or hide a parameter based on the operator's selection of an option or value. For more information about conditions, refer to Conditions.
Example - Simple
This is a simple example where a dependency has been defined using the <Dependency> element to show the Label parameter only if the operator selects the Display Label checkbox. This is achieved through the use of a Conditions. You can also use Parameter and/or Composite conditions within the <Dependency> element.
The above code will display the following presentation options.
Example - Complex
This example provides a slightly more complex scenario with parameters to be displayed based on the operator’s selection of value. Therefore, a list of values and a dependency need to be defined.
-
Refer to the XML code for the "Number of sub equipment" parameter. This parameter can take the values 0, 1, 2, 3, 4 or 5. The <Values> attribute defines this list of selectable values (see the sample code below).
-
Depending upon the value the operator selects for this parameter, the Sub Equipment parameter(s) will be displayed. For example, if the operator selects 0 for the "Number of sub equipment" parameter, the Sub Equipment parameter will not be displayed, if the user selects 1, a single Sub Equipment parameter with the label Sub Equipment #1 Name will be displayed, if the user selects 2, two Sub Equipment parameters with the labels Sub Equipment #1 Name and Sub Equipment #2 Name will be displayed and so on. The user can choose up to 5 pieces of sub equipment.
To be able to select 5 pieces of sub equipment, a parameter each needs to be defined for each piece of sub equipment. In addition, each of these parameters needs to have a dependency defined within it (see below for sample code that shows the definition for two sub equipment pieces).
-
A dependency is defined using the <Dependency> attribute. For Sub Equipment 1, global condition "Show_MEO1" needs to be satisfied. For detailed information about conditions, see the Conditions topic.
