Everything E3D

Property Definitions

Save PDF

Property Definitions

Save PDF

Last UpdatedSep 25, 2023
13 minute read

When a 3D model is created the user sets the dimensions and relative positions of the design elements to specific values to give a meaningful representation in the 3D view. These settings are largely irrelevant for the Design Template. When the Design Template is used in a design application, the dimensions and positions of the primitives are reset by reference to a set of parameterized rules which adjust the geometry to suit the local circumstances. These rules are defined in terms of the Design Template’s properties.

Each Design Template property represents an 'attribute' of the Design Template which can be adjusted by reference to the parameterized rules when used in a design instance.

The template properties are stored in Design Data (DDAT) elements, owned by a Design Dataset (DDSE) element, which is itself owned by the TMPL element.

To define the Design Template properties, make sure the correct Design Template is highlighted in the Template Browser.

On the Design Templates tab, in the Modify group, click Property Definitions to display the Define Template Properties window.

The name of the currently selected Design Template displays at the top of the Define Template Properties window.

The Property part of the Define Template Properties window allows the user to define the identification fields of the Design Template property.

Description	Input a property description into the Description field.
Key	Input a property value into the Key field.
Definition	Select a Definition from the drop-down list, refer to Property Definition for further information.
No.	Input a property number into the No. field.
Display	Select the check box to display the value of the property on the data-entry window when the template is instanced in a design.

The input values entered in the Description, Key and No. fields must be unique. If a duplicate value is entered, the user receives an error message summarizing the problem.

Property Definition

The Definition drop-down list allows the user to define how the value of the property is derived when the Design Template is used in a design instance.

Design Parameter	Allows the user to define design data, for example, Overall Length.
Attribute	Allows the user to define a named attribute, for example DIAM.
Expression	Allows the user to define an evaluating expression, Expression Builder is activated by default in the Data part of the Define Template Properties window, refer to Expression Builder for further information.
Plotfile	Allows the user to define the name of a plotfile to display refer to Associate a Plotfile with a Design Template for further information.
Specification Ref	Allows the user to define a SpecRef, for example, Profile.
Sub Element Ref	Allows the user to reference a subsidiary element (for example, sub-equipment, refer to Define References to Sub-equipment for further information.).

The Data part of the Define Template Properties window allows the user to define the data fields of the Design Template property.

Type	Select a data type from the Type drop-down list.
Default	Input a default value in the Default field. The Design Templates application adds parentheses around the default value automatically. It is optional whether or not the user enters parentheses when inputting a default value.
expr	Input an expression value in the expr field. For example, HEIG of PLOO 1 of PANEL indicates the Height attribute of the Panel Loop element owned by the Panel.
Range	Allows the user to input acceptable minimum (From) and maximum (To) values for the property. When the Design Template is used in a design instance, only values in the specified range are accepted.
Values	Allows the user to define specific valid values for the property. When the Design Template is used in a design instance, the set values are available from a list. Refer to Define Valid Values for further information.

The Currently Defined Properties part of the Define Template Properties window displays a list of defined properties. The user can select a defined property to include, replace or remove.

Use Picked Item	Allows the user to select an item for a Specification Reference using a cursor pick in the 3D view. The user must select Specification Ref from the Definition drop-down list of the Define Template Properties window. The user is prompted: Pick Item that SPREF is to be selected from :
Include	Click to add a property to the list of Currently Defined Properties.
Replace	Click to replace the selected property with the display values in the Define Template Properties window.
Remove	Click to remove the selected property from the list of Currently Defined Properties.
Navigate to Definition	Right-click the selected property to navigate to the Design Data (DDAT) element in the Model Explorer.

Expression Builder

The Expression Builder allows the user to define an evaluating expression from a series of selections.

On the Define Template Properties window, select Expression Builder to display the Position Rule Definition window

Expression	Allows the user to build up a rule expression from the list of properties, names, functions and operators. The Design Templates application adds extra spaces and parentheses around expressions by default. It is optional whether or not the user enters extra spaces and parentheses when building an expression.
Properties	Select from the list of properties, the property displays in the Expression field. Select Current, Local or Template from the Properties drop-down list to define the list of properties.
Local Names	Select from the list of local names, the local name displays in the Expression field. Select Template or Dataset from the Local Names drop-down list to define the list of local names.
Functions	Select from the list of functions, the function displays in the Expression field.
Operators	Select from the list of operators, the operator displays in the Expression field.

