You are on page 1of 90

AVEVA Plant

(12.1)

TRAINING GUIDE
AVEVA Engineering
Tags (Administration)

TM-3552

www.aveva.com
AVEVA Engineering (12.1)
Tags (Admin) TM-3552

Revision Log

Date Revision Description of Revision Author Reviewed Approved


21/09/2011 0.1 Issued for Review KI ,HU
06/09/2011 0.2 Reviewed KI, HU JB
07/11/2011 1.0 Approved for Training 12.1 KI, HU JB BT
30/11/2011 2.0 Issued with latest copyright KI, HU JB BT

Updates

All headings containing updated or new material will be highlighted.

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.

Visit our website at http://www.aveva.com

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.

Unauthorised or unlicensed use of the software is strictly prohibited.

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

Printed by AVEVA Solutions on 30 November 2011

© AVEVA Solutions and its subsidiaries 2001 – 2011

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

12.2 Accessing the Excel Import feature ............................................................................................. 75


12.3 Creating Engineering Data Model in Dictionary Database ........................................................ 76
12.3.1 Worlds + Groups ...................................................................................................................... 77
12.3.2 User Defined Element Types (UDETs) .................................................................................... 79
12.3.3 User Defined Attributes (UDAs) ............................................................................................... 79
12.3.4 Distributed Attribute Definition.................................................................................................. 80
12.3.4.1 Default Home Definition (DSXHOM) + Distributed Attributes Schema (DSXSCH).......... 80
12.3.4.2 Binding Elements Definition (DSXOWN).......................................................................... 80
12.3.4.3 Default Home Destination Definition + (Bound Elements Definition ................................ 81
12.3.5 Status Definition ....................................................................................................................... 81
12.3.5.1 Status Values ................................................................................................................... 82
12.3.6 Database Views ....................................................................................................................... 82
12.3.6.1 Database views Source Element ..................................................................................... 83
12.3.6.2 Database views Attribute + Expression columns + Creation rules + Filters .................... 83
12.3.6.2.1 Set Parameter (SETPAR) + Set Attribute (SETATT) + Set Status (SETSTA)........... 84
Appendix A ..................................................................................................................................................... 86
New Syntaxes For Distributed Attributes................................................................................................ 86
Appendix B ..................................................................................................................................................... 87
Distributed Attributes and Attribute Syntax .......................................................................................... 87
Appendix C ..................................................................................................................................................... 88
Pseudo Attributes Associated with Distributed Attributes ................................................................... 88

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.

1.4 Course Structure

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.

1.5 Using this guide

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

2 Data Model Setup for AVEVA Tags - Overview

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:

 Possiblilty to distribute an objects attribute across database


 Allowing users or multi-discipline to work on different sets of data of an object in parallel.

All the data modelling is done in LEXICON Module and the engineering tags items are created in the AVEVA
Tags module.

2.1 Entering AVEVA Lexicon Application

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:

On Lexicon login box, enter the following;

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

Exercise 1 - Entering AVEVA Lexicon Application

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

3 Developing Data Model Definition – Overview

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:

 Type of engineering tag item to create and manage.

 Type of attributes that are required

 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.

3.2 Decision on type of Attributes Engineering Items Required

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

Mechanical Attribute Electrical Attribute


(Data) (Data)
Process Attribute
(Data)

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

3.3 Discipline Requirements to Modify / Update Engineering Item Data

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”

Engineering Element e.g


PUMP & MOTOR

Mechanical Attribute
(Data)
Electrical Attribute
(Data)

Process Attribute
(Data)

3.4 Data Model Definition Setup - Required Steps

To set up a simple data model definition as shown in the example above, a number of procedures must first
be completed.

1. Creation of the required Engineering Databases

- Creation of the required User Defined Element Types (UDET)

2. Create UDETs with base type XPITEM

3. Create UDETs with base type ENGITE

4. Create and Assign User Defined Attributes (UDAs)

- Distributed Attributes setup

5. Nominate Engineering UDET as owner of the Distributed Attribute

6. Nominate Distributed Attribute UDET as member of Engineering UDET

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

- Default Home for Distribution Attribute setup

7. Create default Home for Distribution Attribute

8. Define the destination expression (Using the XPIWLD Name defined in AVEVA Tags database Explorer)

9. Database Views setup

Data Model Definition Setup Steps - Overview

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

Exercise 2 – Develop a Data Model Definition Using Flow Chart Diagram

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:

 Line list should contain the following data

- Process data
- Piping Material Data
- Piping Stress Data

In the Sketching the data model definition represent:

- Engineering Element as “LineTags” Attribute Data.


- Process data - as data that is directly attached to the Engineering Element (i.e “LineTags” Attribute
Data).
- Piping Material and Stress Data as data on the engineering element (i.e LineTag Attribute Data),
that are owned and managed by Piping Material and Stress team respectively.

www.aveva.com
© Copyright 1974 to current year. 16
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 4

4 Create Engineering Databases

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.

4.1 Creating Engineering Databases and Distributed Hierarchy

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.

Engineering Element e.g


PUMP & MOTOR

Mechanical Mechanical Attribute


Engineers (Data)
ENGI DB
Electrical Attribute
(Data) Elec Data
ENGI DB

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.

 Create three (3) Separate Teams as highlighted in the example below:

- Mechanical Team
- Eletrical Team
- Process Team

 Create three (3) different users as highlighted in the example below:

- 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

 Create three (3) different databases for example:

1. Create Mechanical Engineering Database – To store Engineering Attribute Data that is


directly attached to engineering Item in this case “Pump & Motor”.

- To create an Engineering World for Mechanical


Attribute data in AVEVA Tags database Explorer,

- Select “Engineering Data World” from Element


Type pull-down list

- The “Create ENGWLD” (Engineeing World) field


is then displayed. Enter the required value in this
case MECHAttData as highlighted.

 Engineering World (ENGWLD) is a top–level


administrative container for engineering elements
with non distributed attribute data.

2. Electrical Engineering Database - Storage for Distributed Electrical Attibute Data

- To create Distrbuted attribute data World (top-


level administrative element) for Electrical
Attribute data in AVEVA Tags database
Explorer,

- Select “Extended Properties World” from


Element Type pull-down list

- The “Create XPIWLD” (Distributed World)


field is then displayed. Enter the required
value e.g ELECTAttData as highlighted.

 Distributed World (XPIWLD) is a top–level


administrative container for distributed
attribute data.

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

3. Process Engineering Database - Storage for Distributed Process Attribute Data.

- To create Distrbuted attribute data World (top-level


administrative element) for Process Attribute Data
in AVEVA Tags database Explorer,

- Select “Extended Properties World” from


Element Type pull-down list

- The “Create XPIWLD” (Distributed World) field is


then displayed, enter the required value in this
case PROCAttData as highlighted

 Distributed World (XPIWLD) is a top–level


administrative container for distributed attribute
data.

For further details, on how to create Database, Please


refer to AVEVA Plant System Administration User Guide
(TM1300)

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:

For further details, AVEVA Tags Database Explore


Please refer to AVEVA Tags Training Guide (Basic)

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

Exercise 3 – Creating Engineering Database and Distributed Hierarchy

Using the data model definition developed in exercise 1:

 Create the following Teams

- Process Team
- Piping Material Team
- Piping Stress Team

 Create the following users

- Process Users
- Piping Material Users
- Piping Stress Users

 Create the following databases

- Process Engineering Database – To store Engineering Element Attribute Data that is


directly attached to engineering Item in this case “LineTags”

- 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

5 Data Model Definition for Engineering Elements / Items

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:

Engineering Element e.g


PUMP & MOTOR

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:

 Create engineering element UDETs


 Create / assign attributes to the engineering element UDETs

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

5.1 Create Enginering Element UDETs

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

 UDETs World (UDETWL) is the top


level container for UDETs. And
UDETs Group (UDETGR) are
means of organining UDETs sets.
They are containers that can be
used or ignored when organising
UDETs.

- Create a new UDET for the engineering element (Pump) with BASETYPE set to ENGITE as
shown:

Engineering element UDETs for (Pump)

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.

Engineering element UDET for (Motor)

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

5.2 Create / Assign User Defined Attribute (UDAs) to UDETs

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.

Assign ”Tag Number” UDA for Pump & Motor UDET

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:

Assign ”P&ID” UDA to Pump UDET (:ENGIPUMPTAG)

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:

Right-click on the require UDET and select


Graphical View from the right-click menu.

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

Exercise 4 – Create Engineering Element UDET and UDAs

Using the data model definition developed in exercise 1:

 Create engineering Element UDET to represent LineTag (:LineTags)

 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)

 Display the data model graphical view of the UDET(:LineTags)

