Create Parameters
- Last UpdatedApr 08, 2024
- 3 minute read
Parameters are user defined variables that can be used in the create rule expressions. A parameter can either be a value derived from an expression or information requested from the user. If the Expression field is left unset then the user is prompted at the time of creation. When using a parameter it should be treated as if the value is being substituted into the expression before execution rather than as a PML variable.
The Create Parameters part of the Data Sources tab is populated with attributes:
|
User-defined name |
The name of the parameter, as used in the expressions. |
|
User Prompt |
The prompt to the user to request a value. |
|
Expression |
The expression used to derive a value for the parameter, if unset the user is prompted. If the element is being created for a SRCELE Data Source then the expression is executed on the element defined by the parent Data Source otherwise it is executed on the Current Element (CE). |
|
Expression Type |
The syntax of the expression (PML or XPATH), PML expression must be PML 1 only. |
|
UDA Type |
The data type for the parameter, this affects user entry for the parameter and not the parameter use. |
|
Required |
Indicates the parameter is required and whether element creation can succeed without it. |
If a parameter is used to request the fluid from a user, the attributes in the Create Parameters part of the Data Sources tab must be populated.
|
User-defined name |
Fluid |
|
User Prompt |
Fluid Code |
|
Expression |
|
|
Expression Type |
PML |
|
UDA Type |
TEXT |
|
Required |
True |
The value input by the user at the time of creation can be used in the Owner Expression and in attribute the rule:
Owner Expression '/Equipment_' + '$!Fluid'
|
Attribute Rule |
|
|
Attribute |
:Fluid |
|
Expression |
‘$!Fluid’ |
Note:
The example expressions contains $!Fluid in '' characters since the value is substituted
into the expression before the expression is evaluated. The parameter is not a PML variable.
Attribute Rules
The Attribute Rules define the initial values of attributes when the element is created. These can be fixed by specifying expressions to derive the value or the user can be forced to input a value at the time of element creation.
The Attributes Rules part of the Data Sources tab is populated with attributes:
|
User Prompt |
The prompt which displays to the user. |
|
Attribute |
The attribute to set the value of. |
|
Expression |
Expression to derive a value, if left unset the user is prompted for a value. |
|
Expression Type |
The syntax of the expression (PML or XPATH). |
|
Required |
Indicates whether a value is required and whether element creation can succeed without it. |
Status Rules
The Status Rules assign the identified status definition to the element on creation or prompts the user for a status definition to apply if the status definition is not defined.
The Create Status part of the Data Sources tab is populated with attributes:
|
User Prompt |
The prompt which displays to the user. |
|
Status Definition Ref |
The status to assign to the created element, if left unset then a prompt is displayed. |
|
Required |
Indicates whether a status must be assigned for the element creation to succeed. |