Click OK to store the evaluating expression definition, Back to undo the last selection or Cancel to discard any inputs and close the Position Rule Definition window. The user is returned to the Define Template Properties window.

Define Valid Values

The Set Valid Values window allows the user to create and define a list of specific valid values for the Design Template when used in a design instance.

On the Define Template Properties window click Define Valid Values to display the Set Valid Values window.

The user can input values in the List of Valid Values separated by either a space or on separate lines.

Note: The List of Valid Values should include the default value entered into the Data part of the Define Template Properties window to make sure that a designer can easily reset the value if a change is required.

Click OK to store the valid values data or Cancel to discard any inputs and close the Set Valid Values window.

Click Include on the Define Template Properties window to display the property in the list of Defined Valid Values. The values display in Model Explorer as VVALUE elements contained within a DDAT element and a DDSE element.

Associate a Plotfile with a Design Template

When a designer creates a design instance from a Design Template, for example, an equipment template, the Create Equipment window incorporates a Plotfile selection which can display an associated plotfile; typically a dimensioned plot of the parameterized item.

If a plotfile is not associated with the Design Template, the Plotfile selection displays as inactive, when referenced in a design instance.

To associate a plotfile with a design template, on the Design Templates tab, in the Modify group, click Properties to display the Define Template Properties window.

Description Key	Input a property description into the Description field.
Description Key	Input a property value into the Key field.
Definition	Select Plotfile from the drop-down list to create a plotfile property.
No.	The field becomes inactive when Plotfile is selected from the Definition drop-down list.
Display	Select the check box to display the value of the property on the data-entry window when the template is instanced in a design.

The values entered in the Description and Key fields must be unique. If a duplicate value is entered, the user receives an error message summarizing the problem.

The Data part of the Define Template Properties window allows the user to define the data fields of the plotfile property.

Type	Select PPLT from the drop-down list to insert a portrait plotfile property or select LPLT to insert a landscape plotfile property.
Sub-Dir	Input the path to the default plotfile directory as specified by the AVEVA_DESIGN_PLOTS environment variable. Input a filename in the field directly below the Type field with a .plt suffix.
Range	The field becomes inactive when Plotfile is selected from the Definition drop-down list.
Values	The field becomes inactive when Plotfile is selected from the Definition drop-down list.

The Currently Defined Properties part of the Define Template Properties window displays a list of defined properties, the user can select a defined property to include, replace or remove.

Use Picked Item	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Include	Click to add a property to the list of Currently Defined Properties.
Replace	Click to replace the selected property with the display values in the Define Template Properties window.
Remove	Click to remove the selected property from the list of Currently Defined Properties.
Navigate to Definition	Right-click the selected property to navigate to the Design Data (DDAT) element in the Model Explorer.

Define References to Sub-equipment

For more complex Design Templates, the user may wish to reference other Design Templates as sub-equipment to make up part of the overall design instance.

For example, when instanced in a design, sub-equipment can be referenced.

Each Valid Value (VVALUE) under the data element stores a reference to a Specification Component (SPCO) which has its Template Reference (TMPR) pointing to a TMPL representing a specific vessel end (as illustrated for the default setting).

The Sub-equipment (SUBE) elements shown in the hierarchy are created under the Equipment, by default, when the properties are set for the Design Template instance.

To reference to sub-equipment, make sure the correct Design Template is highlighted in the Template Browser.

On the Design Templates tab, in the Modify group, click Properties to display the Define Template Properties window.

The Property part of the Define Template Properties window allows the user to define the identification fields of the Design Template property.

Description	Input a property description into the Description field.
Key	Input a property value into the Key field.
Definition	Select Sub Element Ref from the drop-down list to insert a reference to sub-equipment property.
No.	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Display	Select the check box to display the value of the property on the data-entry window when the Design Template is instanced in a design.

The input values entered in the Description and Key fields must be unique. If a duplicate value is entered, the user receives an error message summarizing the problem.