www.aveva.com
© Copyright 1974 to current year. 28
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 6

6 Distributed Attribute Data Model Definition Setup - Overview

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.

Engineering Element e.g


PUMP

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 Definition

- To define the distributed attribute schema with


associating elements types and distributed group.

Default Home Definition

- To define the location where the distributed attributes


are to be stored and managed.

Default Home Definition Distributed


attribute Definition

6.1 Distributed Data Model Definition Configuration

Distributed attributes are made up of UDETs which are associated with the binding element that they add
attributes to. To configure distributed attributes:

 Create UDETs to be used as distributed attribute groups.

 Create the attributes to be included in the attribute groups.

 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

7 Create Distributed Attribute Group UDETs

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.

7.1 Create UDETs to be used as Distributed Attribute Groups

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 UDETGR, (Udet Group) for the Distributed Attribute UDET

 UDETs Group (UDETGR) to organise the


distributed UDETs.

- Create a new UDET for Process distributed attributes and another for Electrical distributed
attributes. The BASETYPE for each of these UDETs set to XPITEM.

Process distributed attribute UDET

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.

Electrical distributed attribute UDET

7.2 Create / Assign (UDAs) to Distributed Attributes Group (UDETs)

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.

Electrical Rated Torque, Motor Speed, Efficency and


