Professional Documents
Culture Documents
(12.1)
TRAINING GUIDE
AVEVA Engineering
Tags (Administration)
TM-3552
www.aveva.com
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Revision Log
Updates
Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers please report it to AVEVA
Training & Product Support at tps@aveva.com
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar
losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of
data or information; any special, indirect, consequential or pure economic loss, costs, damages,
charges or expenses which may be suffered by the user, including any loss suffered by the user
resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of
whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence)
or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with
the performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year
in which the user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall
take precedence.
www.aveva.com
© Copyright 1974 to current year. 2
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part
of it (including source code, object code, any data contained in it, the manual and any other documentation
supplied with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this
document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or
transmitted without the prior written permission of AVEVA Solutions Limited. Where such permission is
granted, it expressly requires that this copyright notice, and the above disclaimer, is prominently displayed at
the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in
this publication may be incorporated into any third-party software, product, machine, or system without the
prior written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised
action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the
terms and conditions of the respective software licences, and in accordance with the relevant User
Documentation.
Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA
shall not be liable for any breach or infringement of a third party's intellectual property rights where such
breach results from a user's modification of the AVEVA software or associated documentation.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
TM
The AVEVA Tags user interface is based on the Microsoft® Office Fluent user interface.
Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its
name or logo belongs to its respective owner.
www.aveva.com
© Copyright 1974 to current year. 3
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
www.aveva.com
© Copyright 1974 to current year. 4
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Contents
1 Introduction .............................................................................................................................................. 8
1.1 Aim..................................................................................................................................................... 8
1.2 Objectives ......................................................................................................................................... 8
1.3 Prerequisites .................................................................................................................................... 8
1.4 Course Structure .............................................................................................................................. 8
1.5 Using this guide ............................................................................................................................... 8
2 Data Model Setup for AVEVA Tags - Overview ..................................................................................... 9
2.1 Entering AVEVA Lexicon Application ............................................................................................ 9
Exercise 1 - Entering AVEVA Lexicon Application .................................................................................... 12
3 Developing Data Model Definition – Overview ................................................................................... 13
3.1 Decision on type of Engineering item to Create and Manage in AVEVA Tags ........................ 13
3.2 Decision on type of Attributes Engineering Items Required ..................................................... 13
3.3 Discipline Requirements to Modify / Update Engineering Item Data ....................................... 14
3.4 Data Model Definition Setup - Required Steps ........................................................................... 14
Exercise 2 – Develop a Data Model Definition Using Flow Chart Diagram.............................................. 16
4 Create Engineering Databases ............................................................................................................. 17
4.1 Creating Engineering Databases and Distributed Hierarchy .................................................... 17
Exercise 3 – Creating Engineering Database and Distributed Hierarchy ................................................ 21
5 Data Model Definition for Engineering Elements / Items ................................................................... 22
5.1 Create Enginering Element UDETs .............................................................................................. 23
5.2 Create / Assign User Defined Attribute (UDAs) to UDETs ......................................................... 25
Exercise 4 – Create Engineering Element UDET and UDAs...................................................................... 28
6 Distributed Attribute Data Model Definition Setup - Overview ......................................................... 29
6.1 Distributed Data Model Definition Configuration ....................................................................... 30
7 Create Distributed Attribute Group UDETs ......................................................................................... 31
7.1 Create UDETs to be used as Distributed Attribute Groups ....................................................... 31
7.2 Create / Assign (UDAs) to Distributed Attributes Group (UDETs) ............................................ 32
Exercise 5 – Create Distributed Attribute Group UDETs and UDAs ........................................................ 35
8 Create Distributed Attribute Schema ................................................................................................... 36
8.1 Create Distributed Attribute Schema ........................................................................................... 36
Exercise 6 – Create Distributed Attribute Group Schema ......................................................................... 42
9 Create Default Home Destination ......................................................................................................... 43
9.1 Create Default Home Destination ................................................................................................. 43
Exercise 7 – Create the Default Home Destination .................................................................................... 48
10 Database Views .................................................................................................................................. 49
10.1 Database Views control ................................................................................................................. 49
10.2 Creating Database Views .............................................................................................................. 50
10.2.1 Database Views World (DBVWWLD)....................................................................................... 52
10.2.2 Database Views Group (DBVWGR) ...................................................................................... 52
10.2.3 Database Views (DBVW) ......................................................................................................... 53
10.2.3.1 Attribute Columns (ATTCOL) ........................................................................................... 54
10.2.3.2 Expression Column (EXPCOL) ........................................................................................ 55
10.2.3.3 Attribute Filter (ATTFIL) .................................................................................................... 55
10.2.3.4 Expression Filter (EXPFIL) ............................................................................................... 56
10.2.3.5 Create Rule (CRERULE) .................................................................................................. 57
10.2.3.5.1 Set Parameter (SETPAR) .......................................................................................... 58
10.2.3.5.2 Set Attribute (SETATT) .............................................................................................. 59
10.2.3.5.3 Set Status (SETSTA) ................................................................................................. 60
10.2.3.6 Source Element (SRCELE) .............................................................................................. 61
10.3 Database View Set (DBVWSE) ...................................................................................................... 64
10.4 Database view management ......................................................................................................... 64
10.5 Preview created Database view list/table .................................................................................... 65
Exercise 8 – Create Database View ............................................................................................................. 67
11 Status Definitions .............................................................................................................................. 69
11.1 Status Control of Engineering Element / Item ............................................................................ 69
11.2 Status Control of Distributed Attribute Group ............................................................................ 71
Exercise 9 – Status Control of Engineering and Distributed Attribute Group UDETs ........................... 73
12 Engineering Data Model Setup via Excel ........................................................................................
www.aveva.com 74
12.1 Excel Templates ............................................................................................................................. 74
© Copyright 1974 to current year. 5
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
www.aveva.com
© Copyright 1974 to current year. 6
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
www.aveva.com
© Copyright 1974 to current year. 7
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 1
1 Introduction
The AVEVA Tags Training guide (Administration) is design for those who will develop and maintain the
infrastructure (data model) required to deliver the functionality in the TAGS module. This chapter outlines the
objectives for this guide, details the knowledge required, what must be in place before training starts, how to
use this guide and the course structure.
1.1 Aim
Over the duration of the training participants will be given a basic understanding of how to develop and
maintain a data model required to deliver the functionalities in AVEVA Tags Module.
1.2 Objectives
To provide a clear understanding of how to develop and maintain a data model required to deliver the
functionalities in AVEVA Tags Module.
1.3 Prerequisites
Trainees should be familiar with Microsoft Windows, have attended both basic and advanced TAGS training
courses and are familiar with PDMS Admin and Lexicon functionality.
Training will consist of oral and visual presentations, demonstrations and set exercises. Each workstation
will have a training project, populated with model objects. This will be used by the trainees to practice their
methods, and complete the set exercises.
Certain text styles are used to indicate special situations throughout this document, here is a summary;
Menu pull downs and button press actions are indicated by bold dark turquoise text.
Information the user has to key-in will be red and in bold Italics.
Annotation for trainees benefit:
Additional information
Refer to other documentation
System prompts should be bold and italic in inverted commas i.e. 'Choose function'
Example files or inputs will be in the courier new font, colours and styles used as before.
www.aveva.com
© Copyright 1974 to current year. 8
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 2
The section gives a basic overview of how to develop a data model that is required to deliver the
functionalities in AVEVA Tags Module.
The data model is completely flexible so can easily be adapted to different scenarios and working practices,
such as:
All the data modelling is done in LEXICON Module and the engineering tags items are created in the AVEVA
Tags module.
To start the AVEVA Lexicon application, Select All Programs > AVEVA Plant > Engineer > Engineering
12.1 > Lexicon as shown below:
Alternatively AVEVA Lexicon application could be access by double clicking on AVEVA Engineer shortcut
icon on the desktop as shown below:
www.aveva.com
© Copyright 1974 to current year. 9
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Click on Tags from Engineering 12.1 folder to display the AVEVA Lexicon Login form. The trainer will
provide AVEVA Tags User Names and Passwords as shown below:
Project: Sample
Username: SYSTEM
PASSWORD: XXXXXX
MDB: SAMPLE
After entering the necessary information, from AVEVA Lexicon Login form, click on the Login button.
www.aveva.com
© Copyright 1974 to current year. 10
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
A default screen layout will be displayed comprising the general Lexicon User Interface for the application as
shown:
www.aveva.com
© Copyright 1974 to current year. 11
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
1. Logon into AVEVA Lexicon Project (Sample) using the details provided by the Trainer.
www.aveva.com
© Copyright 1974 to current year. 12
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 3
To develop a data model that is required to deliver the functionalities in AVEVA Tags Module, a number of
procedures must first be considered such as:
How attributes will be divided up to enable different disciplines modify data on the tag concurrently.
This section describes in details and with work examples all the necessary steps to be considered before a
data model is created or developed.
3.1 Decision on type of Engineering item to Create and Manage in AVEVA Tags
The type of Engineering element to create, is determined by the type of Engineering tag information such as
Line List, Valve List, Equipment index etc. required to be created and managed in the AVEVA Tags module.
The type of attribute to be created or assigned to an engineering item is determined by the type of
Engineering Object selected for the data model:
Engineering Element
e.g
PUMP & MOTOR
For this example, the engineering object selected for the data model definition requires mechanical, process
and electrical attribute data.
www.aveva.com
© Copyright 1974 to current year. 13
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
In setting up the Lexicon structure to support multi discipline attribute control it is essential to understand the
relationships between the disciplines.
For example, the diagram shown below is a simple data model definition of a pump and motor where three
(3) different engineering disciplines all contribute to the overall definition of the pump.
Each discipline has control over its own part of the data, with abilities to manage issued and working data,
whilst still allowing the entire data set for the pump to be viewed, reported upon in AVEVA Tags Module grid
view.
Example of simple Data Model definition for Engineering Element “Pump & Motor”
Mechanical Attribute
(Data)
Electrical Attribute
(Data)
Process Attribute
(Data)
To set up a simple data model definition as shown in the example above, a number of procedures must first
be completed.
www.aveva.com
© Copyright 1974 to current year. 14
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
8. Define the destination expression (Using the XPIWLD Name defined in AVEVA Tags database Explorer)
The steps or procedures stated above will be discussed in details and with work example in subsequent
chapters.
www.aveva.com
© Copyright 1974 to current year. 15
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Sketch a data model definition (similar to data definition in “section 3.3) to create and manage a Line list in
AVEVA Tags module grid view, using the data listed below:
- Process data
- Piping Material Data
- Piping Stress Data
www.aveva.com
© Copyright 1974 to current year. 16
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 4
As mentioned in chapter three (3), to set up a data model definition in order to use the AVEVA Tags Module
involues a number of procedures. One of the very first steps is to create the required Engineering
Databases, Teams and Users as explained in the following section.
In the data model definition shown below, the engineering item in this case “pump and motor” have
mechanical, electrical and process attribute data distributed across three (3) databases.
And by normal Team access control, each discipline will have full control of their own data whilst working
with data issued from all the other disciplines.
Process Attribute
Mech Data Electrical
(Data)
Engineers
ENGI DB
Process
Engineers
Proc Data
For this example, the engineering element (Pump & Motor) that is to be created will have Mechanical
attribute data attached directly onto the engineering elements (Pump and Motor) and the data stored in
Mechanical Engineering database.
The Process and Electrical attribute data distributed across two (2) separate Process and Electrical
databases respectively. This will allow three (3) different teams to modify data on the engineering element
concurrently.
www.aveva.com
© Copyright 1974 to current year. 17
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
For this example, using the data model definition in section 4.1, to control who can modify or update
engineering items (Pump & Motor) attribute data and distributed data, the follow must first be created in
AVEVA PDMS Administration Module.
- Mechanical Team
- Eletrical Team
- Process Team
- Mechanical Users
- Eletrical Users
- Process Users
www.aveva.com
© Copyright 1974 to current year. 18
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
www.aveva.com
© Copyright 1974 to current year. 19
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
To view the newly created Engineering Data World (ENGWLD) and Distributed World (XPIWLD) in
AVEVA Tags database Explorer, login into AVEVA Tags Module and select the Explore tab from AVEVA
Tags main toolbar as shown below:
www.aveva.com
© Copyright 1974 to current year. 20
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
- Process Team
- Piping Material Team
- Piping Stress Team
- Process Users
- Piping Material Users
- Piping Stress Users
- Piping Material Engineering Database - Storage for Distributed Piping Material Attibute
Data
- Piping Stress Engineering Database - Storage for Distributed Piping Stress Attribute
Data.
Login into AVEVA Module Project (Sample) using the details provided by the Trainer, to view the
newly created Engineering Data World (ENGWLD) and Distributed World (XPIWLD) in AVEVA
Tags database Explorer
www.aveva.com
© Copyright 1974 to current year. 21
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 5
In a project, if user(s) does not require attributes to be distributed across hierarchies and potentially
databases, a basic Data Model definition can setup, which allow the user(s) to store all the attribute data of
the engineering item / element in one database as shown in the diagram below:
Mechanical Attribute
Mechanical
Engineers (Data)
ENGI DB
Mech Data
For this example, the engineering elements (Pump and Motor) that are to be created will have Mechanical
attribute data attached directly onto the engineering element (Pump and Motor) and the data stored in
Mechanical Engineering database.
To setup or configure this type of data model definition the following steps is required:
The steps or procedures stated above will be discussed in details and with work examples in following
sections
www.aveva.com
© Copyright 1974 to current year. 22
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
AVEVA Tags uses existing UDET mechanisms. This task only differs from creating a regular UDET in one
aspect, and in that the UDET intended for use as an Engineering element (i.e owner of distributed
attributed group) must be based on the ENGITE element type.
The Basetype attribute indicates what system type the UDET is derived from. The UDET will inherit
only the core attributes of the basetype and not its UDAs
Using the Data Model Definition in section 5.0, create UDETs for “Pump” and “Motor”:
- Create UDETWL (Udet World) , access from the Dictionary world and Create UDETGR ,
(Udet Group) for Engineering object access from the UDETWL
- Create a new UDET for the engineering element (Pump) with BASETYPE set to ENGITE as
shown:
Select the browse button from the Base type field to select the basetype “ENGITE”, Click Ok button from
the Select base type form to save the selected element to the Current Element Editor form as shown
above.
www.aveva.com
© Copyright 1974 to current year. 23
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
In the Current Element Editor form, the Owner types and Member types fields are automatically populated.
For this example Owner types is be restricted to ENGGRP by checking only the ENGGRP checkbox in the
Select owner types form as shown:
An engineering elements udets may be owned by more than one owner types.
Select the browse button from the Owner Field to select the prefered owner types , in this example Owner
types is be restricted to ENGGRP,ENGITE and :ENGIPUMPTAG (Engineering element UDET for PUMP)
New UDETs can be created in bulk if required using Edit Member Tool. For further details on creation
of UDETs using Edit Member, please refer to Lexicon User Guide (TM1300).
Setting Pump Udet (:ENGIPUMPTAG) as part of the owner types of Motor Udet
(:ENGIMOTORTAG) will allow user(s) to display attribute data of Motor Udet (:ENGIMOTORTAG)
as a sub-list of Pump Udet (:ENGIPUMPTAG) in AVEVA Tags grid view if required.
www.aveva.com
© Copyright 1974 to current year. 24
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
The attributes can be defined as any regular UDA; no special consideration needs to be taken. Decide on
the attributes to be assigned directly to the engineering elements.
For this example using the Data Model Definition in section 5.0, mechanical attributes listed below are
directly attached to PUMP UDET (ENGIPUMPTAG) and Motor UDET (ENGIMOTORTAG).
Table A
UDETs Attributes
Pump (:ENGIPUMPTAG) Tag Number, Tag Prefix, Manufacturer, Degree
Of Protection , Operating Weight and P&ID
Motor (:ENGIMOTORTAG) Tag Number,Tag Prefix, Manufacturer, Power
Rated , Power Load, and Insulation
Specification
If the above UDAs exist in the current Lexicon database, simply assign the UDAs to their respective UDETs
as shown in the examples below:
New UDAs can be created in bulk if required using Edit Member Tool. For further details on creation of
UDAs using Edit Member, please refer to Lexicon User Guide (TM1300).
Access the require UDA UGRO that store the UDAs and assign each of the required UDAs to their
respective UDETs.
www.aveva.com
© Copyright 1974 to current year. 25
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the browse button from Element types field to select the require element type, in this case PUMP
UDET (:ENGIPUMPTAG) and Motor UDET (:ENGIMOTORTAG) as shown:
Select the browse button from Element types field to select the require element type, in this case PUMP
UDET (:ENGIPUMPTAG).
The UDA type field is set to “Reference” and the Referred types set to “SCDIAGRAM”
www.aveva.com
© Copyright 1974 to current year. 26
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Repeat the same procedure to assign the remaining attributes in “Table A” to their respective UDETs and
then display the data model graphical view of the UDETs with their respective attributes as shown below:
The Graphical View form is then displayed with all the assign attributes as shown:
www.aveva.com
© Copyright 1974 to current year. 27
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create / Assign the following User Defined Attribute (UDAs) to UDET (:LineTags)
UDETs Attributes
LineTags (:LineTags) 1.Tag Number,
2.Tag Prefix,
3.Line Size,
4.Fluid Code (with the following list of Valid
Values , A, FW, FO, G, HO, HC, LO, O, SW,
W)
www.aveva.com
© Copyright 1974 to current year. 28
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 6
When the project requires individual control of their attributes, the data model configuration must now
include ‘Distributed attributes’. This infers that some attributes will be distributed to other disciplnes
Engineering databases for control.
For this example, using the following Data Model definition; Process and Electrical are distributed to Process
and Electrical Engineering Databases. And as a result each team members with the right access will have
concurrent write access to the attribute under their control and read to those controlled by other disciplines.
Electrical Attribute
(Data)
Process
Attribute (Data)
Members of Distributed Attributes
A pictoral representation of how the components relate to each other is displayed below:
ENGI DB
ENGI DB
ENGI DB
www.aveva.com
© Copyright 1974 to current year. 29
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Term Description
Binding Element The owner of distributed attributes groups.
The container for distributed attributes these can be thought
Distributed element /attribute group of as attribute groups. The distributed element is always a
UDET based on the XPITEM element type.
Distributed attribute The attributes, UDAs that a defined for an attribute group.
Default home The location where the distributed elements are stored and
managed.
The definition of distributed attributes defines what type of attribute groups (i.e. UDETs) are allowed as
distributed attributed to which element type.
The definition of distributed attributes consists of two inter-related definitions as described below:
Distributed attributes are made up of UDETs which are associated with the binding element that they add
attributes to. To configure distributed attributes:
Create distributed attribute schema associating elements with the distributed attribute group.
Create the default home definition the location where distributed attributes are to be created and
managed.
Create actual default home top level elements where distributed attribute groups are created.
The steps or procedures stated above will be discussed in details and with work example in following
sections
www.aveva.com
© Copyright 1974 to current year. 30
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 7
This task only differ from creating a regular UDET in one aspect, and that is that the UDET intended for use
as a distributed attribute group must be based on the XPITEM element type.
The UDETs to be used as distributed attribute groups, needs to be defined with XPITEM as their
basetype.
Using the Data Model Definition in section 6.0, create the required sets of UDETs for distributed attributes
(in this case Process and Electrical distributed attributes) as shown:
- Create a new UDET for Process distributed attributes and another for Electrical distributed
attributes. The BASETYPE for each of these UDETs set to XPITEM.
www.aveva.com
© Copyright 1974 to current year. 31
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the browse button to select the basetype XPITEM and the Owner type field will automatically set to
XPIFLD as shown:
The Basetype “XPITEM” is the distributed base element and the “XPIFLD” is Distributed Attribute
Group.
The attributes can be defined as any regular UDA; no special considerations need to be taken. If the
required UDAs exist in the current Lexicon database, simply assign the UDAs to their respective UDETs as
shown:
Assign the distributed attributes listed below to the Distrubuted elements Electrical UDET
(ENGIPUMP_ELECATT) and Process UDET (ENGIPUMP_PROCATT) as shown below:
Table B
UDETs Attributes
Process Area, Maximum Design Pressure,
Process(ENGIPUMP_PROCATT) Minimum Design Pressure, Minimum Design
Temperature and Process_Comments.
www.aveva.com
© Copyright 1974 to current year. 32
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Assign each of the required UDAs to their respective UDETs as shown in the example below:
Select the browse button from the Element Types field, to select the required element type, in this case
Electrical (:ENGIPUMP_ELECATT) as shown:
The UDA type field is set to “Real” and the UDA Units set to “Torque”.
www.aveva.com
© Copyright 1974 to current year. 33
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
It is possible to limit the values that this attribute can be set to by selecting the browse button to display Edit
Valid Values form. Then enter the sets of required values as shown above.
If the user(s) do not want to enforce the list of value in AVEVA Tag grid view, select TRUE option
from the Limits or Valid values Option Flag field as shown below.
Repeat the same procedure to assign the remaining attributes in “Table B” to their respective UDETs and
then display the data model graphical view of the UDETs with their respective attributes as shown below:
www.aveva.com
© Copyright 1974 to current year. 34
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create the following Attribute group data listed below as Distributed Attribute UDET
Create / Assign the following (UDAs) listed below to Distributed Attributes Group (UDETs)
UDETs Attributes
Piping Material Data 1. Insulation Specification,
(:PIPEMAT_DISTR_ATTRIBUTE) 2. Paint Class,
3. Material_Comments
Display the data model graphical view of the Distributed Attributes Group (UDETs)
www.aveva.com
© Copyright 1974 to current year. 35
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 8
The distributed Schema definition helps to bind the distributed attribute data (XPITEM) to the ENGITE in this
case bind Process attribute data and Electrical attribute data distributed Udet to the engineering item (Pump
:ENGIPUMPTAG)
The distributed attribute schema defines the structure of the distributed attribute group and its associate
element type.There are two administrative levels, Distrubted Attribute definition World (DSXWLD) and
Group for Distributed Definitions (DSXGRP). They serve the same purpose of grouping things (i.e schemas,
UDAs). This section with work example describes how to define a distributed attribute schema.
The DSXWLD is the top level element for storing distributed attribute schemas and default home
selectors. It does not contain any attributes of particular interest to distributed attributes
configuration.
For this example; using the data model definition section 6.0:
Create a new Group for Distributed Definitions (DSXGRP), by right-clicking on the required DSXWLD to
display right-click menu. Select DSXGRP from the Create option sub-menu as shown below:
www.aveva.com
© Copyright 1974 to current year. 36
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create a new Distribution Attribute Schema (DSXSCH) by right-clicking on the required DSXGRP to
display right-click menu. Select DSXSCH from the Create option sub-menu as shown:
www.aveva.com
© Copyright 1974 to current year. 37
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create a new Binding Element Definition (DSXOWN) by right-clicking on the required DSXSCH to display
right-click menu. Select DSXOWN from the Create option sub-menu as shown:
In Current Element Editor Form, complete the Name and description field as required.
www.aveva.com
© Copyright 1974 to current year. 38
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create a new Bound Element Definition (DSXMBR), by right-clicking on the required DSXOWN to display
right-click menu. Select DSXMBR from the Create option sub-menu as shown below:
The Bound Element Definition (DSXMBR) is the last part of the distributed attribute schema
definition to associate the UDETs that form the distributed attributes for the owning elements
specified in DSXOWN. The definition specifies which XPITEM based UDETs that can be used as
distributed attributes for the specified owner.
In Current Element Editor Form, complete the Name and description field.
www.aveva.com
© Copyright 1974 to current year. 39
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Default Home field – unset (this is set at lower level in the schema) as shown
Auto Creation Field - select True from the pull-down list as shown above.
In Auto-create field, if set to TRUE the distributed element is automatically created if it doesn’t exist
at the modification operation in AVEVA Tags grid view and under the appropriate default Home
(XPIWLD) in AVEVA Tags database explorer.
Cardinality Field – set Min and Max to 0,1 respectively as shown above.
Cardinality definitions, defines the minimum and maximum number of each of the distributed
attributes that may be created. A -1 in the maximum definition represent an infinite number.
Element Types Field, - Select the browse button from the Element Type field, to select the require element
type, in this case Process attribute (Member of distributes attributes groups :ENGIPUMP_PROCATT). Click
Ok button from the Select bound element type form to save the selected element to the Current Element
Editor form as shown;
The Element Type field is mandatory, it must be completed with the appropriate element type
Since there are two of distributed attribute group as described in (section 6.0). Repeat the same procedure
as shown above to create Bound Element Definition (DSXMBR) for Electrical distributed attribute group as
shown below:
Then display the data model graphical view for the Binding Element Definition in this case PUMP (owner
of distributed attributes groups :ENGIPUMPTAG) with their respective attributes.
www.aveva.com
© Copyright 1974 to current year. 40
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
By Right-clicking on the require Binding Element or Bound element definition and select Graphical View
from the right-click menu .The Graphical View form is then displayed with all the assign attributes as shown
below:
www.aveva.com
© Copyright 1974 to current year. 41
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Using the Engineering and Distributed Attribute Group UDETs created in exercise 4 and 5
Display the data model graphical view of the Binding Element Definition (i.e owner of distributed
attributes groups
www.aveva.com
© Copyright 1974 to current year. 42
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 9
The Default home Destination, defines the location where the distributed attributes are to be stored. This
section describes how to define a default Home Destination definition.
The default home destination contains a string or ID expression that evaluates the name or ID of the default
home to be used. When used together with distributed attributes, the name must result in a XPIWLD
element. The destination definition also evaluates a logical test that must yield true in order for it to be used.
For this example; using the data model definition section 6.0:
Create the top-level elements Default Home Definition (DSXHOM), where the distributed attribute groups
are created. Right-click on the required DSXGRP to display right-click menu. Select DSXHOM from the
Create option sub-menu as shown:
The DSXHOM defines a default home selector, it contains no information vital to the Default home
configuration and may have DSXTST and DSXDST member.
www.aveva.com
© Copyright 1974 to current year. 43
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create Default Home Destination Definition (DSXDST), by right-clicking on the required DSXHOM to display
right-click menu. Select DSXDST from the Create option sub-menu as shown below:
The DSXDST contains an ID expression that helps to evaluate the name or ID of the default home
to be used (i.e the name used to define the (XPIWLD) in AVEVA Tags database explorer as
highlighted below in this case.
www.aveva.com
© Copyright 1974 to current year. 44
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Home location field enter -- /PROCAttData and then press enter from the keyboard, the “ID” expression
and a round open and close bracket is automatically added to the existing expression such as ( ID
/PROCAttData ) as shown below:
The Home Location is a mandatory field. The expression typed in this field must be same as the
XPIWLD name in AVEVA Tags database Explorer, if the XPIWLD already exists or vice –visa (i.e
any new XPIWLD created must have the same name as the Home location expression value
highlighted in the example below:
Test expression field ---- is automatically set to true, it evaluates a logical test that must yield true in order
for the expression in Home location field to be used. The value for Home location is not a reference value
of the type used extensively through PDMS hence the need for the test.
The DSXHOM definition may have DSXTST (Default Home Test Definition) accessed by right-
clicking on the DSXHOM to display the right-click menu. And then select DSXTST from the Create
option sub-menu.
The DSXTST defines a test that needs to yield true upon evaluation using the default home. It
allows a test expression defined in PML1. The expression operates on the current binding element.
Since there are two of distributed attribute groups as described in (section 6.0). Repeat the same procedure
as shown above to create Default Home Definition (DSHOM) and Default Home Destination Definition
(DSXDST) for Electrical distributed attribute group.
www.aveva.com
© Copyright 1974 to current year. 45
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Created Default Home Definition (DSXHOM) for Electrical distributed attribute group
Created Default Home Destination Definition (DSXDST) for Electrical distributed attribute group
Finally return to Bound Element Definition (DSXMBR) created earlier and set the default home. This
essentially tells the system where to create the bound data (distributed attributed).
To do this:
Select the required Bound Element Definition (DSXMBR), in case DSXMBR for Process attribute group,
from the Default home field in the Current Element Editor Form, select “ENPUMPTAG_PROC_HOME”
from the pull-down list as shown below.
The Default Home selector list is populated from the Default Home definition (DSXHOM) name
field. Setting the Default home definition at this level overrides any other definition at Schema level.
www.aveva.com
© Copyright 1974 to current year. 46
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Setting the default home definition for Electrical distributed attribute group.
Select the required Bound Element Definition (DSXMBR), in this case DSXMBR for Electrical attribute
group, from the Default home field in the Current Element Editor Form, select
“ENPUMPTAG_ELEC_HOME” from the pull-down list as shown below.
The Default Home selector list is populated from the Default Home definition (DSXHOM) name
field. Setting the Default home definition at this level overrides any other definition at Schema level.
www.aveva.com
© Copyright 1974 to current year. 47
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create Default Home Definition (DSHOM) and Default Home Destination Definition (DSXDST)
for the Distributed Attributed Group, in this case
Set the default home definition for both Piping Material and Piping Stress distributed attribute group.
www.aveva.com
© Copyright 1974 to current year. 48
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 10
10 Database Views
A Database View is a PDMS functionality with which attribute data of elements are collectively configured to
map into the cells of a table. These tables can be generated as lists, indexes and reports.
A Database View definition is based on any available element type, with column references to a selection of
its attributes or expressions defined beneath.
The Database view definition will allow a table to create and list instances of the element type (database
items) in rows with the columns controlled by their selected attributes or expressions (PML 1 or XPath 1.0
expressions).
In other words, as a Database View is represented by a table, each row of that table will be an instance of
an element type(s), and the cells of each column will either be a value of an attribute or expression based on
the corresponding row element.
It is possible for each row to represent data from multiple element types and also multiple database
elements may be modified if a row of data is edited in a grid or via an import
A generated engineering list consists of rows and columns, and is based on a Database View. Row entities
are controlled by the applicable element types, as each row is an instance of that element type, hence a
database item. Columns are controlled by element attributes or expressions, hence referred to as ‘Attribute
Columns (ATTCOLS)’ and ‘Expression Columns (EXPCOLs)’
www.aveva.com
© Copyright 1974 to current year. 49
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Defined Database views will consist of a base element type, and configurations for Attribute columns. Other
configurations might include Expression columns, attribute filters and item Creation rules.
The Database View can also be defined for additional element types, making it possible to include their
attribute and expression data onto the same list / table. These additional element types can be configured as
‘Source Elements’
Database views are defined via the Database Views Editor within the LEXICON and Tags modules, or with
the Current Element Editor within the LEXICON module.
The Database Views Editor is a General user interface for the creation and definition of Database views in
a quick and user friendly manner.
For further details please, TM-3551 AVEVA Plant – Tags (Advanced) Training Guide for Database
views definition via the Database ViewsEditor
This guide covers the definition of Database views via the Current Element Editor within the LEXICON
module within the PDMS products of Engineering, Diagrams or Design product portfolio.
The Current Element Editor includes the criteria for selecting and entering elements from which the rows
are constructed, as well as all applicable attribute and expression data required for column control. As
Database views entries are placed in a hierarchical order beneath a Database view world in the dictionary
explorer, the Current Element Editor defines the criteria for each entry in all levels of the hierarchy.
Typical Database views setup will have most of the hierarchical elements configured, but this depends on
the purpose and use of resulting lists and tables based on the Database views.
The following sections will describe the definition steps of a Database view, and the configuration of its
hierarchical elements.
Refer to the table presented above for descriptions and definitions of terminology utilized
www.aveva.com
© Copyright 1974 to current year. 51
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
The hierarchical elements of defined Database views are created and placed beneath the ‘Database view
world’.
Select the topmost element in the dictionary explorer (Dictionary World), right click to display the context
menu. Select the ‘Create’ entry, to display a sublist of dictionary elements worlds, and select the
‘DBVWWLD: Database view world’ entry, to create a Database view world.
With the Current Element Editor, fill in the attribute details of the created DBVW world as shown.
Select the created Database view world ‘PUMP_VIEWS_WORLD’, and Create a ‘Database view group’
(DBVWGR) using the context menu.
www.aveva.com
© Copyright 1974 to current year. 52
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view group ‘PUMP_VIEWS_GROUP’, and Create a ‘Database view (DBVW)
using the context menu.
The ‘Basic definition’ section in the Current Element Editor form of the Database view includes entries for
a ‘User Defined Name’, as this will be the identifier for the Database view. Required Element Type(s) can
be selected, as the subsequent data for the view will be derived from it.
’Auto Creation’ is set to ‘True’ as this will allow the creation of new rows (new instances of the selected
element type) on any generated list/table which is based on this Database view.
The utilized element type :ENGIPUMPTAG is an engineering UDET which has been pre-defined
for this exercise
www.aveva.com
© Copyright 1974 to current year. 53
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view ‘PUMP_VIEW’, and Create an ‘Attribute Column’ (ATTCOL) using the
context menu.
The ‘Basic definition’ section in the Current Element Editor form of the Attribute Column includes entries
for a ‘User Defined Name’, as any entered value will be displayed as the default caption (Column header) of
the column on a list/table. Required and applicable attributes which have been appended to the utilized
element type can be filled in, as the column will be based on this attribute.
The ’Read only’ entry is set to ‘False’ as this will allow the values within the list/table columns to be editable.
The utilized Attribute :TAG_NUMBER entry is an engineering UDA which has been pre-defined for
this exercise
www.aveva.com
© Copyright 1974 to current year. 54
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view ‘PUMP_VIEW’, and Create an ‘Expression Column’ (EXPCOL) using
the context menu.
The ‘Basic definition’ section in the Current Element Editor form of the Expression Column includes
entries for a ‘User Defined Name’, as any entered value will be displayed as the default caption (Column
header) of the column on a list/table. Required and applicable expressions and the expression type are filled
in, as the column will be based on this expression.
Generated expression columns will be marked as ’Read only’ by default, as their cell values are derived,
and not directly entered nor modifiable.
Select the created Database view ‘PUMP_VIEW’, and Create an ‘Attribute Filter’ (ATTFIL) using the
context menu.
www.aveva.com
© Copyright 1974 to current year. 55
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
The ‘Basic definition’ section in the Current Element Editor form of the Attribute filter includes entries for
an attribute with which the filter will be based on. The ‘Filter operator’ defines the condition/criteria for the
selected attribute. The ‘Filter value’ is a value which applies to the condition/criteria defined.
In this case, any generated list/table based on this Database view will only display a :TAG_NUMBER
column which contains values starting with the character ‘P’. Every other Tag number will be filtered out.
Select the created Database view ‘PUMP_VIEW’, and Create an ‘Expression Filter’ (EXPFIL) using the
context menu.
The ‘Basic definition’ section in the Current Element Editor form of the Expression filter includes entries
for an Expression, and Expression type with which the filter will be based on. The expression filter is utilized
if the attribute filter is not sufficient to filter elements, but rather complex conditions are required. A PML type
expression could be (DESC eq ‘Pump’).
Expressions can be used to define conditions/criteria to filter values displayed in a generated list/table. This
will not be filled in, as it is not required for this exercise.
www.aveva.com
© Copyright 1974 to current year. 56
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view ‘PUMP_VIEW’, and create a ‘Create rules’ element using the context
menu.
The ‘Basic definition’ section in the Current Element Editor form of the ‘Creation rule’ includes entries for
an ‘Owner Expression’, which is an identifier for the engineering group (ENGGRP) where new :PUMP type
items / instances will be created and stored. The ENGGRP exists in the engineering database, and can be
accessed via the Tags module. Its name will serve as the ‘Owner’ of any new pump items.
The Owner Expression type indicates the type of expression used. The ‘Type expression’ entry requires
an expression which identifies a specific element type which a created item is based on. This is not essential
since the utilized UDET (:PUMP) can be derived.
Defining the Creation rule ensures that each time a new item is being created on the Database view list /
table, a prompt form appears requesting values for required or optional preconfigured parameters.
Selecting ‘True’ for the ‘Create ancestors’ entry makes it possible for new items to be created and stored in
any other existing ‘Owner element’ (ENGGRP) database hierarchy within the Tags module), if an ‘Owner
Expression’ is not defined.
The user will be prompted to select from an existing ENGGRP, or create a new one, during the creation of a
new database item.
www.aveva.com
© Copyright 1974 to current year. 57
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Creation rule ‘PUMP_VIEW_CRERULE’, and create a ‘Set Parameter’ element using
the context menu.
The ‘Basic definition’ section in the Current Element Editor form of the ‘Set Parameter’ includes entries
for a ‘User Defined Name’, as this value will be the identifier for the parameter.
The value in the ‘Expression’ entry indicates that whenever this parameter is utilized, this expression value
will be displayed.
The ‘Creation rule’ ensures that a prompt form for the entry of parameter is displayed during the creation of
database items in the Tags module, hence the ‘User Prompt’ entry ‘Pump Prefix’ will be displayed on that
form where the user can enter a relevant value. Setting the entry for ‘Required’ to ‘True’ ensures that this
will be a mandatory requirement for item creation. If set to ‘False’ then the parameter entry on the prompt
form will be listed as ‘Optional’
In this case, the ‘Pump Prefix’ User Prompt will not be visible, since an expression has been entered and
the value of this expression will always be displayed each time this parameter is utilized
The expression value ‘P’ will always be displayed when the Pump prefix parameter is utilized in an
expression
Create a new attribute column (ATTCOL) which displays values for a :MODEL_NUMBER UDA
www.aveva.com
© Copyright 1974 to current year. 58
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create 3 further ‘Set Parameter’ rules and fill in the attribute details as shown.
The Model Number, Suffix and Item number parameters will be displayed as a required entry on
the ‘Creation rule’ prompt form, and entered values will be utilized in any expression in which they
apply
Select the created Creation rule ‘PUMP_VIEW_CRERULE’, and create a ‘Set Attribute’ element using the
context menu.
The ‘Basic definition’ section in the Current Element Editor form of the ‘Set Parameter’ includes entries
for ‘Attribute’, as this is the selected attribute values will be controlled by the rule.
The ‘Expression’ entries will extract the values to be utilised for the selected attributes of items to be
created. In this case, the expression points to the defined parameters, as these parameter values are
entered in the Creation rule prompt form.
The entered parameter values will then be evaluated according to the expression, and a final value will be
appended to the attribute of the newly created item.
The ‘Required’ entry is set to ‘True’, ensuring that the application of this rule is mandatory.
Create 2 further ‘Set attribute’ rules and fill in the attribute details as shown.
Select the created Creation rule ‘PUMP_VIEW_CRERULE’, and create a ‘Set Status’ element using the
context menu.
The ‘Basic definition’ section in the Current Element Editor form of the ‘Set status’ includes entries for
‘Status Definition Ref’, as this allows the user to select from a drop down list, a required status definition
with which this rule applies.
The Set status rule appends the initial status value of the selected status definition to newly created items on
a database view list / table.
The ‘Required’ entry is set to ‘True’, ensuring that the application of this rule is mandatory.
The utilized Status definition ref ‘TagStatus’ already exists for the purpose of this exercise
See Chapter 11 for the definition and creation of Status definitions
www.aveva.com
© Copyright 1974 to current year. 60
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view ‘PUMP_VIEW’, and Create a ‘Source element’ (SRCELE) using the
context menu.
The ‘Basic definition’ section in the Current Element Editor form of the source elements includes an entry
for ‘Expression’, in which an expression extracts the element type whose attribute data will be defined
beneath.
In this case, the attribute data of the UDET (:ENGIPUMP_PROCATT) will be populated and available on the
same Database view list / table as the original ‘PUMP_VIEW’
The Database view list / table will now be able to contain attribute data from the source element, as
well as the original selection of attribute data from the original engineering UDET
www.aveva.com
© Copyright 1974 to current year. 61
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Source element ‘PUMP_PROCESS_ATTRIBUTES’, and Create attribute columns
(ATTCOLS) as shown.
The utilized UDETs as source elements were earlier defined for this exercise
Expression columns (EXPCOL) and Creation rules (CRERULES) can also be created as
described previously
The attribute data utilized for the attribute columns, must be defined for the UDETs of the source
elements
www.aveva.com
© Copyright 1974 to current year. 62
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view ‘PUMP_VIEW’, and Create another ‘Source element’ (SRCELE) using
the context menu.
Then select the created Source element named ‘PUMP_ELECTRICAL_ATTRIBUTES’, and Create
attribute columns (ATTCOLS) as shown.
A Database view list / table will by default initially position its columns according to the order of the
ATTCOLS and EXPCOLS
www.aveva.com
© Copyright 1974 to current year. 63
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the created Database view group ‘PUMP_VIEWS_GROUP’, and Create a ‘Database view set
(DBVWSE) using the context menu.
The ‘Basic definition’ section in the Current Element Editor form of the Database view includes just an
entry for a ‘User Defined Name’, as this is what the Database view set will be identified with.
The Database view set is simply a collection of created Database views according to required criteria.
Database view sets can be created to hold a number of Database views which apply to a Pump, an
Equipment, a Pipeline, or distributed attributes of element disciplines etc.
Database view set can be created as shown.
The Database view sets shown was defined using additional Database views configured for this
demonstration
Database views and Database view sets are managed within Definition sets, although these Definition sets
are not exposed to the user via the Current Element Editor.
A Definition set are areas where the Database views are created and placed, as well as modified and
updated.
• Element View – Database Views defined automatically to represent the database hierarchy, and
includes all available element types within the MDB utilized.
• Project Views – Database views defined in the dictionary database for a project.
• User Views – Database views defined as a file in the users project setting
www.aveva.com
© Copyright 1974 to current year. 64
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
These Definition sets are visible and manageable from within the Database views Editor.
Although it is advisable to create database views within the ‘User Views’ definition set, database views
which are defined with the Current Element Editor in the LEXICON module will by default be placed in the
‘Project Views’ Definition set.
Creating and maintaining database views within the ‘User views’ Definition set allows for easy Database
views creation, management and storage. As the Database views created in this Definition set are stored in
the ‘Database view.xml’ file located within the ‘project data folder’ in the PDMSUSER location.
From within the Database views Editor, Database views can be copied from existing Definition sets and
pasted in the ‘User views’ or any user defined Definition sets as well as the ‘Project views’ where it is
subsequently added to the dictionary database.
It is not possible to modify nor paste Database views into the ‘Element views’ Definition set.
Refer to the AVEVA Engineering – Tags (Advanced) for more information on the creation, storage,
and use of the Definition sets as well as Database views within the Database views Editor
In the absence of the Database views Editor interface within the LEXICON module, a call control
can be added to the module with the customisation command
AVEVA.Pdms.Database.View.Editor, as this interface allows the view to be tested as a ‘User
view’ with full access
Within the AVEVA Engineering – Tags module, create and display a new list / table from a suitable
category, and based on the previously created database view, and label the table ‘Pump Index’ as shown.
www.aveva.com
© Copyright 1974 to current year. 65
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
The displayed table contains columns and items which conforms to the requirements of the rules within the
set filters and Creation rules configuration
The displayed section of the generated table as shown below, contains the defined attribute and expression
columns for created items / instances of the :ENGIPUMPTAG user defined element type (UDET).
The displayed section of the generated table as shown below, contains the defined attribute and expression
columns for the source elements (:ENGIPUMP_PROCATT and :ENGIPUMP_ELECATT) which in this case
are disciplines of the :ENGIPUMPTAG UDET, and contains its ‘Distributed attributes’.
www.aveva.com
© Copyright 1974 to current year. 66
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
1 (a). Using engineering UDETs LineTags (:LineTags) created in exercise 4, define a Database view group
(DBVWGR) and Database view (DBVW) using Current Element Editor form as described in the examples
in section 10.2.1 and 10.2.2
- Create Attribute columns and expression columns beneath the Database view as earlier
described using the attributes listed below:
UDETs Attributes
LineTags (:LineTags) Tag Number, Tag Prefix, Line Size,
Fluid Code
- Create a Source element (SRCELEMENT) definition using predefined distributed attribute group
(Piping Material Data (:PIPEMAT_DISTR_ATTRIBUTE - XPITEM)
- Create Attribute and expression columns using the attributes listed below:,
UDETs Attributes
Piping Material Data 1. Insulation Specification,
(:PIPEMAT_DISTR_ATTRIBUTE) Paint Class, Comments
- Create a Source element (SRCELEMENT) definition predefined distributed attribute group (Piping
Stress Data (:PIPESTRE_DISTR_ATTRIBUTE)- XPITEM)
UDETs Attributes
Piping Stress Data Stress Reason,Preliminary
(:PIPESTRE_DISTR_ATTRIBUTE) Stressing, Stress Critical &
Stress_Comments
- Create Attribute and expression columns using the attributes listed below:,
UDETs Attributes
Piping Material Data 1. Insulation Specification,
(:PIPEMAT_DISTR_ATTRIBUTE) Paint Class, Comments
www.aveva.com
© Copyright 1974 to current year. 67
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
UDETs Attributes
Piping Stress Data Stress Reason,Preliminary
(:PIPESTRE_DISTR_ATTRIBUTE) Stressing, Stress Critical &
Stress_Comments
3. Create a Database view set, for the Database views as described in the examples in section 10.3
4. Within the Tags module, create and display list views based on the created database views
www.aveva.com
© Copyright 1974 to current year. 68
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 11
11 Status Definitions
Status Control is the ability to control and report on the status of individual model objects as they progress
their lifecycles. It can be applied to any model objects, for example tagged items, catalogue components,
drawings etc.
The desired project configuration is created by administrators as Status Definitions in LEXICON with the
use of a hierarchy of Status World, Status Definition and Status Value elements. This section describes
how to assign status definitions to engineering elements UDETs.
For further details on how to define a status definition, please refer to Status Control User Guide.
For this example, an existing status definition setup in Lexicon Module is used.
To add engineering elements Udets (i.e owner of distributed attribute group), select the required status
definition, in this case STADEF/TagStatus.
www.aveva.com
© Copyright 1974 to current year. 69
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Select the browse button from the Controllable element type field, to select the require element type, in
this case Pump (:ENGIPUMPTAG) and Motor (:ENGIMOTORTAG).
Click Ok button from the Select element type form to save the selected element to the Current Element
Editor form as shown above.
To display the Status Definition Graphical View of the STADEF/TagStatus. Select the required STADEF or
STAVAL elements in this case STADEF/TagStatus in the Dictionary Explorer, right click, from the
displayed menu, select Graphical View.
www.aveva.com
© Copyright 1974 to current year. 70
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
For this example, an existing status definition setup for Distributed Attribute Group in Lexicon Module will be
used as shown:
To add distributed attributes group select the required status definition, in this case STADEF/TagAttStatus
and select the browse button from the Controllable element type field, to select the require element type,
in this case Process(ENGIPUMP_PROCATT) and Electrical (ENGIPUMP_ELECATT) as shown:
www.aveva.com
© Copyright 1974 to current year. 71
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
To display the Status Definition Graphical View of the STADEF/TagAttStatus. Select the required STADEF
or STAVAL elements in this case STADEF/TagAttStatus in the Dictionary Explorer, right click, from the
displayed menu, select Graphical View.
The graphical view for the selected element is then displayed as shown above.
www.aveva.com
© Copyright 1974 to current year. 72
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
- LineTags (:LineTags)
Display the Status Definition Graphical View for both definitions (i.e STADEF/TagStatus &
STADEF/TagAttStatus).
www.aveva.com
© Copyright 1974 to current year. 73
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 12
The Data Model setup for the AVEVA Engineering – Tags module includes the initial creation and
definition of required engineering user defined element types (UDETs), and required User Defined
Attributes (UDAs) if they don’t exist already.
The powerful features of the Tags module utilizes the concept of ‘Distributed attributes’ as ‘Disciplines’,
and requires the creation of further dictionary database items as part of the general data model setup.
These dictionary database items are created as hierarchical elements within the LEXICON module, and
include Database views definitions, Status definitions and Distributed attributes definitions.
The creation, definition and modification of each of these hierarchy elements are carried out with the
‘Current Element Editor’ as seen in previous chapters.
The creation of dictionary database items is usually reserved as part of a project administrators’ privilege
Building the Lexicon structure to support the TAGS module has been described in previous chapters.
However It is also possible to create, define and populate the dictionary database with all required items
using Excel templates.
www.aveva.com
© Copyright 1974 to current year. 74
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Each of the ‘task block’ that falls within LEXICON module area as represented in the
connectivity chart displayed above, can be fully defined and configured on Excel spread sheets, and then
read into the dictionary database as an ‘Excel Import’
The spread sheet for each ‘block’ carries both unique and required information in the form of system
attributes and corresponding values.
This data is placed in a simple layout of a header row which contains the identifier (name) of the attributes
and acts as column headers / captions.
Displayed above, is a sample Excel sheet containing information required for the creation and definition of
User defined attributes UDAs.
Note that the attribute values (column headers) of ‘Name’ and ‘Owner’ will be evaluated as unique
identifiers during the import process of the data contained within the sheet into the dictionary database.
The use of Excel spread sheets as data model templates looks to ensure a much quicker and easier
process of dictionary database item creation, definition and updates.
As yet, there is no dedicated control / button with which to call the Excel import feature within the LEXICON
module, but this can be created using the customisation tool provided with the product, or by entering the
appropriate syntax in the command window, which calls the Excel import feature.
This action will initially call the windows file picker form, with which an excel template will be selected, before
displaying the ‘Spreadsheet Import’ form.
Refer to the User Guide .NET Customisation for information on module customisation
www.aveva.com
© Copyright 1974 to current year. 75
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Displayed above, is the ‘Spreadsheet Import’ form which is initiated with the call features defined in
section 12.2
For these examples, a set of Excel templates will be provided to demonstrate the data model setup. A
‘Clean’ dictionary database (containing no items) is also utilized for these demonstrations, to enable easier
visualisations of items to be created.
From the Dictionary explorer shown, just the ‘Dictionary World’ will be available, in preparation for the
creation of items beneath it.
The data model setup will follow the ‘Task blocks’ displayed in the connectivity chart, and look to create the
items contained within alongst with any parent and child element as required.
This example assumes that relevant databases for both the dictionary items, and engineering items
have been created and already exist
The import steps in the following examples must be carried out in the order as shown
www.aveva.com
© Copyright 1974 to current year. 76
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
www.aveva.com
© Copyright 1974 to current year. 77
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Review the populated data, and hit the ‘Load All Data’ button or the ‘Load New Data’
The data on the Spreadsheet import form can be refreshed with updated data by clicking on the ‘reload
file’ button or the data can be re-read from its source by clicking on the ‘Open file’ button
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
for ‘Engineering Groups.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘Groups’, then click on the ‘Load New Data’ button to run the import process.
www.aveva.com
© Copyright 1974 to current year. 78
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
for ‘Engineering UDETs.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘UDETs’, then click on the ‘Load New Data’ button to run the import process.
This creates the required hierarchy elements for engineering UDETs as shown
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
for ‘Engineering UDAs.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘UDAs’, then click on the ‘Load New Data’ button to run the import process.
This creates the required hierarchy elements for engineering UDAs as shown
www.aveva.com
© Copyright 1974 to current year. 79
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
for ‘Engineering Default Homes.xls’, to populate the Spreadsheet Import form with data to create
hierarchical elements for ‘Default Homes and Schemas’, then click on the ‘Load New Data’ button to run
the import process.
Also run similar procedures to import the following items which are part of the Distributed Attribute
Definition, and create the required hierarchy elements as shown
Create hierarchical elements for Default Homes and Distributed attribute Schemas as shown
www.aveva.com
© Copyright 1974 to current year. 80
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Create hierarchical elements for Default Home Destination Definition (DSXDST) and Bound Elements
Definition (DSXMBR) as shown
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Status Definition.xls’, to populate the Spreadsheet Import form with data to create
hierarchical elements for ‘Status Definition’, then click on the ‘Load New Data’ button to run the import
process.
This creates the required hierarchy elements for engineering status definitions as shown
www.aveva.com
© Copyright 1974 to current year. 81
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Status Values.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘Status Values’, then click on the ‘Load New Data’ button to run the import process.
This creates the required hierarchy elements for engineering status values as shown
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Database views.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘Database views’, then click on the ‘Load New Data’ button to run the import process.
Also run similar procedures to import the following items which are part of the Database views Definition, to
create the required hierarchy elements as shown
www.aveva.com
© Copyright 1974 to current year. 82
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Source elements.xls’, to populate the Spreadsheet Import form with data to create
hierarchical elements for ‘Source Elements’, then click on the ‘Load New Data’ button to run the import
process.
This creates the required hierarchy elements for database views Source Elements as shown
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Dbviews ATTCOLS.xls’, to populate the Spreadsheet Import form with data to create
hierarchical elements for ‘Dbviews ATTCOLS, EXPCOLs, Creation rules and filters, then click on the
‘Load New Data’ button to run the import process.
This creates the required hierarchy elements for the described entries as shown
www.aveva.com
© Copyright 1974 to current year. 83
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
12.3.6.2.1 Set Parameter (SETPAR) + Set Attribute (SETATT) + Set Status (SETSTA)
Click on the ‘Open file’ button, to display the ‘Import Data’ file picker form, and select the template Excel file
‘Engineering Creation rules.xls’, to populate the Spreadsheet Import form with data to create hierarchical
elements for ‘Set Parameters, Set attributes and Set Status’, then click on the ‘Load New Data’ button to
run the import process.
This creates the required hierarchy elements for Set Parameters and set attributes as shown
Populated items for import can be processed individually, as changes can be made to entries in the
Excel template, and that change can be brought into the dictionary database singly
Each item on the ‘Spreadsheet Import’ form can be selected individually and imported into the
dictionary database, or update already existing dictionary database
www.aveva.com
© Copyright 1974 to current year. 84
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
With the Excel import feature and properly configured Excel file templates, the engineering data model can
be set up relatively quickly and viewed as shown
www.aveva.com
© Copyright 1974 to current year. 85
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Appendix A
Appendix A
There are also a small number of pseudo attributes available on elements that are associated with
distributed attributes.
DATT NEW
The NEW command creates a new distributed attribute and associates the CE/on element with it.
Syntax:
The example creates a new distributed attribute of type :PRESSURE and associates it with CE.
Example:
DATT NEW :PRESSURE
DATT DELete
The DELete command removes distributed attributes from CE/from element
Syntax:
The example deletes the last distributed attribute member of type :PROCESS from /MyEquipment.
Example:
Q ATT
The existing Q ATT have been extended to allow for querying distributed attributes.
Syntax:
Q ATT [AS ANY | <type>]
The command displays all the values of the :PROCESS type associated with CE.
Example:
Q ATT AS :PROCESS
www.aveva.com
© Copyright 1974 to current year. 86
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Appendix B
Appendix B
Since more than one instance of a distributed element is handled [n] is used to qualify which instance the
user is interested in.
The syntax is used on both queries and manipulations of attributes, as well as in PML1
expressions.
Syntax:
:UDANAME\:UDETNAME
Example:
Q :LOCAL\:PROCESS
:local\process true
:LOCAL\:PROCESS false
-- Query all LNLIST elements where distributed attribute :local\:process equals true
Q :LOCAL\:PROCESS[2]
:local\process[2] true
-- Set the value of the second instance of distributed attribute :local\:process to false
:LOCAL\:PROCESS[2] false
-- Query all LNLIST elements where second instance of distributed attribute :local\:process equals true
www.aveva.com
© Copyright 1974 to current year. 87
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Appendix C
Appendix C
There are a few number of pseudo attributes available to all elements that may have distributed attributes
associated with them.
The attribute returns a list of all eligible distributed attribute types that may be associated with current
element. The list does not consider any constraints defined in the schema.
Example:
Q DLIST
This attribute returns a list of all distributed attribute types associated with current element.
Example:
Q XRLSTT
The attribute returns a list of all distributed attribute members (elements) associated with current element.
Example:
Q XRLIST
XRLIST
1 :PROCESS 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
2 :PRESSURE 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
www.aveva.com
© Copyright 1974 to current year. 88
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
The attribute returns the number of distributed attribute members (elements) associated with current
element. The attribute may take an optional qualifier on typename.
Example:
Q XRQCNT
XRQCNT 2
The attribute returns a selected distributed attributes member of distributed attribute members (elements)
associated with current element. The attribute may take an optional qualifier of typename.and relative
position.
Example:
Q XRQELE
XRQELE 1 :PROCESS 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
Q XRQELE ( 1 )
XRQELE 1 :PRESSURE 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
The attribute is available on the distributed attribute member and returns a list of attributes
that should be shown by default as attributes. The attribute fulfils the same purpose as
Example:
Q ATTDST
The attribute is available on the any element, in addition to be used for distributed attributes, it may be used
in a generic way.
When used specifically for distributed attributes evaluation: It takes the typename of a bindable noun/udet as
qualifier. It evaluates the actual home element using current element as when evaluating the test
expressions and returns a nulref or a ref to an XPIWLD element.
Note: The evaluation finds the associated DSXHOM from the typename qualifier, after that
processing is the same as for the generic case.
Using it for generic "find a default home" purposes: The DSXHOM reference passed as a qualifier is used to
evaluate the expressions defined in the DSXTST/DSXDST of that DSXHOM. It returns a nulref of the ref of
the ID value held in the DHTEXT attribute of the resulting DSXDST. The CE is passed to the expression for
evaluation.
www.aveva.com
© Copyright 1974 to current year. 89
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552
Example:
-- distributed attributes, get the location to store distributed attributes of type process for CE.
-- Generic example, get the reference that results of evaluation the DSXHOM /MyHomeSelector
for/TESTTHIS.
Datal
Syntax:
For example: getting everything under the ZONE /MyZone including any distributed attributes would be done
by executing the following output command:
Part of the output would resemble the following, with the distributed attributes statements included:
NEW EQUI
DATT NEW :Process
:Local\:Process false
END
For further details on Distributed Syntexes, please refer to Database Management Reference
Manual.
www.aveva.com
© Copyright 1974 to current year. 90
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.