The Data part of the Define Template Properties window allows the user to define the data fields of the sub-equipment property.

Type	Select Sub Ref from the drop-down list to insert a reference to a sub-equipment property.
Default	Input the name of the default sub-equipment template.
expr	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Range	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Values	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Define Valid Values	Allows the user to define specific sub-equipment values for the property. Refer to Define Valid Values for further information.

The Currently Defined Properties part of the Define Template Properties window displays a list of defined properties, the user can select a defined property to include, replace or remove.

Use Picked Item	The field becomes inactive when Sub Element Ref is selected from the Definition drop-down list.
Include	Click to add a property to the list of Currently Defined Properties.
Replace	Click to replace the selected property with the display values in the Define Template Properties window.
Remove	Click to remove the selected property from the list of Currently Defined Properties.
Navigate to Definition	Right-click the selected property to navigate to the Design Data (DDAT) element in the Model Explorer.

Define Sub-equipment Values

The Set Valid Values window allows the user to create and define a list of specific valid values for the Design Template when used in a design instance.

On the Define Template Properties window, click Define Valid Values to display the Set Valid Values window.

The user can input values in the List of Valid Values separated by separate lines or populate the list from the Add CE or Pick Element commands.

Add CE

Click Add CE to include Current Element in the List of Valid values.

For example, to add /EXAMPLE/SUBE/VESS/DishedEnd1 the user must navigate to the following path in the Catalogue Explorer.

Pick Element

Allows the user to reference sub-equipment into the Design Template using a cursor pick in the 3D view.

The user is prompted to Identify Element to use :

Rule Definition

Allows the user to define sub-equipment rules for the property. Refer to Define Sub-equipment Rules for further information.

Define Sub-equipment Rules

The Associated Rule Definition window allows the user to create, modify and delete sub-equipment rules.

The Rules Defined part of the Associated Rule Definition window displays a list of defined rules, the user can select a defined rule to include, replace or remove.

Description	Input a rule description into the Description field.
Purpose	Leave the selection as Sub-Equipment Reference from the drop-down list.
Attribute	Select an attribute from the drop-down list.
Definition	Input a rule into the Key field. Alternatively select Attribute Rule Expression Builder to create an associated rule, refer to Attribute Rule Expression Builder for further information.
Include	Click to add a rule to the list of Rules Defined.
Replace	Click to replace the selected rule with the display values in the Associated rule definition window.
Remove	Click to remove the selected property from the list of Rules Defined.

Attribute Rule Expression Builder

The Attribute Rule Expression Builder allows the user to define an attribute rule from a series of selections.

On the Associated Rule Definition window, select Attribute Rule Expression Builder to display the Associated Rule Definition window

Expression	Allows the user to build up a rule expression from the list of properties, local names, functions operators. The Design Templates application adds extra spaces and parentheses around expressions by default. It is optional whether or not the user enters extra spaces and parentheses when building an expression.
Properties	Select from the list of properties. The property displays in the Expression field. Select Current, Local or Template from the Properties drop-down list to define the list of properties.
Local Names	Select from the list of local names. The local name displays in the Expression field. Select Template or Dataset from the Local Names drop-down list to define the list of local names.
Functions	Select from the list of functions. The function displays in the Expression field.
Operators	Select from the list of operators. The operator displays in the Expression field.

Click OK to store the position rule definition, Back to undo the last selection or Cancel to discard any inputs and close the Attribute Rule Definition window. The user is returned to the Associated Rule Definition window.

Click OK to apply the rule definitions to the valid values or Cancel to discard any inputs and close the Associated Rule Definition window. The user is returned to the Set Valid Values window.

Click OK to store the valid values data or Cancel to discard any inputs and close the Set Valid Values window.

Click Include on the Define Template Properties window to display the property in the list of Defined Valid Values. The values display as VVALUE elements in Model Explorer, contained within a DDAT element and a DDSE element.

The associated rule definitions display as ATTRRL elements contained within a DDAT element. When the template is instanced in a design, the associated rules are executed and sub-equipment references are defined accordingly.

Everything E3D

Property Definitions

Table of Contents

Property Definitions

Related Links