(ENGIPUMP_ELECATT) Electrical_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:

Assign “RatedTorque” UDA to Electrical UDET

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”.

Assign Efficency UDA to Electrical UDET

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:

Right-click on the require UDET 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. 34
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552

Exercise 5 – Create Distributed Attribute Group UDETs and UDAs

Using the data model definition developed in exercise 1:

 Create the following Attribute group data listed below as Distributed Attribute UDET

- Piping Material Data as (:PIPEMAT_DISTR_ATTRIBUTE)


- Piping Stress Data as (:PIPESTRE_DISTR_ATTRIBUTE)

 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

Piping Stress Data 1. Stress Reason


(:PIPESTRE_DISTR_ATTRIBUTE) 2. Preliminary Stressing
3. Stress Critical
4. Stress_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

8 Create Distributed Attribute Schema

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)

8.1 Create Distributed Attribute Schema

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, or access the DSXWLD (Distrubted Attribute


definition World) hierarchy:

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

In Current Element Editor Form, complete the


Name and description field as required.

For this example enter:

Name field enter ---- ENGIPUMP_Group


Description field enter ----- ENGINEERING PUMP
GROUP

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:

 The distrubted attribute schema is


represented by the DSXSCH element
and consists of a name and optional
default home reference. The default
home reference may be overridden at
lower levels in the schema.

In Current Element Editor Form, complete the Name


and description field as required.

For this example enter:

Name field enter -ENGIPUMP_Schema

Description field enter - ENGINEERING PUMP


SCHEMA

Default Home field – unset (this is set at lower level in


the schema)

 Default Home identifies the default home


selector for the binder.

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:

 The Binding Element Definition


(DSXOWN) defines the element
that may be extended by
distributed attributes. The
definition contains an element
list (ELEL) which designates the
element types. It also contains a
default home reference that if set
override default home on the
scheme level.

In Current Element Editor Form, complete the Name and description field as required.

For this example enter:

Name field enter -


ENGIPUMPTAG_Distribution

Description field enter –


ENGINEERING PUMPTAG
DISTRIBUTION

 Name and Description field are not mandatory

Default Home field – unset (this is set at lower level in the


schema)

Element Types Field, Select the browse button from the


Element Type field, to select the require element type, in this
case PUMP (owner of distributed attributes groups
:ENGIPUMPTAG).

Click Ok button 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

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.

For this example enter:

Name field enter -


ENGIPUMP_DISTR_PROC_ATTRIBUTES

Description field enter - ENGINEEERING


PUMPTAG DISTRIBUTED PROCESS
ATTRIBUTES

Name and Description field are not


mandatory

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

Exercise 6 – Create Distributed Attribute Group Schema

Using the Engineering and Distributed Attribute Group UDETs created in exercise 4 and 5

 Create the Distributed Attribute Schema

 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

9 Create Default Home Destination

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.

9.1 Create Default Home Destination

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:

In Current Element Editor Form,


complete the Name and
description field as required.

For this example enter:

Name field enter – ENGIPUMPTAG_PROC_HOME

Description field enter - PROCESS DISTRIBUTED ATTRIBUTES GROUP HOMES

 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.

In Current Element Editor Form, complete the relvent field as shown:

For this example enter:

Name field enter – ENGIPUMPTAG_PROC_DISTR_ATT_DISTINATION

Description field enter - HOME DISTINATION FOR PROCESS ATTRIBUTE DATA

 Name and Description field are not mandatory

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

Exercise 7 – Create the Default Home Destination

With reference to the Distributed Attribute Schema created in exercise 6.

 Create Default Home Definition (DSHOM) and Default Home Destination Definition (DSXDST)
for the Distributed Attributed Group, in this case

- Piping Material Data (:PIPEMAT_DISTR_ATTRIBUTE)


- Piping Stress Data (:PIPESTRE_DISTR_ATTRIBUTE)

 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

10.1 Database Views control

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)’

Attribute Columns (ATTCOLs)

Expression Column (EXPCOL)

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’

10.2 Creating Database Views

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.

 * Hierarchy is not complete and is expanded elsewhere on the diagram


+ Definition is recursive
www.aveva.com
© Copyright 1974 to current year. 50
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552

DBVWWL The top-level administrative element.


(Database View World)
DBVWGR Used to group definitions into manageable administrative sets, this is for
(Database View Group) administration only and is not visible to users in other contexts.
DBVWSE Used to group Database Views for user presentation. These should contain related
(Database View Set) views as they are visible to the user. A Database View can be a member of a
Database View Set even if it is not a direct member.
DBVW A table definition that defines the display name, element criteria and columns.
(Database View)
ATTFIL An attribute filter is a test executed against the selected element based on the
(Attribute Filter) value of a specified attribute such as DESC Equals Vessel. A database element
must match all filters present in the Database View to be present in the resulting
table.
EXPFIL An expression that must evaluate to TRUE or FALSE to determine whether a
(Expression Filter) database element is part of the database view. A database element must match all
filters present in the Database View to be present in the resulting table.
ATTCOL This is an element which defines columns based on a single attribute. Attributes
(Attribute Column) may be system attributes or UDAs. Qualifiers can be specified where required
such as when accessing the status of a particular element. Columns based on
attributes are by default editable but can be made to be read only to help with
workflow management.
EXPCOL This is an element which defines columns based on a PML or XPATH expression.
(Expression Column) Expression columns are read only unless software is written to make them
editable.
SRCELE This is an element which defines a navigational step from the current context
(Source Element) element to another database element. All columns defined in the Source Element
are then based on the element that results from the navigation. Such columns are
editable so rows in Database Views allow editing of more than one database
element.
CRERUL This defines the rules for element creation. If within a DBVW element then the
(Create Rules) rules permit row creation for the Database View provided that the AUTCRE
attribute is set to TRUE. Information such as where to create the new item or what
type of element to create can be fixed or specified using expressions
SETPAR This is an element used to define parameters for expressions in other create rules.
(Set Parameter Rule) A parameter can be used in expressions on the CRERUL, SETATT or TESTEX
elements. Parameters provide the ability to prompt a user for a single piece of
information and then use it in multiple expressions.
SETATT This defines a rule to set a database attribute when the element is created. This
(Set Attribute Rule) allows attributes to be defaulted at the point of creation of forces a user/application
to provide a mandatory attribute value at the time of element creation.
SETSTA This defines a rule to assign a status to the created item at the time of creation.
(Set Status Rule) This will help ensure all elements are being status managed.
TESTEX if this evaluates to true then the owning rule will be carried out, otherwise the
(Test Expression) owning rule is ignored.
COLREL This element defines a Parent/Child relationship between columns for application
(Column Relation) use. These relationships are currently not supported in the standard applications.

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

10.2.1 Database Views World (DBVWWLD)

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.

10.2.2 Database Views Group (DBVWGR)

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

Fill in the attribute details as shown.

10.2.3 Database Views (DBVW)

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.

Fill in the attribute details as shown.

 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

10.2.3.1 Attribute Columns (ATTCOL)

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.

Fill in the attribute details as shown.

 The utilized Attribute :TAG_NUMBER entry is an engineering UDA which has been pre-defined for
this exercise

Create 3 more Attribute Column (ATTCOLs) as shown.

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

10.2.3.2 Expression Column (EXPCOL)

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.

Fill in the attribute details as shown.

 Create an addition expression column (EXPCOL) for ‘Status’ definitions

10.2.3.3 Attribute Filter (ATTFIL)

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.

Fill in the attribute details as shown.

10.2.3.4 Expression Filter (EXPFIL)

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

10.2.3.5 Create Rule (CRERULE)

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.

Fill in the attribute details as shown.

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

10.2.3.5.1 Set Parameter (SETPAR)

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

Fill in the attribute details as shown.

 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

10.2.3.5.2 Set Attribute (SETATT)

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.

 Enter the expressions '/$!PumpPre-$!PumpMod-$!Pumpite' for ‘Pump name rule’, ’$!PumpPre-


$!PumpMod-$!Pumpite-$!PumpSuf' for the tag number rule, and '$!PumpMod' for the ‘Model
Number’ rule www.aveva.com
© Copyright 1974 to current year. 59
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (12.1)
Tags (Admin) TM-3552

10.2.3.5.3 Set Status (SETSTA)

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.

Fill in the attribute details as shown.

 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

10.2.3.6 Source Element (SRCELE)

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’

Although the UDET (:ENGIPUMP_PROCATT) is a distributed discipline of the engineering UDET


:ENGIPUMPTAG, expression can be formulated to extract any element type or UDET as a source element.

Fill in the attribute details as shown.

 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.

Re-align, and position all created hierarchy items 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

10.3 Database View Set (DBVWSE)

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

10.4 Database view management

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.

These Definition sets include:

• 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

10.5 Preview created Database view list/table

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

List based on Defined Database View

The displayed table contains columns and items which conforms to the requirements of the rules within the
set filters and Creation rules configuration

PUMP View Columns

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).

Source Element Columns in Pump View

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

Exercise 8 – Create Database View

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 an Attribute filter

- Create ‘Creation rules’

- Create ‘Set Parameters’ and ‘Set attribute’ rules

1 (b).Within the DatabaseView defined for LineTags (:LineTags):

- 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

2. Using engineering UDETs Piping Material Data (:PIPEMAT_DISTR_ATTRIBUTE) created in exercise 5,


define a Database view (DBVW) for Piping Material Team using Current Element Editor form

- 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

3. Using engineering UDETs Piping Stress (:PIPESTRE_DISTR_ATTRIBUTE) created in exercise 5, define


a Database view (DBVW) for Piping Stress Team using Current Element Editor form

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.

11.1 Status Control of Engineering Element / Item

For this example, an existing status definition setup in Lexicon Module is used.

 In this example, the first status definition


(STADEF TagAttStatus) is defined for
distributed Attribute Group. And the second
status definition (STADEF TagStatus) is
defined for enegineering element item (i.e
owner of distributed attributes)

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.

The graphical view for the selected element is


then displayed as shown.

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

11.2 Status Control of Distributed Attribute Group

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:

Click Ok button from the Select element type form to


save the selected element to the Current Element
Editor form.

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

Exercise 9 – Status Control of Engineering and Distributed Attribute Group UDETs

Using the Distributed Attribute Group UDETs created in exercise 4 and 5

 Add Engineering Element UDETs listed below to STADEF/TagStatus

- LineTags (:LineTags)

 Add Distributed Attributes Group UDETs listed below to STADEF/TagAttStatus

- Piping Material Data (:PIPEMAT_DISTR_ATTRIBUTE)


- Piping Stress Data (:PIPESTRE_DISTR_ATTRIBUTE)

 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

12 Engineering Data Model Setup via Excel

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

12.1 Excel Templates

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.

12.2 Accessing the Excel Import feature

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

12.3 Creating Engineering Data Model in Dictionary Database

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

12.3.1 Worlds + Groups

Launch the Spreadsheet import form, with the


customised button or enter the syntax
‘!!EQUILOADCSV()’.into the command window.
This brings up the ‘Import data’ file picker form
as shown.

Change the ‘Files of type’ from ‘CSV files


(*.csv)’ to ‘Microsoft Excel files (*.xls)’ as this
is the format required for the Excels file.

Pick the appropriate file which contains the data


necessary for the creation of several ‘World’
hierarchy elements.

 Excel file templates can be supplied for


these examples

Hit the ‘Open’ button to display the ‘Spreadsheet


import’ form populated with data from the Excel file.

 The ‘Select File’ address bar notes the location


of the template Excel file whose data currently
populates the import form

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’

button to import the populated into the dictionary database.

This creates the required hierarchy ‘World’ elements as shown

 Successful imports are usually marked with a green tick

 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.

This creates the required hierarchy ‘Group’ elements as shown

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

12.3.2 User Defined Element Types (UDETs)

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

12.3.3 User Defined Attributes (UDAs)

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

12.3.4 Distributed Attribute Definition

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

12.3.4.1 Default Home Definition (DSXHOM) + Distributed Attributes Schema (DSXSCH)

Create hierarchical elements for Default Homes and Distributed attribute Schemas as shown

12.3.4.2 Binding Elements Definition (DSXOWN)

Create hierarchical elements for Owner Definition 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

12.3.4.3 Default Home Destination Definition + (Bound Elements Definition

Create hierarchical elements for Default Home Destination Definition (DSXDST) and Bound Elements
Definition (DSXMBR) as shown

12.3.5 Status Definition

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

12.3.5.1 Status Values

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

12.3.6 Database Views

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

12.3.6.1 Database views Source Element

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

12.3.6.2 Database views Attribute + Expression columns + Creation rules + Filters

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

Defined Engineering data Model Elements

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

New Syntaxes For Distributed Attributes

There are new syntaxes available to work with distributed attributes.

 The creation /deletion of the distributed attributes member(s)


 The manipulating of the individual values on the distributed attributes members.

New and Updated Syntax

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:

DATT NEW <type> [on <element>]

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:

DATT DELete ALL [<type>] [from < element>]


DATT DELete [FIRST | LAST | <int>] <type> [from <element>]

The example deletes the last distributed attribute member of type :PROCESS from /MyEquipment.

Example:

DATT DEL LAST :PROCESS FROM /MyEquipment

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

Distributed Attributes and Attribute Syntax

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:

-- Query the value of the :local\:process distributed attribute on CE

Q :LOCAL\:PROCESS

:local\process true

-- Set the value of distributed attribute :local\:process to false

:LOCAL\:PROCESS false

-- Query all LNLIST elements where distributed attribute :local\:process equals true

Q ALL LNLIST WITH (:LOCAL\PROCESS EQ true)

-- Query the value of the second instance of distributed attribute :local\:process

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

Q ALL LNLIST WITH (:LOCAL\PROCESS[2] EQ true)

www.aveva.com
© Copyright 1974 to current year. 87
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Appendix C

Appendix C

Pseudo Attributes Associated with Distributed Attributes

There are a few number of pseudo attributes available to all elements that may have distributed attributes
associated with them.

DLIST - Eligible Distributed Attributes Members

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

DLIST :PROCESS :PRESSURE

XRLSTT - List Distributed Attributes Member Types Associated

This attribute returns a list of all distributed attribute types associated with current element.

Example:

Q XRLSTT

XRLSTT :PROCESS :PRESSURE

XRLIST - List Distributed Attributes Member Associated

The attribute returns a list of all distributed attribute members (elements) associated with current element.

The attribute may take an optional qualifier on typename.

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

Q XRLIST (TYPENAME :PROCESS )


1 :PROCESS 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

XRQCNT - Count of Distributed Attributes Member Associated

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

Q XRQCNT (TYPENAME :PROCESS )


XRQCNT 1

XRQELE - Return a Single Distributed Attribute Member

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

ATTDST - List of Attributes to Show

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

ATTLIS for normal attributes.

Example:

Q ATTDST

ATTDST :TEMP :VISCOCITY

DFHOME - The Evaluated Default Home

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.

Q DFHOME ( TYPENAME :PROCESS )


DFHOME /THEPROCESSWORLD

-- Generic example, get the reference that results of evaluation the DSXHOM /MyHomeSelector
for/TESTTHIS.

Q DFHOME ( /MyHomeSelector ) OF /TESTTHIS


DFHOME /STOREITHERE

Datal

As a complement to normal Datal processing of distributed attributes, there is a specialized


support that generates datals with the distributed attributes syntax.

Syntax:

OUTPUT INCLUDE Distributed/ATTRIBUTES ... <SELELE> and other options

For example: getting everything under the ZONE /MyZone including any distributed attributes would be done
by executing the following output command:

OUTPUT INCLUDE DistributedA /MyZone

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.

You might also like