You are on page 1of 329

Training TM-3652

AVEVA Engineering (14.2)


Guide Administration

1
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This page is intentionally left blank.

AVEVA Engineering (14.2)


Engineering Administration (TM-3652)

Revision Log
Date Revision Description of Revision Author Reviewed Approved
Approved for Training 14.1
09/06/2014 1.0 HU / KI JB GC
Approved for Training
18/06/2015 2.0 14.1.SP1 HU / KI JB GC

KI / GC /
07/03/2017 3.0 Approved for Training 14.2. KI, GC GC
AJ

Updates
Change highlighting will be employed for all revisions. Where new or changed information is presented
section headings will be highlighted in Turquoise.

2
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
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.

3
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Copyright notice

All intellectual property rights, including but not limited to, copyright in this Training Guide and the associated
documentation belongs to or is licensed to AVEVA Solutions Limited or its affiliates.

All rights are reserved to AVEVA Solutions Limited and its affiliates companies. The information contained in
this Training Guide and associated documentation is commercially sensitive, and shall not be adapted,
copied, reproduced, stored in a retrieval system, or transmitted in any form or medium by any means
(including photocopying or electronic means) without the prior written permission of AVEVA Solutions
Limited. Where such permission is granted, AVEVA Solutions Limited expressly requires that the Disclaimer
included in this Training Guide and this Copyright notice is prominently displayed at the beginning of every
copy that is made.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Licenses issued by the Copyright Licensing Agency or any other reproduction rights organisation do not
apply. If any unauthorised acts are carried out in relation to this copyright work, a civil claim for damages
may be made and or criminal prosecution may result.

AVEVA Solutions Limited and its affiliate companies shall not be liable for any breach or infringement of a
third party's intellectual property rights arising from the use of this Training Guide and associated
documentation.

@AVEVA Solutions Limited 2017

Trademark

AVEVA™, AVEVA Everything3D™, AVEVA E3D™, AVEVA Engineering, Tribon and all AVEVA product and
service names are trademarks of AVEVA Group plc or its subsidiaries

Use of these trademarks, product and service names belonging to AVEVA Group plc or its subsidiaries is
strictly forbidden, without the prior written permission of AVEVA Group plc or AVEVA Solutions Limited. Any
unauthorised use may result in a legal claim being made against you.

Fluent is a trade mark of Microsoft Corporation. The Fluent user interface is licensed from Microsoft
Corporation by AVEVA and use of the Fluent trade mark is strictly forbidden

All other trademarks belong to their respective owners and cannot be used without the permission of the
owner.

CONTENTS

1 Introduction ............................................................................................................................ 9
Aim ...................................................................................................................................................... 9
Objectives .......................................................................................................................................... 9
Prerequisites ...................................................................................................................................... 9
Course Structure ............................................................................................................................... 9
Using this guide ................................................................................................................................ 9
2 AVEVA Engineering Data Model .......................................................................................... 10
AVEVA Engineering Project Data Setup – Admin Module .......................................................... 12
2.1.1 Standard Project Data Setup ..................................................................................................... 13
AVEVA Engineering Data Setup – Lexicon/Configuration
Module ............................................ 13
AVEVA Engineering Data Setup – AVEVA Engineering Application ......................................... 14
3 Standard Project Data Setup ............................................................................................... 15
Standard Project Data Definition in Admin Module ..................................................................... 15
3.1.1 Creating an Empty Project ......................................................................................................... 17
3.1.2 Create Discipline - A Worked Example ...................................................................................... 18

4
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Exercise 1(a) – Standard Project Data Definitions – [Define Discipline] .................................
23
3.1.3 Create Teams and Users ........................................................................................................... 24
Exercise 1(b) – Standard Project Data Definitions – [Teams & Users] ....................................
33
3.1.4 Create Databases and MDBs .................................................................................................... 34
Exercise 1 (c) – Standard Project Data Definitions – [Define Database] .................................
38 Exercise 1 (d) – Standard Project Data Definitions – [Define MDB] ........................................
42
4 Developing a Data Model in AVEVA Lexicon/Configuration .............................................. 45
Developing a Data Model in Lexicon/Configuration Module ...................................................... 45
Developing a Data Model from
Scratch ........................................................................................ 46 4.2.1 Create BaseModel with
Dabacon Definitions ............................................................................ 47
4.2.2 Create Engineering Class .......................................................................................................... 51
Exercise 2 – Create Engineering Class ..................................................................................... 57
4.2.3 Create Engineering Class Attributes .......................................................................................... 58
Exercise 3 – Create Engineering Class Attributes .................................................................... 70
4.2.4 Create Engineering Class Associations ..................................................................................... 71
Exercise 4 – Create Engineering Class Associations .............................................................. 78
4.2.5 Assign Discipline to Engineering Class Attributes ..................................................................... 79
Exercise 5 – Assign Discipline to Engineering Class Attributes ............................................. 82
4.2.6 Build the Model .......................................................................................................................... 83
Export and Import Conceptual Data Model .................................................................................. 89
4.3.1 Export Conceptual Data Model .................................................................................................. 89
4.3.2 Import Conceptual Data Model – A Worked Example ............................................................... 91
Exercise 6 – Import and Build Conceptual Data Model .......................................................... 100
5 Status Definitions ............................................................................................................... 103
Create Status Configuration World Element (STAWLD) – A Worked Example ...................... 103
5.1.1 Create Status Definition Element (STADEF) ........................................................................... 105
5.1.2 Create Status Value Element (STAVAL) ................................................................................. 108
Exercise 7 – Status Definition .................................................................................................. 112
6 Database Views .................................................................................................................. 113
Database Views Definition ........................................................................................................... 113
Database Views Control ............................................................................................................... 114
Database Views Setup .................................................................................................................. 117
Database Views Editor .................................................................................................................. 118

Database Views Editor – View Definition Set ............................................................................. 119


6.5.1 Create Database Views – A Worked Example ........................................................................ 119
6.5.2 Defining Database View Attribute Column – A Worked Example ............................................ 124
Exercise 8 (a) – Database View Definition ............................................................................... 129
6.5.3 Defining Source Element Data................................................................................................. 130
6.5.4 Defining Source Element Data – A Worked Example ............................................................. 130
Exercise 8 (b) – Database View Definition – [Source Element Data] .....................................
135 6.5.5 Define Creation Rules – A Worked Example ...........................................................................
136
6.5.6 Define Parameters – A Worked Example ................................................................................ 137
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

6.5.7 Define Attribute Rule – A Worked Example ............................................................................. 138


6.5.7 Define Status Rules – A Worked Example .............................................................................. 141
6.5.8 Data Model - Overview ............................................................................................................ 143
Exercise 8 (c) – Database View Definition – [Creation Rules] ................................................
144
7 Datasheets .......................................................................................................................... 147
Datasheet Configuration Overview ............................................................................................. 147 7.1.1
Database Views Set for Datasheets – A Worked Example ..................................................... 148
7.1.2 Create Datasheet Template Records – A Worked Example ................................................... 154
7.1.3 Adding Border to Datasheet Template – A Worked Example ................................................. 162
7.1.4 Reference Existing Datasheet Template Excel File – A Worked Example ............................. 165
7.1.5 Database Attribute Mapping to Datasheet Template – A Worked Example ............................ 167
7.1.6 Auto Database Attribute Mapping to Datasheet Template ...................................................... 170
7.1.7 Auto Database Attribute Mapping to Datasheet Template – A Worked Example ................... 171
7.1.8 Units of Measure Definitions (Unit Sets) .................................................................................. 174
7.1.9 Units of Measure Definitions (Unit Sets) – A Worked Example ............................................... 176
7.1.10 Assigning Default Units of Measure to Datasheet Template Cell – A Worked Example ......... 179
7.1.11 Assigning Unit Sets to Datasheet Template – A Worked Example ......................................... 182
Using Standard Controls Operations in Datasheet Template Cells ......................................... 184
7.2.1 Mapping Checkbox to Datasheet Template – A Worked Example.......................................... 184
7.2.2 Mapping Radio Button to Datasheet Template – A Worked Example ..................................... 186
7.2.3 Mapping Picture Box to Datasheet Template – A Worked Example ....................................... 188
7.2.4 Mapping Free Text Cell to Datasheet Template – A Worked Example ................................... 192
7.2.5 Mapping Page Info to Datasheet Template – A Worked Example .......................................... 194
7.2.6 Mapping Process Cases to Datasheet Template .................................................................... 195
7.2.7 Mapping Process Cases to Datasheet Template – A Worked Example ................................. 197
Continuation Area to Datasheet Template ................................................................................. 198
7.3.1 Continuation Area to Sublist in Datasheet Template – A Worked Example ............................ 198
Mapping Symbols to Datasheet Template .................................................................................. 201
7.4.1 Mapping Symbols to Datasheet Template – A Worked Example ............................................ 202
Adding Sketch Control to Datasheet Template .......................................................................... 204
7.5.1 Adding Sketch Control to Datasheet Template – A Worked Example..................................... 204
Adding Note Page Control to Datasheet Template .................................................................... 208
7.6.1 Adding Note Page Control to Datasheet Template – A Worked Example .............................. 209
Adding Front Page to Datasheet Template ................................................................................ 210
7.7.1 Adding Front Page to Datasheet Template – A Worked Example .......................................... 211
Datasheet Revision Control Configuration ................................................................................ 214
7.8.1 Datasheet Revision Control Configuration – A Worked Example ............................................ 214
Mapping Revision Block and Mark to Datasheet Template ...................................................... 227
7.9.1 Mapping Revision Block and Mark to Datasheet Template – A Worked Example .................. 227
Adding Display Rules to Datasheet Template ........................................................................ 229
7.10.1 Datasheets Template – Display Rules Creation – A Worked Example ................................... 232
Exercise 12 – Datasheet Configuration ................................................................................... 237
List Datasheet Template Definition ......................................................................................... 240
7.11.1 List Datasheets Template Definition– A Worked Example ...................................................... 240
Exercise 13– List Datasheet Configuration ............................................................................. 247
8 Project Explorer Configuration .......................................................................................... 249
Flexible Explorer Configuration Structure ................................................................................. 250

6
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
(14.2)
Engineering Administration (TM-3652)

AVEVA Engineering

Flexible Explorer Configuration without Reference to External PML Functions Files – A


Worked Example ...................................................................................................................................... 251
8.2.1 Create a PBS World (PBSWLD) – Worked Example .............................................................. 251
8.2.2 Create a PBS Template (PBSTPL) – Worked Example .......................................................... 252
8.2.3 Create a PBS Text Node (PBSTXN) – Worked Example ........................................................ 255
8.2.4 Create a PBS Object Node (PBSOBN) – Worked Example .................................................... 256
8.2.5 Create a PBS Criteria Node – A Worked Example ................................................................. 263
Exercise 14 – Flexible Explorer Configuration ........................................................................ 266
9 AutoNaming Engineering items ........................................................................................ 267
AutoNaming Feature ..................................................................................................................... 267 9.1.1
AutoNaming Configuration Setup – A Worked Example ......................................................... 268
9.1.2 AutoNaming Configuration Setup with Rule Definition – A Worked Example ........................ 273
9.1.3 AutoNaming Configuration with Condition based Rule – A Worked Example ......................... 276
Exercise 15– AutoNaming Definition ....................................................................................... 277
10 Appendix

A ..........................................................................................
............................ 278 Syntax for Distributed
Attributes ......................................................................................
....... 278
Distributed Attributes and Attribute Syntax ........................................................................... 279
Pseudo Attributes Associated with Distributed Attribute Syntax ........................................ 280
11 Appendix B ...................................................................................................................... 283
Version Control Configuration (VERCON) .............................................................................. 283

7
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This page is intentionally left blank.

CHAPTER 1

1 Introduction
This training guide has been developed for the engineering project administrative user who will be
responsible for the creation, configurations and maintenance of a defined project data infrastructure (data
model). The sections covered within, attempt to detail and describe all relevant steps required for structuring
an engineering data model.

Aim

This guide aims to be a source of the administrative knowledge necessary for the administration of an
AVEVA Engineering project. This includes the complete definition, setup and configuration of an
appropriate engineering data structure, which will be run within the AVEVA Engineering Tags module.

Objectives

• Definition of a standard AVEVA Engineering data model using the new Data Modelling tool
feature

• Descriptions of the standard creation of project users, teams, databases and multiple databases
(MDBs)

• Detailed descriptions of the creation and setup of required elements within the
LEXICON/CONFIGURATION modules

• Configuration and setup of the user workspaces within the AVEVA Engineering Tags application

Prerequisites

Trainees should be familiar with the use of Admin modules of AVEVA PDMS / Outfitting / E3D or AVEVA
Administration products. Knowledge of the use and manipulation of the AVEVA Engineering Tags
application is essential.

Course Structure

Training will consist of oral and visual presentations, demonstrations and set exercises. During the course, a
training project will be created and populated with model objects. This will be used by the trainees to practice
their methods, and complete the set exercises.

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.

8
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Information the user has to key-in will be in bold red text.

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.

9
CHAPTER 2

2 AVEVA Engineering Data Model


AVEVA Engineering is a data model management and visualisation application with which tagged items
can be created, managed and stored, whilst maintaining a firm integration with corresponding or referenced
3D, Schematic and/or Engineering items.
An AVEVA Engineering data model could be structured to cater to a wide variety of engineering workflows
and scenarios as required by the users or the engineering tasks being run. Typical AVEVA Engineering
data models could be for (but not limited to…):

• The creation and/or management of tagged or engineering items (Data source)


• Data integration centre between several sources (data hub)
• Data visualisation
• Multi user and Multi discipline working environment
• Generation of standard engineering data deliverables

Engineering data models are dependent on a project requirements, and are defined by the project
applications implementation stakeholders. In order to simplify the process a new improved Data Modelling
tool has been introduced in AVEVA Engineering 14.2.
The Data Modelling tool is a new feature that has been implemented to help construct a flexible data model
for AVEVA Engineering in a rapid and intuitive way, without needing to create user-defined element types
(UDETs), user-defined attributes (UDAs) or their Distributed Attribute schema manually.
The new Data Modelling feature provides the capability to develop a conceptual engineering data model,
which can then be automatically compiled into Dabacon schema for use by AVEVA Engineering.

Example of a typical Conceptual Engineering Data Model

10
AVEVA Engineering

The new Data Modelling also works in conjunction with AVEVA Information Standards Manager (ISM)
technology, which is also used by AVEVA NET, by being able to import an ISM file as the basis for a
conceptual model to be used by AVEVA Engineering.

An AVEVA Engineering data model is setup and configured by an Administrator, using the Configuration
module of AVEVA Engineering 14.2 or the Lexicon module of AVEVA Administration 1.5.

Physical
Equipment
Category
Pump Dynamic

(14.2)
Engineering Administration (TM-3652)
Centrifugal

Component
Part s Casing

Impeller

Nozzle

Shaft

This training guide covers the administrative requirements for a standard AVEVA Engineering data model
setup and configuration for a multi user and multi discipline project. It details the steps required for
structuring an engineering conceptual data model in AVEVA Engineering™; to manage Engineering tag
information used in key project deliverables such as Line List and Equipment index.

AVEVA Engineering Project Data Setup – Admin Module

AVEVA Engineering 14.2 is administered with the Admin and LEXICON modules of the AVEVA
Administration or Configuration module of AVEVA Engineering 14.2
A schematic breakdown of a standard data model definition with its required procedures is displayed below:

11
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

AVEVA Engineering project setup can be conducted using any of the methods listed below:

• Project Data Setup for Non Inter-disciplinary (Standard Project Setup)


• Project Data Setup for Inter-disciplinary
• Project Data Setup for Tag Management System

The selection of a project creation method by the System Administrator is usually dependent on the project
requirements.

 The guide will only focus Project Data Setup for Non Inter-disciplinary (Standard Project Setup)

AVEVA Engineering

2.1.1 Standard Project Data Setup

12
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
(14.2)
Engineering Administration (TM-3652)

The Standard Project Setup is the minimum configuration that is required to deliver the functionalities in
AVEVA Engineering application.

Within the Admin module for a standard project, the following entities can be created and configured as
required:
Admin
 Disciplines
module

 Users Create Create Create Create


Create
Teams DBs MDBs
Disciplines Users
 Teams

• Databases (ENGI DB)

• Multiple Databases (MDBs)

AVEVA Engineering Data Setup – Lexicon/Configuration


Module

The LEXICON/CONFIGURATION module provides the Advanced User(s) (System Administrator), or those
otherwise with responsibility for setting up an engineering data model framework and configuring the
installation of AVEVA Engineering

The LEXICON module reads and writes to a dictionary and Conceptual databases. Access to the modules is
limited to either Free Users, or members of the TagsAdmin group, if setup in the Administration module of
AVEVA Administration 1.5 (or later).

For a standard project, the following entities can be created and configured as required:

• Develop Conceptual Data Model

• User Defined Element Types (UDETs)

• User Defined Attributes (UDAs)

• Definition of Distributed attributes and their owners

• Status Definitions

• Database Views

• Datasheet templates

• Unit Sets

• Revision configurations

• Flexible Explorer Definitions

13
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

AVEVA Engineering Data Setup – AVEVA Engineering


Application

AVEVA Engineering application is essentially ready to be deployed after the conclusion of an initial data
model setup and configuration within the Admin and LEXICON/CONFIGURATION modules.

Within the AVEVA Engineering Tags application, certain configuration functions are required for the
configuration of the user environment and work space. These functions are made available only for an
administrative user, and include the configurations for:

• Database Views Editor

• Categories and Lists

• AutoNaming Setup

• Compare/Update

• Datasheets Configurations

• Database locations for engineering items


This activity is dependent on the project / user tasks requirements.

 Ideally a clean (new) project will be required in order to follow the demonstration described in the guide.
Although any existing project can be utilised as appropriate

14
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
CHAPTER 3

3 Standard Project Data Setup


Standard AVEVA Engineering project Setup is the minimum data model that is required to deliver the
functionalities in AVEVA Engineering Tags module. The Standard Project Setup is administered with the
Admin and LEXICON modules of the AVEVA Administration and Engineering products respectively and
it involves a number of procedures such as shown.

Standard Project Data Definition in Admin Module

As described earlier, setup of a data model definition for use in AVEVA Engineering application, involves a
number of steps.

One of the first steps is to create the required; Teams, Engineering Databases and MDBs. In this example
the creation of teams, databases and MDB’s will be demonstrated using this sample engineering structure
displayed below:

15
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the data model definition example above, an engineering item ‘Pump’ (with associated ‘Motor’) consists of
Mechanical, Electrical and Process attributes groups, whose data will be distributed across three (3)
separate engineering databases.

Using team access control, each discipline will have full control of their own data whilst working with data
issued from all the other disciplines. This is shown in the pictorial representation below.

 The Engineering World (ENGWLD) is a top–level administrative container for engineering elements with
‘non-distributed’ attributes data. The creation of the (ENGWLD) is discussed in Section 3.1.4.

 The Distributed attributes World (XPIWLD) is a top–level administrative container for distributed
attributes data. The creation of the XPIWLD is discussed in Section 3.1.4

3.1.1 Creating an Empty Project

The following example demonstration will use a newly created project. In order to start the worked
examples, the following steps should be conducted:

 Create a new project using the Project Creation Wizard 1.5.0, and complete the relevant fields
such as Project field enter ‘Training’ and Code enter ‘TRA’ using the details provided.

16
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Enter AVEVA Administration by selecting:

Start > All Programs > AVEVA >Manage > AVEVA Administration 1.5.0

Enter the following details:

Project – Training

Username – SYSTEM

Password – XXXXXX

Click the Admin tile.

 It is not necessary to specify an MDB to enter Admin. Free Users, like SYSTEM, are not displayed on
the Username pull down.
 Include the following databases shown below as ‘Foreign’ databases, from APS (AVEVA Plant
Sample Project) and ACP (AVEVA Catalogue project).

17
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Projects Databases

ACP-(AVEVA MASTER/EQUICATA (CATA)


Catalogue project)
MASTER/PIPECATA (CATA)

EQUIPMENT/CATA-A (CATA)
PIPING/CATA-A (CATA)
APS (AVEVA Plant ELECTRICAL/CATA-A (CATA)
Sample Project) SAMPLEPPROJCATA (CATA)
PPROJECT/CATA (CATA)
ELECTRICAL/DESIGN-AREA01-A (DESI)
EQUIPMENT/DESIGN-AREA01-A (DESI)
PIPING/DESIGN-AREA01-A (DESI)
PPROJECT/GROUP (DESI)
PIPING/SCHEMATICS-AREA01-A (SCHE)

 The trainer will provide APS (AVEVA Plant Sample Project). This project contains the schematic,
design and dictionary database required for the demonstration of data integration

 The trainer will provide ACP (AVEVA Catalogue project). This project contains all catalogue and
specifications items required for references

 The ‘Project creation’ and ‘Including Foreign databases’ options are discussed in full in the TM-1860
AVEVA Administration Fundamentals training guide

3.1.2 Create Discipline - A Worked Example

The first stage in developing a conceptual data model for use by AVEVA Engineering is to create
disciplines.

The ‘Discipline’ objects represent a “Discipline” as defined by the Engineering requirements for example;
Mechanical, Process and Electrical disciplines.

Create
Disciplines

The Admin default screen layout will be displayed comprising of the main pull down menus, the Admin
Explorer, Admin functions form and data from the included Foreign databases.

18
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

One of the options in the “Create Discipline” form is the “Project” button. This option provides the
capability to set the “DB Range Start” text field using existing pre-defined “DB Number Range” values.

This setup “DB Number Range” is not mandatory, however if the user(s) preferred to use the Project
button to set the “DB Range Start” text field in the Create Discipline form. The following steps should be
completed before creating Discipline items.

The “DB Number Range” is set via the Setting > DB Number Range form.

19
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Enter the desired “Database Number Range” using the data below.

Database Number Range – “From”: 60000


Database Number Range – “To”: 250000

In the Admin module, click Disciplines (ENGI) on the Administration Elements form element type selector
to display the “Discipline” elements form.

Click the Create button to display the Create Discipline form.

20
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the Create Discipline form, enter the following data:

Name: ELECTRICAL

 The “Name” text field is used to define “Element” Name and can be modified at any time before or
after a project, definition has been created.

Display Name: Electrical

 The “Display Name” text field is a descriptive text for the discipline and can be modified at any time
before or after a project, definition has been created.

Code (Required): ELEC

 The “Code” is an alphanumeric text field. The Code can be used within automatically generated
teams, databases and MDB names

 The “Code” must be unique for each discipline. Once an Inter-disciplinary project setup has been,
created the discipline code cannot be modified. The Code can be modified until it has been
referenced by a Project Definition

 The Code must not contain symbols, spaces, or slashes (/). When discipline code is used in team
names it must consist of alphabetic characters only

Description: Electrical

 The “Description” text field is the description of the discipline and can be modified at any time before
or after a project definition has been created

DB Range Start: Select the Project button to input the value from the pre-defined DB Number Range.

 The “DB Range Start” Numeric field is used to set the lowest database number that will be applied to
databases created for this discipline. The system finds the first unused DB number greater than or
equal to the given number for databases created for this discipline.

The DB Range Start- “Project” option/button is only enabled, if the “DB Number Range” is set via
the Setting > DB Number Range form.

21
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the OK button to create the “Discipline” object and close the form.

22
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Clicking the “Apply” button creates the Discipline and initialises the form ready to create another new
Discipline

 The “Cancel” button closes the form without creating the Discipline

 The Discipline elements can only be deleted if they have not been used in a Project Definition. Discipline
elements cannot be deleted at a satellite end of a globalised project

23
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 1(a) – Standard Project Data Definitions – [Define


Discipline]

Repeat the procedure as described in “Section 3.1.2” to create the following “Disciplines” using the
information in the table below:

Discipline Display Code Description DB Rang Start


Name
INSTRUMENT Instrument INST Instrument 60001
MECHANICAL Mechanical MECH Mechanical 60002
PIPING Piping PIPE Piping 60003
PROCESS Process PROC Process 60004

3.1.3 Create Teams and Users

The second and third stages in developing a conceptual data model for use by AVEVA Engineering is to
create teams and users.

Create the appropriate teams that allows the engineers for a particular discipline the right access to the
objects they are working on.

24
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Create Create Create


Disciplines Teams Users

In order to control who can


modify or update
engineering items (e.g.
Pump & Motor) attribute
data and distributed data,
the following “Teams”
elements are created in
the AVEVA Administration
module.

Create the desired Teams


and Users, using the data
below via the “Excel
Import” utility as shown.

Teams

25
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Users

User Password Description Team

AELECENG,CUADMIN,
ELEC.ENGINEER A Electrical Engineer (PWD ‘A’)
TAGSMASTER

MECH. A AMECHEN,CUADMIN,
Mechanical Engineer (PWD ‘A’)
ENGINEER TAGSMASTER

PROC. A APROCHENG,CUADMIN ,
Process Engineer (PWD ‘A’)
ENGINEER TAGSMATER

INST. AINSTENG,
A Instrument Engineer (PWD ‘A’)
ENGINEER CUADMIN,TAGSMATER

PIPE. APIPEENG,
A Piping Engineer (PWD ‘A’)
ENGINEER CUADMIN,TAGMASTER

Select Utilities > Import… from the main Admin menu.

A suitable file path with an appropriate extension can be typed into the text box or a user can browse
through to a suitable folder by clicking the icon next to the textbox.
26
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The trainer will provide the Excel file (TEAMS AND USERS .xlsx)

Click the icon and navigate to the folder containing the Excel file (TEAMS AND USERS). Select the file
called admin.xls. Click the Open button.

Then click on the OK button to initiate the import process.

The user will be prompted to choose an MDB in which to show the imported data.

 If the imported data contains UDA’s or UDET’s then the MDB selected should contain a Lexicon
Database.

27
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

For the purposes of the Training select < None> and click the OK button.

28
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click Dismiss to dismiss the form.

Click on the Admin Elements form and select Teams from the TYPE options list to view the newly created
Teams.

In order to complete the “Team” definition, assign the appropriate project users to the “Team Disciplines”.

29
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 This definition support the filtering of List definition by Discipline configuration in “AVEVA Engineering –
Tags” module as shown below.

In the Teams form, select “TAGSADMIN” and click on the Modify button to display the Modify Team form.

In the Modify Team form, click on the “Team Disciplines (ENGI)” Tab. Select and move the “Project
Disciplines” to the “Team Disciplines” section of the form.

30
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the Apply button to save the settings. Then select the Cancel button to close the form.

31
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on the Admin Elements form and select Users from the TYPE options list to view the newly created
Users.

32
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The Admin tab in “AVEVA Engineering-Tags” module is only displayed if the user is a member of the
TAGSADMIN team

 In order to create and edit configurations Compare/Update Configuration, User(s) (General User) must
be a member of team CUADMIN

 The ‘Teams’ creation and ‘Users’ definitions are discussed in full in the TM-1860 AVEVA Administration
Fundamentals training guide

Select one of the newly created “User” items, in this case “ELEC.ENGINEER” and click on the Modify
button to display the Modify User form.

33
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Complete the Alias textfield with preferred user name(s) or initials. This new field allows the
Administrators to supply an Alias (a different representation for the user name, which can be initials). This
Alias can be used in “Datasheet Revision Block” configurations.

34
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In this example, enter: Gregory.O

Click the Apply button to save the settings. Then select the Cancel button to close the form.

35
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 1(b) – Standard Project Data Definitions – [Teams &


Users]

Complete the “Alias” text fields for the following Users, using the information in the table below:

User Alias text field

INST.ENGINEER John.B

MECH.ENGINEER Gustavo.C

PIPE.ENGINEER Bryn.T

PROC.ENGINEER Kenneth.I

3.1.4 Create Databases and MDBs

36
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The fourth stage in developing a conceptual data model for use by AVEVA Engineering is to create the
required databases such as:

 Engineering Database
 Conceptual Database  Dictionary Database

Create Create Create Create Create


Disciplines Teams Users DBs MDBs

On the Admin, elements form select Databases & Extracts from the TYPE list.

 Select the Create button to create the following databases, (Engineering, Conceptual and
Dictionary) as shown:

37
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

[1] Create “Master Engineering Database” - Storage for engineering tag items attributes data

Click the Master DB radio button and the OK button on the subsequent Database & Extracts form to
display the Create Database form:

38
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select <Team TAGSMASTER> < from the Owning Team Name column.

Enter or select the following data:

Name: TAGSMASTER

Description: (Tagnames-ENGWLD)

Database Type: Engineering

Element Type : Engineering Data World

Create ENGWLD: Engineering-Data-World

Click the Apply button to create the database.

 Engineering World (ENGWLD) is a top–level administrative container for engineering elements with ‘non
distributed’ attributes data as shown in the pictorial representation below.

39
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

[2] Create “Mechanical Engineering Database” - Storage for distributed mechanical attributes data

 Select the Databases & Extracts from the Elements options list. Click the Create button to display
the Databases & Extracts form.

 Click the Master DB radio button and then after click the OK button to display the Create Database
form

 Select <Team> AMECHENG from the Owning Team grid Name column

Enter or select the following data:

Name: ENGIMECH-ATTDATA

Description: (Distributed Mechanical Attribute Data)

Database Type: Engineering

Element Type: Extended Properties World

Create XPIWLD: MechAttData

Click the Apply button to create the database.

40
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Distributed attributes World (XPIWLD) is a top–level


administrative container for distributed attribute
data as shown in the pictorial representation
Exerc ise 1 (c) – Standard Project Data
Definitions – [Define Database]

Repeat the same procedure as described above to


create Engineering database for Distributed Attributes
Data, using the information in the table below:

 Process & Piping Engineering Database - Storage for distributed Process & Piping attributes data
 Instrument Engineering Database - Storage for distributed Instrument attributes data
 Electrical Engineering Database - Storage for distributed Electrical attributes data

Owning Name Description Database Element Type Create


Team Type XPIWLD
APROCENG ENGIPROC- Distributed Process & Engineering Extended ProcAttData
ATTDATA Piping Attribute Data Properties World

AINSTENG ENGIINST- Distributed Instrument Engineering Extended InstAttData


ATTDATA Attribute Data Properties World

AELECENG ENGIELEC- Distributed Electrical Engineering Extended ElecAttData


ATTDATA Attribute Data Properties World

41
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

42
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Create

[3] “Dictionary Database”

Create a new Dictionary (DICT) database owned by the team ‘TAGSADMIN’. This holds “User Defined
Attributes” (UDA) and “User Defined Element Types” (UDET) definitions.

Using the information below:

Enter or select the following data:

Name: ENGDICT-B

Description: Project Engineering Dictionary

Database Type: Dictionary

Element Type: User defined attribute World

Create UWRL: unset

Click the Apply button to create the database.

43
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Create

[4] “Conceptual Database”

Create a new ConceptualModel database, owned by the team ‘TAGSADMIN’. This holds the data model
definitions.

Enter or select the following data:

Name: ENGICONCEP

Description: Engineering Conceptual Database

Database Type: ConceptualModel

Element Type: unset

Create UWRL: unset

Click the Apply button to create the database.

44
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Create

[4] “Design Reference Database”

Create a new Design Reference Database, owned by the team ‘TAGSADMIN’. This holds the
information about Systems and Compare/Update data links.

Enter or select the following data:

Name: ENGIREFDATA

Description: CompareUpdate Links and System


Data

Database Type: Design

Element Type: SITE

Create SITE : unset

Select the “Reference Only” checkbox as shown


below:

Click the Apply button to create the database.

45
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exerc ise 1 (d) – Standard Project Data Definitions – [Define


MDB]

[5] Create “Multiple Database” [MDB]

 To control what data a user can see and work with; databases are grouped into Multiple Databases
(MDBs). A project will contain at least one MDB. A database may be a member of any number of MDBs

 On the Admin Elements form, select MDBs from the TYPE list and click the Create… button to
display the Create Multiple Database form.

 Enter the following data:

Name : A-Tags
Description: A-Tags

 Select all the Databases from the Project Databases list, using the right click “Select All DBs”
option.

Click the “down arrow” button to move the databases to the Current Databases list. Click the Apply button
on the Create Multiple Database form. Select Cancel button to close the form.

46
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Log into AVEVA Engineering Tags Module using the details listed below; to view the newly created
Engineering Data World (ENGWLD) and Distributed World (XPIWLD) in AVEVA Engineering-Tags
database Explorer:

Project – Training

Username – SYSTEM

Password – XXXXXX

MDB -----A-Tags

Click the Tags tile.


47
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exit AVEVA Enginering –Tags module.

 A pictorial representation of
Engineering [ENGWLD] and
Distributed attributes data World
(XPIWLD] top–level administrative
container in a project MDB

48
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
CHAPTER 4

4 Developing a Data Model in AVEVA Lexicon/Configuration


As previously mentioned in chapter 2, the project data setup for AVEVA Engineering data model
implementation involves 3 modules (i.e. Admin and Lexicon/Configuration) of AVEVA Administration
and AVEVA Engineering.

• AVEVA Admin module - For Database, Teams, Users and MDBs setups
• AVEVA Lexicon/Configuration module - For data model setup
• AVEVA Engineering – For engineering tags items creation and administration
This chapter will extensively cover all the relevant steps required for structuring an engineering conceptual
data model in AVEVA Engineering™; to manage Engineering tag information used in key project
deliverables such as Line List and Equipment index

The supplied worked examples are intended to show the new flexible data model configuration, capability
and usage in AVEVA Engineering™. It is NOT intended to be representative of any actual project, which is
likely to be larger, more representative and complete.

Developing a Data Model in Lexicon/Configuration


Module

Developing a data model in AVEVA Lexicon/Configurations module, which is required to deliver the
functionalities in AVEVA Engineering, a number of actions must first be considered for example:

• Types of engineering tag items to create and manage

• Types of attributes that are required

• How attributes will be divided up to enable different disciplines to modify data on the item
concurrently
These could be structured as engineering objects owning their generic attributes, and owning distributed
attributes, which are collected within disciplines as shown.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

45
The new Data Modelling tool in AVEVA Engineering™ provides the capability to develop a conceptual
engineering data model, which can then be automatically compiled into Dabacon schema for use by AVEVA
Engineering

Developing a conceptual data model in AVEVA Lexicon/Configuration for AVEVA Engineering™ use,
can be achieved via the following methods:

 Importing existing model; that is creating a model based on imported external files such as ISM
file from AVEVA Information Standards Manager (ISM) technology using the Import Model option.

 Developing a data model from Scratch; using the base model option, which includes database
(Dabacon) definitions such as units of measure, measure classes and disciplines

Developing a Data Model from Scratch

Developing an engineering conceptual data model in AVEVA Lexicon/Configuration module from scratch
which delivers the functionalities in AVEVA Engineering™ involves a number of steps as shown:

50
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Administration setup steps must first be completed before implementing the above steps.

The following demonstration will be conducted on the new project created previously.

Enter AVEVA Admin – Lexicon Module with following details:

Project – Training

Username – SYSTEM

Password – XXXXXX

MDB ----- Lexicon

Click the Lexicon tile

The Lexicon module is then displayed as shown:

51
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

4.2.1 Create BaseModel with Dabacon Definitions

The first stage in developing a conceptual data model for use by AVEVA Engineering is to create a base
model with some preset Dabacon definitions such as units of measure, measure classes and disciplines.

Select the “Data Model” tab from the main menu to display the
“Welcome to DATA MODEL” window.

Select the “Base Model” option, to create the base model with some preset Dabacon definitions.

52
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Once the “BaseModel” definitions is completed, click the “Close” button on the “Applying Base Model
Definitions” form to close the progress dialog. Empty Conceptual Model window is then displayed.

53
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the “Grid” view option from the “Data Model” context menu. Click on the Conceptual Model option
from the available options list to view the present Dabacon definitions.

From the displayed “Conceptual Model Grid”, select the “Measure Class” tab to view the newly created
Base Model Measure Classes from Dabacon definitions.

54
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the “Disciplines” tab to view the “Disciplines” items populated from Dabacon definitions, which was
previously created in section 3.1.2 [Admin Module] as illustrated below.

55
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The Discipline items are


defined in Admin Module. This
is discussed in section 3.1.2

56
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Finally close the “Conceptual Model Grid” window, by clicking on the close option as highlighted.

4.2.2 Create Engineering Class

The second stage in developing a conceptual data model for use by AVEVA Engineering is to create
desired
“Engineering Classes”.

An “Engineering Class” in this context represents objects logically grouped according to their description or
type, functional locations or referenced functional locations as illustrated in the example shown below:

57
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The following worked example demonstrates how to create an “Engineering Class” in AVEVA
Lexicon/Configuration module .This will be conducted using the pictorial representation shown.

Select the “Diagram” option from the “Data Model” context menu. Click on the Conceptual Model option
from the available options list to display an empty Conceptual Model window.

58
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Create a new class object in the diagram view, by selecting the “New Object” option from the “Diagram”
group.

59
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Alternatively, right click anywhere on the diagram canvas, select “New Object” from the available right click
menu.

 The automatic refresh of newly created classes can disabled by clicking on the “Automatic Refresh”
option in the canvas, if preferred.

Define the newly created class “Name” by clicking on the class and enter a name. In this example enter
“Physical Category” and press the “Enter” key.

60
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Alternatively, the class name can also be defined via the “Properties” window. Select “Properties” option
from the “Data Model” context menu to display the “Properties” window.

Repeat the same procedure as described above to create a new engineering class “Equipment” as shown:

61
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

After creating the Engineering Classes, define the relationship between the engineering classes by
connecting the class expanders [nodes]. The expanders can be draged and dropped from one class onto
another to create new relationships.

In this example drag the left expander of “Equipment” class [child class] and drop it on right expander of
“Physical Category” class [Parent class] as shown:

62
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 User(s) can switch the layout to desired layout using the “Switch Layout” option from the Data Model>
Diagram group

 Class relationships can be deleted if required by clicking on the relationship line in the diagram view as
shown:

 Engineering classes can be deleted if required by clicking on a class in the diagram view and selecting
“Delete Object” from the right-click menu.

63
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

64
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 2 – Create Engineering Class

Repeat the same procedure as described in the previous page to create the following engineering classes and
define the class relationships as shown in the diagram.

65
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

4.2.3 Create Engineering Class Attributes

The third stage in developing a conceptual data model for use by AVEVA Engineering is to create “Engineering
Class Attributes”.

Engineering class attributes can be created, viewed or edited via the “Attributes” part of the “Properties Classes”
window.

Select an engineering class in the diagram view, in this case “Physical Category” class. Click the edit “Pen” icon
on the “Attributes” part of the “Properties Classes” window.

66
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Click the “Add a new item” icon option from the available
menu.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Existing attributes can be added to an existing engineering


class by selecting “Add an existing item” icon

Enter a preferred name, in this case “Area Classification” in the available text field and press the “”ENTER” key.

Select the appropriate attribute type (data type) from the available option list for the new attribute. In this
example, select “String”.

Enter a preferred “Default value” if required. In the example, leave the text field unset.

Attributes can be removed from a class if required, via the “Attributes” part of the “Properties Classes” window.
Click the edit “Pen” icon on the “Attributes” part of the “Properties Classes” window.

67
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the preferred attribute checkbox and click on the icon to remove the selected item from the attribute
list. The removed item [Attribute] will still exist and can be viewed via the Attribute tab on the conceptual
“Grid” View if required.

When relationships are created in the diagram between engineering classes items a parent and child
relationship is formed. This means that the attributes and associations are inherited from the parent class
to the child .
These are then grouped into the inherited part of the “Properties” pane for the class in the attribute and
associations sections as shown:

68
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

T he “Conceptual Grid” window can also be used to view, create and edit classes and attributes if preferred.

Select the Grid >Conceptual Model to display the Conceptual Model grid and select the “Object Properties”
tab.

 The “Object Properties” shows the properties of the item that is selected (and any items that are highlighted
through shift-click/right click highlight options) in the Diagram.

 The “Area Classification” property (Attribute) is displayed for the selected class (e.g. Physical Category)
The Conceptual Model grid tab is displayed in a separate “Vertical Tab Group” by default. The grid tab can
also be moved to existing “Tab Group” as illustrated below:

 Right-click on the Conceptual Model grid tab and select “Move to Previous Tab Group” option, to move
the Conceptual Model grid tab to the Conceptual Model tab group.

69
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Alternatively, the “Conceptual Model” grid tab can also be viewed in a “Horizontal Tab Group” as illustrated.

Right-click on the Conceptual Model grid tab and select “New Horizontal Tab Group” option , to create a new
horizontal tab group.

The “New Horizontal Tab Group” is then displayed.

70
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Engineering classes properties that are highlighted through right click menu options in the Engineering Class;
can be viewed/edited via the “Object Properties” form.

In this case click on the “Physical Category” class, and then select the Highlight Descendants option.

71
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 To remove the class “Highlight”, click on the class of interest.


A new property can be added to any class via the “Object Properties” grid by right clicking anywhere in the grid
and select New Object to add Attribute or Association to a class.

72
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

On the Add New Property form, complete the preferred fields, in this example, set the attribute fields below using
the data in the table.

Engineering Class Name Discipline Data Type


Physical Category Area Number Leave unset String

Click on the OK button to update the “Object Properties” grid.

73
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The newly created attribute can also be viewed / edited, if preferred, via the “Attribute” tab as shown below.

Attributes with Lists of Values definitions can be created in the Conceptual Model and then built into the
Dabacon model.

The following example illustrates how to define attributes with “Lists of Values” definitions in the Conceptual
Model.

On the “Conceptual Grid” window, select the “Lists of Values” tab.

74
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Right-click anywhere in the grid and select New Object to add a new row.

Complete the fields, in this example, update the attribute fields below using the data in the table.

75
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Display Name: Area Number LOV

On the “Lists of Values Properties” window, create the items for the selected “Lists of Values” item (Area
Number LOV).

 Click the edit “Pen” icon on the “Item -Lists of Values Properties” part of the “Properties” window

 Click the “Add a new item” icon option from the available menu

76
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Enter a preferred item, in this case “101” in the available textfield and hit the “Enter” key.

77
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Repeat the same procedure as described above, to add the following items shown below to “ Lists of
Values” items (Area Number LOV).

Finally assign the Lists of Values” item (Area Number LOV) to the desired attributes, in this case “ Area
Number” as shown.

 Click the edit “Pen” icon on the “Attribute -Lists of Values Properties” part of the “Properties” window

 Click the “Add an existing item” icon option from the available menu, and select the “Area Number”
attribute from the available pull-down list

78
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Alternatively, Attributes Properties have a property called “Valid Values” from which the user can also select
from the Lists of Values they have set up. This list is populated only if the attribute is of Data Type
“string”.

79
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 List of Values definitions that does not have


assigned attributes will be built as “UDLOV”
when the Conceptual Model is instantiated.

 Setting the Mandatory checkbox, forces the


Default Value to be chosen from one of the
items in the selected list.

 On build, attributes with a Valid Values list


selected will create UDAs that have UVALIDs
underneath for each item in the list. Each List of
Values that was defined will also create a
UDLOV in the database.

The newly created List of Values items can also be viewed on the “Lists of Values” grid as shown below.

80
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exerc ise 3 – Create Engineering Class Attributes

Repeat the same procedure as described in the previous page to create “Engineering Attributes” for the listed
classes using the data in the table below:

Engineering Class Attributes Data Type

Physical Category Prefix String


Train String
Equipment Design Pressure Pressure
Design Temperature Temperature
Dry Weight Mass
Nozzle Bore Size Bore

81
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

4.2.4 Create Engineering Class Associations

The fourth stage in developing a conceptual data model for use by AVEVA Engineering is to create “Engineering
Class Associations”.

82
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Associations functionality helps to create relationships between classes. Once created the association is then
available as an existing association to be added to the classes.

For example, the Pump e.g. Centrifugal Pump are made up of numerous component parts e.g. Nozzles, Casing
Shaft and many others as shown in the diagram.

These parts can be represented in the data model by creating an association relationship between the classes,
for example using the “hasPart” association. This is demonstrated in the following worked example.

 The Association name is a user definable field, which means user[s] can name the Association object any
preferred name.

Create an association object in this case “hasPart” association.

To do this:

83
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Select an “Engineering Class” in the diagram view in this case “Equipment”. Click the edit “Pen” icon on
the “Class Associations” part of the “Properties Classes” window

 Click the “Add a new association” icon option from the available menu to display the association
text field

 Enter a name, in this case “hasPart” in the available text field. Then press the “Enter” key

 Enter a specific association name in this case “Nozzle” in the available text field. This is not mandatory;
the association name is used as default value if the textfield is left unset

 The association name is used as default


value if the text
field is left unset

84
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In this example, leave the Select a discipline text field unset. This textfield should only be completed if the
association is on a discipline specific attribute

 For example, a Process Line may have an attribute e.g.


“FROM” / “TO” which could be referencing an
Equipment class. In the data model, an association
“IS A PART OF” can represent this; with this type of
association, the
“Discipline” text field must be set with a preferred
discipline value in order to correctly define the
“Reference attribute” and the “Referenced Types” in
Dabacon when the model is instantiated.

 Leave the “Enter an integer or*” text field unset. This is the Cardinality textfield, which sets the UDA
length for a Reference attribute when the model is built

85
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Allow to be a Pseudo: This is where the user can set that the UDA that will be built from this
Class Association will be a Pseudo.

 Defining “Association Cardinality / Discipline” at this level,


overrides the Cardinality and Discipline that was set on the
main associations properties pane (which in the above case
was “hasPart”) from the Grid > Conceptual > Associations
Properties pane

86
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Then add the appropriate component part to the newly created association by selecting one of the
plus icons. Click on the icon to add existing class to the range. In this example, select “Nozzle ”

class.  Then click the edit “Pen” icon on the “Class Associations” part of the “Properties Classes”
window to leave the edit mode as shown

 In this example, the Equipment class now has


Part “Nozzle”. The classes that are children of
the Equipment will inherit the association, that
is Pump, Dynamic Pump and Centrifugal Pump

 An “Engineering Class” can also have a local


Class association.

Finally set how the association will be defined in Dabacon when the model is built, following the steps below:

87
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Select the “Association” tab on the “Conceptual Model” grid window to display the
“Associations” grid,

 Select the preferred “Association Name” in this case “hasPart” and view its properties via the
“Associations” part of the “Properties” window. In this example select “Use for hierarchy”, to specify
that Owners > Members definition will be created in Dabacon when the model is built

88
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Associations are directional when used for hierarchy. In this example the hasPart association on
Equipment class is pointing to a Nozzle which will mean the Pump will be allowed to have a Member
Nozzle as shown:

Pump UDET has:

 Owner Types - ENGRP, ENGITE


 Member Types - :Nozzle

 Associations that are not used for hierarchy become reference attributes, which means the attribute points to
another item[Class]

Cardinality text field: Leave Unset

 This functionality can only be used on reference associations and is not used for the hierarchy. The
reference UDA that is created has a UDA length set to the value in cardinality if there is one. If no
cardinality is set on the association then the UDA length for the referenced UDA created is 1

Discipline text field: Leave Unset

 Select a discipline for the association from the populated Discipline drop down list, if required.

Inverse Relationship field: Leave Unset

 This functionality is associated with AVEVA NET and Tags Management System [TMS].
89
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Inverse Pairing field: Leave Unset

 This functionality is associated with AVEVA NET. At the present time, these associations have no effect on
the model that is built in Dabacon

Hold multiple Case values: Leave Unset

 This option allows the attribute to have case data. If the option is checked, the resulting reference
attribute in AVEVA Engineering™, which is used for these associations, will have cases. In Dabacon
terms, the Ucases for the UDA that is created will be true.

Synchronise across Linked objects: Leave Unset

 The value in this attribute will be synchronised with the other linked objects. If the option is checked, the
resulting attribute in AVEVA Engineering™, will be synchronized if the element has clone(s). In
Dabacon terms, the Uclone for the UDA that is created will be true.

Exerc ise 4 – Create Engineering Class Associations

Create a class association to show that Engineering class [Nozzle] is a member of an Equipment class as shown
below:

90
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In this exercise, the Nozzle class has an association “Is a Member Of” to Equipment class. The
Association should be defined as “Not used for hierarchy”, which means the association will be built in Dabacon
as a Reference Attribute.

Reference Attribute Name: :IsaMemberOf

 On Element Types -:Nozzle


 Allowed Reference Types - :Equipment :Pump :Dynamic :Centrifugal

91
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

4.2.5 Assign Discipline to Engineering Class Attributes

The fifth stage in developing a conceptual data model for use by AVEVA Engineering is to assign discipline to
Engineering Attributes.

The Discipline functionality is used for the distributed attributes set up. Setting a discipline on an attribute
causes the appropriate distributed attribute set up for both the attribute and any classes it is used on, when
built in Dabacon.

For example, the diagram shown is a simple data model definition of a pump and motor where three different
engineering disciplines all contribute to the overall definition of the pump.

The following example demonstrates how to assign discipline to “Engineering Attributes” in the Conceptual Data
Model.

92
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the preferred “Engineering


C lass ” in the diagramview. In this,
case “Equipment ” class.

From the “Attributes” part of the “Properties Classes” window, select the desired attribute. In this example,
select “Design pressure” to display the “Attribute Properties” part of the “Properties window

Select the appropriate discipline e.g. “Process” from the available “Discipline” option list.

93
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Hold multiple Case values : Leave Unset

 This option allows the attribute to have case data. If the option is checked, the resulting attribute in AVEVA
Engineering™, will have cases. In Dabacon terms, the Ucases for the UDA that is created will be true

Synchronise across Linked objects: Leave Unset

 The value in this attribute will be synchronised with the other linked objects. If the option is checked, the
resulting attribute in AVEVA Engineering™, will be synchronized if the element has clone(s). In
Dabacon terms the Uclone for the UDA that is created will be true

Store a Tag Name: Leave Unset

 Used by the TMS Name rule

Alternatively, the discipline field can also be edited via the “Attribute” tab. (Grid >Conceptual
Model>Attribute).

94
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exerc ise 5 – Assign Discipline to Engineering Class Attributes

Repeat the procedure described in the previous page to assign disciplines [e.g. Mechanical & Process] to the
following “Engineering Class Attributes” using the data in the table below:

Engineering Class Attributes Discipline


Equipment Design Temperature Process
Mechanical
Dry Weight

95
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

4.2.6 Build the Model

The final stage in developing a Conceptual Data Model for use by AVEVA Engineering is to build the data model.

96
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “Build Model” functionality provides the capability to compile the conceptual data model into Dabacon schema
for use by AVEVA Engineering.

The “Inactive in Build/Active in Build” functionality is a toggle button, which shows whether an object i.e.
“Class/Attributes” will be instantiated when the build is performed.

In this example set the following “Engineering Classes” to “Inactive in Build”.

Engineering Class Build Option


Physical Category Inactive in Build
Component Part Inactive in Build

Select the “Build Model” option from the “Data Model” main menu to instantiate the Conceptual Data Model in
Dabacon.

97
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on the “Yes” button to continue.

 Begins the build process, UDETs and UDAs that have been manually mapped will not be updated during
the build process. These UDETs and UDAs remain unchanged and will not become controlled by Data
Model.

 Any manual edits to the UDETs and UDAs created during the build process are outside the control of
Data Model and are done at the user’s risk. Edits to these UDETs and UDAs may cause the conceptual model
to be inaccurate and any subsequent build may undo the changes.

If successfully completed, close the progress dialog, otherwise review the error message and re-build if required.

98
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

View the instantiated data such as UDETS, UDAs, DSXWLD, and ENGCWL in Dabacon via the Dictionary Explorer
in Lexicon module as shown:

 There isno automatic


synchronization of data btw the
conceptual model database and
dictionary database. The dataflow is in
one direction [ i.e.
Conceptual model
database > Dictionary database ]

 Any modificationof data [ UDETs or


UDAs] should be done via the Conceptual
model and the dictionary database can be
updated by re -building the conceptual
model

The “DSXWLD - Default home Destination” object is created automatically by the build operation with a default
name as shown below.

99
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

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.

The DSXDST contains an ID expression that evaluates the name or ID of the default home to be used (i.e. the
name used to define the (XPIWLD) in AVEVA Engineering- Tags Database Explorer) as highlighted below.

In this example, rename the default home destination object name to ( ID /ProcAttData )

100
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Home Location is a mandatory field. The expression


typed in this field must bethe same as the XPIWLD name in
AVEVA Tags database Explorer, if the XPIWLD alr eady
exists or vice -visa i.e. any new XPIWLD created must have
the same name as the Home location expres sion value
highlighted in the example below.

 Repeat the procedure to rename the all the Default


Home Destination Definition (DSXDST).

 Do a Savework operation

Typical examples of instantiated Dabacon definitions via the Dictionary Explorer in Lexicon:

 Engineering element UDETs

AVEVA Engineering uses existing UDET mechanisms. The UDETs intended for use as an Engineering
element are based on the ENGITE element type and UDETs intended for use as a distributed attributes
group are based on the XPITEM element type.

101
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 User Defined Attributes UDA

UDAs represent the


attributes on
mechanical
equipment

102
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 DSXWLD [Distributed Attribute Definition]

The distributed Schema definition helps to bind the distributed attribute data (XPITEM) to the ENGITE. In
this example, Process attribute data and Piping attribute data distributed UDET are bound to the
engineering item (Line ENGITEM).

103
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

- DSXWLD Distributed Attribute

- Distributed Attribute Group


DSXGRP

Distributed Attribute Schema


- DSXSCH

Distributed Attribute Owner


- DSXOWN

DSXMBR Distributed Attribute Member

The member UDET type

The member UDET type

Export and Import Conceptual Data Model

The Conceptual Data Model “Export” and “Import” tool supports the import and export of data model files to and
from the “Conceptual Model”.

104
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This tool is designed to support activities such as:

 Import external files such as an ISM file from AVEVA Information Standards Manager (ISM)
technology.

 The round tripping of Conceptual Data Model “Turtle” files (.ttl) files in and out of the Conceptual Model
database

 The “Turtle” files (.ttl) files are aW3 RDF standard

The conceptual model can be exported and re-imported using the Data model “Export” and “Import” options.

The following example demonstrates how to use the Data Model “Export” and “Import” tool.

4.3.1 Export Conceptual Data Model

The Export > Conceptual Model option is a tool used when exporting Conceptual data model from Conceptual
Model database to an xml (.ttl) output files.

Select the Export > Conceptual Model option from the “Data Model” main menu.

105
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Use the window to navigate to the location, name the file and select the format [Turtle files (.ttl)] in which to export
the model.

Select Save button to save the file to the preferred location as shown below.

4.3.2 Import Conceptual Data Model – A Worked Example

106
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Data model “Import” tool provides the capability to Import external files such as ISM file from AVEVA
Information Standards Manager (ISM) technology and round tripping of Conceptual data model “Turtle” files
(.ttl) files in and out of the Conceptual Model database.

In this example, before conducting the Import operation, clear the existing Conceptual data model using the Clear
model option as illustrated below:

 Select the Conceptual Model, edit Pen icon to display the Model “Properties” window

 Click the Clear Model button to remove all the data from the selected the Conceptual Data Model, to display
the Clear Model dialog.

107
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In the example “Keep Base Model Definitions” checkbox option should be kept. Select the “Clear Built
Definition (Cannot be Undone)” checkbox to clear the instantiated data such as UDETS, UDAs, in Dabacon
(Dictionary Database).

 Keep Base Model Definition checkbox option will leave the definition added at the start of this
chapter e.g.
Measure Classes, and Disciplines.

Select the Yes button on the “Clear Model” dialog to confirm the delete operation. If successfully
completed, close the progress dialog, otherwise review the error message and re-clear the model if
required.

108
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The “Conceptual Model” is then removed together with the instantiated UDETs and UDAs. An Empty
Conceptual Model window is then displayed

In the example, separately delete the remaining the instantiated data such as DSXWLD, ENGCWL in Dabacon
(Dictionary Database).

109
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Instantiated data such as UDETS, UDAs, DSXWLD, ENGCWL and UNST in Dabacon (Dictionary Database), can
be updated by re-building modified existing Conceptual data model if required.

Now to conduct the import operation, select the Import > Conceptual Model option from the “Data Model” main
menu and use the Conceptual Model functionality to create a new model.

Use the Files to import into Conceptual Model window to navigate and then select the external file (model)
to import. Select the import file “TRAINING DATA-MODEL.ttl” and then click the Open button.

110
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The import file “ TRAINING DATA-MODEL.ttl” will be provided by the Trainer


 A number of industry standard semantic web formats are supported. In this case select Turtle files (.ttl)

The “Importing and Processing Selected Files” window displays the progress of the import; by default, the “Show
Details” pane is collapsed.

 If successfully completed, close the progress dialog, otherwise review the error message and re-import
the model if required.

111
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Conceptual Model window is then displayed with the imported Conceptual Data Model.

 After the import operation do a Savework.

Once the imported data is built, the Conceptual model mechanism automatically maps Conceptual Classes to
newly implemented Dabacon types (UDETs).

However, if the user desires to use system defined element types such as SYSGRP, SPECIFICATION in the
Conceptual Model. The preferred Dabacon element types should be manually mapped to the appropriate
Conceptual Model Classes as illustrated below:

Select the “Mappings” option from the “Data Model” ribbon to display the “Mappings” window.
112
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the “Edit” button on the Mapping window.

113
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the Classes (default) option from the “Mapping Context” pull-down option and then select the
“Conceptual Model” (default) option from the left-side panel pull-down option and “Database Definitions”
option from the right -side panel pull-down option as highlighted.

114
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Search for the preferred “Conceptual Model Class” in this case “Catalogue Spec” and then select the displayed
class.

Search for the preferred “Database Definitions” type in this example “Specification” and then select the
displayed class.

115
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Then double -click or drag item across to add them to the Current Mappings.

Once the Conceptual Model classes have been manually mapped to the preferred Dabacon Database
element types definitions. The user can then create appropriate “Class Association” for the Conceptual
Class, in this example “Catalogue Spec” as shown below.

116
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exerc ise 6 – Import and Build Conceptual Data Model

1. Set the following Engineering Classes in the Conceptual Model to “Inactive in Build”,

Engineering Class Build Option


Catalogue Inactive in Build
Component Part Inactive in Build
Fixed Inactive in Build
Inline Inactive in Build
Location Inactive in Build
Area Inactive in Build
Plant System Inactive in Build
Unit Inactive in Build
Root Functional Class Inactive in Build
Dynamic Inactive in Build
Positive Displacement Inactive in Build

2. Engineering Attributes can also be set to “Inactive in Build”, if they are not required. In this exercise set the
following engineering class attributes to “Inactive in Build”,

Attributes Engineering Class Build Option


PIPING SPECIFICATION Catalogue Spec Inactive in Build
SYSTEM NAME Plant System Inactive in Build

117
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

3. Enable the “Used for Hierarchy” option for “HAS PART” Association item.

4. Repeat the same procedure as described above [Section 4.3.2] to map “Plant System” Conceptual Class to
Dabacon Database definition type “SYSGRP” as shown.

118
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

5. Build the Conceptual Data Model and view the instantiated data such as UDETS, UDAs, DSXWLD, ENGCWL
and UNTSTW in Dabacon via the Dictionary Explorer in Lexicon module as shown:

119
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Repeat the procedure shown in page 86 to rename the all the Default Home Destination Definition (DSXDST).

 The build operation is completed with warnings as shown below, due to manual mapping of the SYSGRP
and SPECIFICATION element types.

 After the import operation do a Savework and exit Lexicon Module.

120
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
CHAPTER 5

5 Status Definitions
A Status definition is the implementation and structuring of the Status Control mechanism.

Status Control is the ability to control and report on the


defined status of model objects as they progress through
their lifecycles. It can be applied to any model objects,
like tagged schematic/ 3D and engineering items,
catalogue components, drawings etc.

A status definition is an administrative task carried out


within the LEXICON and CONFIGURATION module, and
could be project dependent.

A definition incorporates the use of a hierarchy of Status


World, Status Definition and Status Value elements.
This section describes how to create, assign and utilise
status definitions in an engineering project.

Create Status Configuration World Element


(STAWLD) – A Worked Example

Status world (STAWLD) can be created in Lexicon module and Configuration module. In this chapter, Status
world is created in Configuration module.

The following examples demonstration will be conducted in CONFIGURATION on a new project previously
created above.

Enter AVEVA Engineering – Configuration Module


with following details:

Project – Training

Username – SYSTEM

Password – XXXXXX

MDB -----A-Tags

Click the Configuration tile


AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

103
The Configuration module is then displayed as shown:

In Workflow tab, select the workflow Explorer and then select the topmost element in the Workflow explorer
(Statuses and Revisions World), click the ‘New’ entry on the menu bar, or right click to display the context
menu and click the ‘New’ > Status Configuration World entry, to create a Status Configuration world.

A New form is then displayed. Rename the “Display Name” to “ENGINEERING-STATUS” and click OK as
shown.

122
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Within the Current Element Editor, fill in the attribute details of the created STAWLD as shown.

Name: ENGINEERING-STATUS
Description: Status control world for Engineering

5.1.1 Create Status Definition Element (STADEF)

Select the created Status configuration world STAWLD, display the context menu and click ‘New’ > ‘Status
Definition’ to create Status Definition.

A New form will appear, change the name to “ENGR-STATUS-DEFINITION”, and click ok as shown.

123
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Within the Current Element Editor, fill in the attribute details for the created STADEF as shown.

Name: ENGR-STATUS-DEFINITION
Description: Status definition for Engineering items

Controllable element types: Types of elements (including UDETs; Engineering items (ENGITE) and
Distributed elements (XPITEM).) on which the Status control mechanism will apply to within this Status
definition.

Click on the browse button in the Controllable element types field to add the desired element types via the
Select element types form as shown.

124
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Name

:Centrifugal
:CentrifugalELEC
:CentrifugalMECH
:CentrifugalPROC
:Equipment
:EquipmentELEC
:EquipmentMECH
:EquipmentPROC
:Instrument
:InstrumentINST
:InstrumentLoop
:InstrumentLoopINST
:Nozzle
:NozzlePROC
:ProcessLine
:ProcessLinePIPE
:ProcessLinePROC
:Reciprocating
:ReciprocatingELEC
:ReciprocatingMECH
:ReciprocatingPROC
:Tanks
:TanksELEC
:TanksMECH
:TanksPROC
:Valve
:ValvePROC

125
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

5.1.2 Create Status Value Element (STAVAL)

Select the created Status definition STADEF, display the context menu and click ‘New’ > ‘Status Value’ to
create Status Value.

A New form will appear and change the name to “IDENTIFIED”, and click ok as shown.

Within the Current Element Editor, fill in the attribute details for the created STAVAL as shown.

Description: Identified

126
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Each Status value represents a possible status transition level.

Select the created Status definition STADEF, display the


context menu and click ‘Graphical View’ to display the
graphical view representation of the status values.

 The nodes represent the state of individual item


objects; the links (arrows) represents transitions
between states of the individual item as they
progress through their lifecycle. The arrow direction
indicates the direction of the allowed transition. The
source state is the initial state of the individual item
and the target state is the final state of the
individual item.

Select the created Status definition STADEF, display the context menu and click ‘New’ > ‘Status Value’ to
create further Status Values.

Within the Current Element Editor, fill in the attribute details of the created STAVAL as shown.

Name: WORKING
Description: Working
Valid Transitions: IDENTIFIED
Demote: IDENTIFIED

The status level is defined so that status level “IDENTIFIED” transitions to the “WORKING” status value after
a promotion. This is configured by setting the “IDENTIFIED” status value Promotion field to “WORKING”

127
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

status value as shown.

Navigate to the “WORKING” status value, and add “IDENTIFIED” status value to the “Valid transition” text
field. Then set the “Demote” text field to “IDENTIFIED” status value.

 The transitions are colour coded. A green transition indicates a promote state transition, a red transition
indicates a demote state transition. Black transitions are valid state transitions that have not been
marked as either promote or demote.

Select the created Status definition STADEF, display the context menu and click ‘New’ > ‘Status Value’ to
create further Status Values.

Within the Current Element Editor, fill in the attribute details of the created STAVAL as shown.

128
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Name: PENDING-APPROVAL
Description: Pending Approval
Reason Values: Select “Approvereasons” from the available pull-down option list
Valid Transitions: leave unset
Promote: leave unset

This status level is defined so that status level “WORKING” transitions to the ‘PENDING-APPROVAL’ status
value after a promotion.

This is configured by navigating to the “WORKING” status value and add “PENDING-APPROVAL” status
value to the “Valid transition” text field. Then set the “Promote” text field to “PENDING-APPROVAL”
status value.

The Status Reason values is an optional definition, if set for a STAVAL (Status value), it provides the
capability for users to specified the status transition reason values.

129
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This means that when the user promotes an item in this case engineering object in AVEVA
EngineeringTags a status level e.g. ‘WORKING’ state to the ‘PENDING APPROVAL’ the Status
Definition dialogue form will display the “Reason” pick list with the specified reason values.

 The status reason value [UDLOV] in this example was defined in the Conceptual model
Exercise 7 – Status Definition

Using the methods demonstrated in ‘Section 5.1’ more Status Definition are created as shown:

 Alternatively run the supplied macro [‘Status Definintions.txt] by the trainer to create required status
definitions as shown. Before running the macro, delete the previously created status definitions.

130
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 6

6 Database Views
Database Views Definition

A Database View is a Dabacon based functionality with which attribute data of elements can be translated to
tables or grids in AVEVA Engineering. These tables can be generated as lists, indexes and reports.

A Database View definition is based on element type (UDETs) and used to define a view of data derived
from single or multiple element type.

Database View supports a list view table, where 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 multiple database elements
may be modified if a row of data is edited in a grid or via an import.

113
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

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)

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.

For an engineering project setup, the Database Views definition helps performs the following functions:

• Specifies the major element (UDET) which a list is based on


• Specifies properties which are available as list attribute columns and expression columns

132
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

• Defines the required contents and behaviour of an engineering list


• Defines the creation requirements and criteria for list items  Defines the presentation structure of
list items

Each block on the diagram is defined below:

Database View World:


DBVWW
The top-level administrative element.

Database View Group:


Used to group definitions into manageable administrative sets, this
i DBVWGR s for administration only and is not visible to users in other
contexts.

Database View Set:


Used to group Database Views for user presentation. These should
DBVWSE contain related 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.

Database View
DBVW A table definition that defines the display name, element criteria and columns

Attribute Filter:
An attribute filter is a test executed against the selected element based
ATTFIL on the 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

Expression Filter:
An expression that must evaluate to TRUE or FALSE to determine
EXPFIL whether a 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

133
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Attribute Column:
This is an element, which defines columns based on a single attribute. Attributes may be
system attributes or UDAs. Qualifiers can be specified where required
ATTCOL
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

Expression Column:
This is an element, which defines columns based on a PML or XPATH
EXPCOL expression. Expression columns are read only unless software is
written to make them editable.

Source Element:
This is an element, which defines a navigational step from the current context element to another
database element. All columns defined in the Source Element are
SRCELE 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.

Creation Rule:
This defines the rules for element creation. If within a DBVW element then the rules permit row creation for the Da
attribute is set to TRUE. Information such as where to
CRERUL
create the new item or what type of element to create can be fixed or
specified using expressions

Set Parameter:
This is an element used to define parameters for expressions in other create rules. A parameter can be used in ex
ability to prompt a user for a single piece of information and then
SETPAR use it in multiple expressions

Set Attribute:
This defines a rule to set a database attribute when the element is
SETATT created. This allows attributes to be defaulted at the point of creation
and forces a user/application to provide a mandatory attribute value
at the time of element creation.

134
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Set Status Rule:


SETSTA This defines a rule to assign a status to the created item at the time of creation.
This will help ensure all elements are being status managed

Test Expression:
TESTEX if this evaluates to true then the owning rule will be carried out,
otherwise the owning rule is ignored

Column Relation:
This element defines a Parent/Child relationship between columns for
COLREL application use.

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.

Database Views Setup

Database Views are defined via the Database Views Editor within the LEXICON and AVEVA Engineering
Configuration, or with the Current Element Editor within the LEXICON module, as was originally default.

The Database Views Editor is a General user interface for the creation and definition of Database Views in a
quick and user-friendly manner.

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.

135
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

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.

Database View World


- DBVWWL

Database View
- DBVW

ATTCOL AttributeColumn

Expression Column
EXPCOL

Creation Rule
CRERUL

Source Element
SRCELE

The following example will demonstrate the definition of a Database View for a mechanical equipment.

Database Views Editor


The Database Views Editor is a General user interface for the creation, definition and modification of
Database Views in a quick and user-friendly manner.

The Database Views editor user interface sits in both the AVEVA Engineering – Configuration module and
the AVEVA Administration – Lexicon module, as they can be utilised from both applications.

136
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

• “AVEVA Engineering – Configuration” module: the Database Views Editor button is at the Rules
tab in the Tools group.

• “AVEVA Administration – Lexicon” module: the Database Views button is at the Home tab.

Database Views Editor – View Definition Set

There are 3 types of Data Views sets available in the Database Views Editor, they are:

137
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

• Element Views defined automatically to represent the database hierarchy, and includes all available
element types within the MDB utilised.

• Project Views defined in the Dictionary database for a project.

• User Views defined as a file in the Users Project settings. These views are stored in an XML file
format located in a default location %PDMSUSER% folder, for example at,
C:\Users\Public\Documents\AVEVA\USERDATA\

These Definition sets are visible and manageable from the Database Views Editor.

 User Views are applicable when the configuration of the Database Views is going to be exposed in an
external XML file, for example for a third party or an external User (external to the Project). Notice these
Views are not synchronised/updated with the Database Views set at the Project level (Project Views).

6.5.1 Create Database Views – A Worked Example

First, enter AVEVA Engineering – Configuration Module with following details:

 If the Engineering-Configuration module is


previously opened, do not re-enter the
application, simply proceed with the following
steps.

Project------- Training

Username -- SYSTEM

Password--- XXXXXX

MDB --------- A-Tags

138
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the Configuration tile

Open the Database Views Editor window, by clicking on the Database Views Editor icon on the Rules tab
in the Tools group.

In this example, select the ‘Project Views’ view definition set from the drop down list. This should be
displayed with an empty ‘view’ area. Then place the cursor on the empty area, below the Name, Description
and Element Type headings.

Display the right click context menu and select the New > View entries, to create a new Database View.

139
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

A new DB view is created and is initially named ‘Table 1’ by default.

 The View Details pane includes a lock symbol that is open or closed depending on
whether the User is allowed or not to edit the selected database view.

 The Database Views Editor in both Lexicon – AVEVA Administration and Configuration – AVEVA
Engineering modules carry the closed lock when the Element Views definition set is selected, as no
edits to permitted in both module. Notice Element Views are defined automatically as they represent the
database hierarchy.

Fill in the property details as shown below, ensuring to type in the correct element type or select with the
available browse button .

Fill in the attribute details as shown.

140
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

User-defined name: LINE-BASIC-VIEW

Description: Basic View for Lines

Select the browse button from Element types field to select the preferred element type, in this case
ProcessLine UDET (: ProcessLineUDET) as shown.

Click OK button from the “Select element types” form to save the selected element to the Database View
Editor form.

141
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

From the View Detail pane of the Database Views Editor window, select the Data Sources tab. The Data
Sources for the Database View are displayed e.g. DBVW Basic View for Lines.

142
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the Allow row creation checkbox, as this will allow row items to be created on any grid/list, which is
based on this dbview.

Select the ‘Auto assign or create owner’ checkbox, this allows auto creation of the (ENGGRP) for
Engineering item (ENGITEs) in AVEVA Engineering-Tags if none is not available when the user creates an
engineering item.

 The Auto assign or create owner checkbox is used to create the new element in the first available
owner or an ownership hierarchy is created if one is not present.

143
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

6.5.2 Defining Database View Attribute Column – A Worked


Example

The Columns tab displays the columns definitions for the Database View. A column can be based on a
database attribute or expression.

Attribute columns are editable in the Database View by the user unless the Read-only property is set.
Columns based on expressions are not editable by the user when accessed in the data grid.

From the View Detail pane of the Database Views Editor window, select the Columns tab. The columns
definitions for the Database View are displayed.

Select the appropriate data source from the drop down list as shown:

144
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Define the attribute columns, which are required for the dbview by clicking on the ‘New’ icon to create a new
row (which represents a column).

Select the ‘Attributes/Expression’ column and add the desired attribute in this case “NAME’ from the
available pull-down list as shown.

145
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Alternatively, PML1 expression can be used to get the value of the column. PML 2 is not supported.
 The ‘Column name’ acts as a column header / caption, and can have texts typed into it, if unset then the
display name is derived from the attribute or the expression used to get the column value.

 If duplicate names are entered then the first column will have the requested name, subsequent columns
will have an index added (for example:'Name (2)').

 Selecting the ‘Read only’ checkbox will ensure that the column will not be editable, and will appear
greyed out.

Using the same, procedure demonstrated above, create more rows of attributes as shown below, notice the
Attribute/Expression can be either typed or selected from the drop down list.

146
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Columns tab has the Add Standard Attributes functionality, which adds all of the common attributes for
the elements of the selected data source.

 The “Add Standard Attributes” option is enabled if columns do not already exist for all of the common
attributes and the element type for the selected Data Source can be identified.

Click on Add Standard Attributes as it is displayed below.

All the standard Attributes will automatically be added to the DatabaseView and the Add Standard
Attributes functionality will be disabled since the attributes are already added.

147
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

From the View Detail pane of the Database Views Editor window, select the Preview tab to view the
columns layout as shown.

148
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The newly created “Database View” can be viewed and edited via the “Database View Explorer”, Current
Element Editor Form.

 The “Database View” default name can be renamed if required, via the Current Element Editor form.

149
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The Database View Explorer is used to explore the project database view hierarchy, which in this
particular case will only contain the hierarchy that was automatically created for the Worked Example.

 Do a savework to save the newly defined database view.

If required, user (s) can navigate to the Database View Explorer from the View Definition Set, by right
clicking on the row of the View definition, as it is displayed below.

150
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 8 (a) – Database View Definition

1. In a separate session enter AVEVA Engineering –Tags Module; as SYSTEM user, with the
following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags

2. Create a new List View based on the newly database view “LINE-BASIC-VIEW” using the details
below:

 Category : Process List

 Category Type: Project

 List Name : Process Line

 Project Views :LINE -BASIC -


VIEW

3. Open the new list view “Process Line”. Create a new-tagged item and rename the item, in this case
rename the item to “50-B-A1A”. Then complete the following attribute fields as shown.

151
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Do a savework and exit AVEVA Engineering –Tags module.

6.5.3 Defining Source Element Data

Defining a “Source Element Data” (SRCELE) in a database view configuration provides the capability to
derive data from multiple sources (Elements). For example, database view with “Source Element Data”
configuration can be used to display a tagged items data along with corresponding associated disciplines
data (Distributed Data) as illustrated in the diagram below.

 This configuration is optional; it is only used if it is a project requirement.

The Source Element Data” (SRCELE) object, defines a navigational step from the current context 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.

152
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

6.5.4 Defining Source Element Data – A Worked


Example
This worked example illustrates the definition of Source Element Data for discipline data, in this case
Process Data.

First, re-enter Engineering-Configuration module with the following details: Username: SYSTEM;
Password: XXXXXX; MDB: A-Tags.

If the Engineering-Configuration module is previously opened, do not re-enter the application, simply
proceed with the following steps.

From the View Detail pane of the Database Views Editor window, select the Data Sources tab.

Select the “DBVW Basic View for Lines”. Right click on the listed Database View, DBVW Basic View for
Lines, and select the ‘’New SRCELEMENT’ from the context menu to create a source element.

The Source Element, SRCELE, will point to a relevant element type whose attributes will be utilised in the
attribute columns.

153
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Fill in the

descriptions text as it is shown below:

Description: Line Process Data

154
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

For the Expression, select the appropriate expression option from the drop-down list. In this example select
“XRQELE ( typename :ProcessLinePROC )” from the available pull-down list.

 XRQELE is a pseudo attribute, it returns one distributed attribute from the distributed attribute members
(e.g. :ProcessLinePROC) associated with the current element.

Select the Allow element creation checkbox, as this will allow row items to be created on any grid/list,
which is based on this dbview.

155
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In this training project, the :ProcessLinePROC has been modelled as a distributed UDET, which is
based on the XPITEM Base type, and have been set as distributed members of the :ProcessLine
element type.

From the View Detail pane of the Database Views Editor window, select the Columns tab. The columns
definitions for the Database View are displayed.

Select the appropriate data source e.g. “Line Process Data” from the drop down list as shown.

156
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on Add Standard Attributes as it is displayed below.

All the standard Attributes will automatically be added to the DatabaseView and the Add Standard
Attributes functionality will be disabled since the attributes are added.

 Do a Savework to save the new definitions.

157
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 8 (b) – Database View Definition – [Source Element


Data]

1. In a separate session enter AVEVA Engineering –Tags Module, as SYSTEM user, with the
following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags

2. Open the list view “Process Line” and update the following attribute fields for tagged item “50-B-A1A
“as shown.

MIN DESIGN TEMP: 50.00

MAX DESIGN TEMP: 90.00

 Do a savework and exit AVEVA Engineering –Tags module.

6.5.5 Define Creation Rules – A Worked Example

The creation rules define the information required to create a new element. They also set up the initial state
of the element created by setting attribute values and assigning status.

This worked example illustrates the definition of Creation Rules in a databaview. First, re-enter
EngineeringConfiguration module; with the following details: Username: SYSTEM; Password: XXXXXX;
MDB: A-Tags.

If the Engineering-Configuration module is previously opened, do not re-enter the application, simply
proceed with the following steps.

158
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

From the View Detail pane of the Database Views Editor window, select the Data Sources tab. The Data
Sources for the Database View are displayed e.g. DBVW Basic View for Lines.

For the Owner Expression, type in the text: id /PipeLine. This will be the name of the ENGGRP
(engineering group) where the Process Line items will be stored.

 The Owner Expression field, is used to enter the OWNER for the element being created, if left unset
then the user is prompted for the OWNER.

The ‘Type Expression’ is set ‘:ProcessLine’, as it specifies the ‘ActType’ attribute of the item to be created.
However, this is not required as the element type being used can be dynamically derived.

 Type Expression - In the Type Expression field, enter a string expression returning the type of the
element to create such a '; MyUdet'. If this is not set then the user is prompted for the type of element to
create. The user is not prompted if the type can be derived.

Database view Creation Rules involves a number of steps such as Parameters, Attribute Rules and Status
Rules definitions, this is explained in the following sections.

6.5.6 Define Parameters – A Worked Example

Parameters are user defined variables that can be used in the create rule expressions. A parameter can
either be a value derived from an expression or information requested from the user.

From the View Detail pane of the Database Views Editor window, select the Data Sources tab.
159
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Data Sources for the Database View are displayed, in this case ‘DBVW Basic View for Line’. Expand
the ‘Create Parameters’ node.

Click on the ‘Add Parameter’ button to include desired parameters using the details provided below.

User-defined User prompt Expression Expression Uda Type Required


name Type
LArea Area PML TEXT
LSize Nominal Size PML TEXT
LFluidcode Fluid Code PML TEXT
LSno Line Number PML TEXT
LService Service Code PML TEXT

 User-defined name - The name of the parameter, as used in the expressions. 


User Prompt - The prompt to display to the user to request a value.
 Expression - The expression used to derive a value for the parameter, if unset the user is prompted

160
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Expression Type - The syntax of the expression (PML or XPATH), PML expression must be PML 1 only
 UDA Type - The data type for the parameter, this affects user entry for the parameter and not the
parameter use.

 Required- Indicates the parameter is required and whether element creation can succeed without it.

6.5.7 Define Attribute Rule – A Worked Example

The Attribute Rules define the initial values of attributes when the element is created. These can be fixed by
specifying expressions to derive the value or the user can be forced to enter a value at the time of element
creation.

From the View Detail pane of the Database Views Editor window, select the Data Sources tab.

The Data Sources for the Database View are displayed, in this case ‘DBVW Basic View for Line’. Expand
the ‘Attribute Rules’ node.

Click on the ‘Add Rule’ button to include desired rules using the details provided below. The Attributes
Rules part of the Data Sources tab populated with the desired rules as shown below.

161
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

User-defined Attribute Expression Expression Required


Type
Line Tag Name '/$!LSize-$!LFluidcode- PML
$!LSno-$!LService'
LINESEQNO '$!LSno' PML
(Line Sequence
Number)
FLUID CODE '$!LFluidcode' PML
SERVICE CODE '$!LService' PML
Size BORE SIZE '$!LSize' PML
System SCSYSF (this will PML
default to attribute
Systems)
SPECIFICATION PML
Area AREA NUMBER '$!LArea' PML

162
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Attributes Rules part of the Data Sources tab populated with the desired rules as shown below.

163
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

6.5.7 Define Status Rules – A Worked Example

The Status Rules assign the identified status definition to the element on creation or prompts the user for a
status definition to apply if the status definition is not defined.

From the View Detail pane of the Database Views Editor window, select the Data Sources tab.

The Data Sources for the Database View are displayed, in this case ‘DBVW Basic View for Line’.

Expand the ‘Status Rules’ node.

164
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on the ‘Add Rule’ button to include desired rules using the details provided below.

User Prompt Status definition reference Required


Status ENGR-STATUS-DEFINITION

 User Prompt - The prompt, which is displayed to the user.


 Status Definition Reference - The status to assign to the created element, if left unset then the user is
prompted. The Status definition must be pre-defined.
165
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Required - Indicates whether a status must be assigned for the element creation to succeed.

6.5.8 Data Model - Overview

A pictorial representation of how the components relate to each other is displayed below:

166
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 8 (c) – Database View Definition – [Creation Rules]

167
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

1. In a separate session enter AVEVA Engineering –Tags Module; as SYSTEM user, with the
following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags

2. Open the Engineering Database Explorer on Admin Tab, create a new ENGGRP” rename the
“ENGGRP” default name to “PipeLine” as shown.

3. Open the list view “Process Line” and create a new-tagged item using the newly defined “Creation
Rule” definition.

168
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
 Do a savework and exit AVEVA Engineering –Tags Engineering Administration (TM-3652)
module

4. In order to create the Database View definitions required for this training, run the macro provided by
the trainer. However, before running the macro, delete the Database World that was created in this
working exercise so the Database Views World is empty.

First, re-enter Engineering-Configuration module with the following details: Username: SYSTEM; Password:
XXXXXX; MDB: A-Tags.

If the Engineering-Configuration module is previously opened, do not re-enter the application, simply proceed
with the following steps.

Then run the supplied macro “Database-Views.txt” to create required Database Views and continue with
this training.

169
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This page is intentionally left blank.

170
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
CHAPTER 7

7 Datasheets
This section gives an overview of the definition of datasheets templates within the AVEVA Configuration
module, required for datasheets creation, data entry and modification functionalities within a datasheet in the
AVEVA Engineering application. Before Datasheets template can be configured system Administrators are
advised to complete the following procedures:

• Setup attributes and UDETs (Mandatory).


• Setup distributed schemas for distributed attributes (not mandatory – only setup if required).
• Setup Database View and Database View Sets (Mandatory – used as data source for datasheets
template).

Datasheet Configuration Overview

Datasheets templates are created in AVEVA Configuration module and stored in a dictionary database. The
instances are created in AVEVA Engineering, Tags Module and stored in an engineering database.

To create datasheets templates and datasheet instances as represented above a number of procedures
must be followed such as:

AVEVA CONFIGURATION Module

• Create datasheets template (DSTMPL)


• Define datasheets template presentation
• Define Units of Measure
• Define and assign revision number control to datasheets template
• Add continuation Area (not mandatory – only setup if required)

AVEVA Engineering

• Create a Datasheets instance based on a datasheets template created in AVEVA Configuration


module
• Add /modify data in the Datasheets instance
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

147
7.1.1 Database Views Set for Datasheets – A Worked
Example

A Database View Set is used to group Database Views for user presentation. These should contain related
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.

Although ‘Section 6.5’ covers the definition of Database Views, as well as its setup and configuration, this is
expanded on in this section for use within datasheet configuration.

The datasheet feature utilises the Database Views sets within its configuration, and this example describes
the creation and configuration of a Database Views set which will be subsequently applied.

First, re-enter Engineering-Configuration module with the following details: Username: SYSTEM; Password:
XXXXXX; MDB: A-Tags. If the Engineering-Configuration module is previously opened, do not re-enter the
application, simply proceed with the following steps.

Open the Database Views Editor from the Configuration module in AVEVA Engineering by clicking on its
button in the Rules tab in the Tools group.

In this example, select the ‘Project Views’ view definition set from the drop down list.

172
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

C reate a Database View Set (DBVWSE) by selecting the “View Sets” tab, placing the cursor on the empty
area and displaying the right click context menu.

Fill in the attribute details as shown.

User-defined name: PUMP-NOZZLE-DBVIEW-SET


Description: Database Views Set for Pump and Nozzle

173
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the newly created Database View Set and navigate to the item in the “Database View Explorer”

Display the Current Element Editor and fill in the attribute details as shown.

174
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Name: PUMP-NOZZLE-DBVIEW-SET

Relevant Database Views can be directly created under a Database View Set or indirectly linked to existing
Database Views as illustrated below:

To do this, select existing Database View ‘MECH-EQUIPMENT-FULL-VIEW’

In the Current Element Editor form, select the “Database View Sets” field browse button and enter the relevant
Database View Set name “PUMP-NOZZLE-DBVIEW-SET”.

175
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select OK button to save the setting.

Assign Database View Set “/PUMP-NOZZLE-DBVIEW-SET “to NOZZLE-VIEW Database View, using the
same procedure shown above.

Then navigate to the newly created Database View Set (e.g. PUMP-NOZZLE-DBVIEW-SET). Select “New”
from right-click menu and click on Column Relation option from the right-click submenu.

176
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “New” form is then displayed. Click the OK button to create the Column Relation.

 Column Relation: This element defines a Parent/Child relationship between columns for application use.

 The “Parent/Child” column text field only accept pre-defined values from DatabaseViews columns names
(ATTCOLUMN / EXPCOLUMN )

In the Current Element Editor form, enter the following data in the appropriate textboxes:

Parent Column: PID (From “Attribute column” in database view (MECH-EQUIPMENT-FULL-VIEW)

 The application identifies the “Parent column” by the entering of “ATTCOLUMN” Name value in this case
“PID” into the “Parent column” text field.

 The “PID” value, in this example is a user-defined Attribute column (ATTCOLUMN) name in the
MECHEQUIPMENT-FULL-VIEW (Database View) as shown below .

177
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Child Column: CID (From “EXPCOLUMN Name” in Database view NOZZLE-VIEW)

 The application identifies the “Child column” by the entering of “EXPCOLUMN” Name value in this case
“CID” into the “Child column” text field.

 The “CID” value, in this example is a user-defined Expression column (EXPCOLUMN) name in the
NOZZLE-VIEW (Database View).

178
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.1.2 Create Datasheet Template Records – A Worked


Example

Select the Libraries tab from the menu to display the Datasheet Explorer.

179
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In AVEVA Engineering 14.2, Datasheet Configuration can only be done in Configuration module.
AVEVA Admin 1.5 –Lexicon module does not support Datasheet Configuration.

Navigate to the Datasheet Templates node, select “New” from right-click menu and click on “Datasheet
Template World” (DSTWLD) option from the right-click submenu.

 Alternatively, the DSTWLD can also be created via the “New” option on the Libraries tab context
menu

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: ENGINEERING-DATASHEETS-TEMPLATES

 This field is not mandatory.

Click the OK button to create the Datasheet Template World.

180
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Navigate to the DSTWLD, select New from right-click menu and click on “Datasheet Template Group”
option from the right-click submenu.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter the following data in the appropriate textboxes:

Name: ENGINEERING-DATASHEETS-TEMPLATES-GROUP

 These fields are not mandatory


181
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Datasheets Template World (DSTWLD) and Datasheets Template Group (DSTGRO) are the top level
containers

Click the OK button to create the Datasheet Template Group.

Select the created Datasheet Template Group ‘ENGINEERING-DATASHEETS-TEMPLATES-GROUP’, and


click the New Datasheet Template option from right-click menu.

The “New Datasheet Template” form is then displayed, enter the following data in the appropriate
textboxes:

Name: CENTRI-PUMP-
DATASHEETTEMPLATE

Description: CENTRIFUGAL-
PUMPDATASHEET-TEMPLATE

182
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Data Source: Select the add button , next to the Data Source field. The “Add Data Source” dialog is
then displayed. Select the ViewSets tab and select the “PUMP-NOZZLE-DBVIEW-SET” and click on the
“Add” button.

Then select the “View” tab, and add the following data sources; “PROJECT_VIEW” and “DS-VIEW”, and
click on the “Add” button as shown:

183
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Template File: The template file field should remain


unset.

 The “Template file” field is automatically


populated with the file path of the template when
created
 Datasheet Templates are stored by default in
……. project>dflts\Data\Datasheets\Templates

184
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Uncheck the “Edit the template when finished” checkbox option. Click the “OK” button from the “New
Datasheet Template” dialog to create the datasheet template (DSTMPL) and close the dialog form.

 If the Edit the template when finished” checkbox option is checked. The Datasheet Template Editor
will automatically be displayed after clicking the OK button on the New Datasheet Template” dialog.

To open the newly created datasheet template, select the datasheet template (DSTMPL) e.g. “CENTRI-
PUMPDATASHEET-TEMPLATE” from right- click submenu click “Edit Datasheet Template”. Alternatively,
from the Libraries tab context menu.

185
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Datasheet Template Editor dialog is then displayed.

The Datasheet template is divided into two main areas. The left area shows spread sheet layout, this is
mainly used to define the datasheet layout. The right area contains a list of all the attributes contained in the
selected Database View.

After the creation of the datasheets templates (DSTMPL) the presentation or format can then be defined by
the Administrator in line with the company template format or user preference using the Datasheet Template
Editor Toolbar functionalities as shown below:

The Datasheet Template Editor contains buttons that allow users to perform the following actions in datasheet
template editor.

Icons Toolbar button Description

Save datasheet template Allows saves at the current datasheet


template
Print Allows prints at the current datasheet
template
186
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Cut cell Allows cutting of data, mapping and


presentation of selected cell
Copy cell Allows copies of data, mapping and
presentation of selected cell
Paste cell Allows paste of data, mapping and
presentation of selected cell
Delete cell Allows deletion of data, mapping and
presentation of selected cell
Zoom-in Allows zooming in various sheets in
datasheet template
Zoom –out Allows zooming out in various sheets in
datasheet template
Add Area Allows a continuation area to be added to
the selected cell area
Remove Area Allows a continuation area to be removed
from selected cell area
Auto Map Allows to auto map the cells on right side of
selected header text cell
Bold font Sets the font to bold in selected cell
Italic font Sets the font to italic in selected cell
Underline font Underline the font of selected cell
Font Allows the font of selected cell
Merge/ Unmerge cells Allows merging or unmerge the selected cell
area(s)
Lock Allows locking or unlocking the selected cell
in datasheet instance
Properties Allows the user to display or close the
Properties window
Template Explorer Allows the user to display or close the
Template Explorer window
Toolbox Allows the user to display or close the
Toolbox window
Message Grid Allows the user to display or close the
Message window
GridLines Allows the user to control the display of Grid
Lines. This control of the display of Grid Lines
is on a per-page basis.
List Type Allows the user to define List type datasheet
Template

User (s) should be able to design their datasheet templates with different styles of borders and various
colours, which are reflected in the data sheet instances.

187
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.1.3 Adding Border to Datasheet Template – A Worked


Example

Datasheet Template Editor provides the users with the capability to design their datasheet templates with
different styles of borders as demonstrated in the example below:

Open the borders window by selecting a few cells in the datasheet template, from the right click menu; select
the “Border” option.

A new window with title “Border Editor” is then displayed.

188
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the preferred border styles and colours e.g. ‘ThickLine’ style and ‘Black’ colour as shown.

189
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

After selecting the line style and colour, use the outline buttons, inside the
“Presets ” section, which will be used to set the outer/inner borders of the selected

Users can also select or deselect the individual horizontal or vertical buttons in
order to set the cell borders in different ways.The user can see the changes in
over view the border settings in the B “ order ” group box. Users can also the
change the borders by clicking on the “None” buttonin the ‘Presets ’ section.

C lick the OK button toapply the border to the selected cells. “Cancel ” button is
used to close the window and user will not see any changes in the borders of
selected cells.
cells.

The Datasheet Editor also allows the user to modify Cell properties such as Height and Width, Justification of
text, Font etc.

190
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The format of multiple cells can modified, by selecting


the desired cells before updating the value in the
properties window.

To complete the datasheet template creation, select the Save icon on the “Datasheet Template Editor”,
followed by a SaveWork in the “Configuration” module before exiting the Datasheet Template Editor.

7.1.4 Reference Existing Datasheet Template Excel File –


A Worked Example

Excel files which are templates from external sources can also be referenced and used in existing datasheet
template (DSTMPL) configurations as illustrated below.

 Only the XLSX file format from MS Excel 2007 & 2010 are supported
Navigate to the preferred DSTMPL (e.g. CENTRI-PUMP-DATASHEET-TEMPLATE); select Properties
option from right-click menu to display the “Datasheet Template Properties” dialog.

191
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

From “Template File”, select the browse button , next to the “Template File” field and select the preferred
Excel file from the desired location.

Select the Open button to update the Template File field.

 The trainer will provide the sample datasheet template.

Check the “Edit the template when finished” checkbox and click the “OK” button from the “New
Datasheet Template” dialog to update the datasheet template (DSTMPL) and open the “Edit Datasheet
Template” dialog.

192
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Datasheet Template Editor dialog is then displayed.

Once the datasheet is displayed, Admin users can insert new rows or columns in the Template Editor if
required. This can be achieved by selecting the preferred row/columns and click the ‘ New’ option to insert
new row /column

193
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.1.5 Database Attribute Mapping to Datasheet Template


– A Worked Example

Mapping database attributes (e.g. Name) to datasheet template cells, can be achieved by dragging the
preferred database attribute from the “Field List” (MECH-EQUIPMENT-FULL) section of the Datasheet
Template Editor dialog to the desired cell.

First, search for the preferred database attribute using the “Field List” Search tool, in this example search for
Name attribute.

Then drag the “Name” attribute from “MECH-EQUIPMENT-FULL” Data Source group and drop it onto the
Desired cell as illustrated below.

194
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

If the mapping is successful, the default yellow feedback colour is displayed.

 If the mapping is successful, when the mapped cells are selected, the corresponding attribute will be
highlighted in the database source field

 If the mapped database attribute datasheet cells have a list of values, a pull down list button will be
displayed in the mapped cell.

To un-map or un-assign a mapped cell, click on the mapped cell in this case “ Name” cell and select Delete
icon from the Datasheet Template Editor main toolbar or context menu.

195
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Using the same procedure as shown above; map the following database attributes from the “Field List”
(MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the appropriate label text
cell:

Database Attribute Datasheet Template Cells


NAME Name
PREFIX Prefix
TAG LETTER Tag Letter
TAG NUMBER Tag Number
SUFFIX Suffix
DESCRIPTION Description
AREA/UNIT Area Number

Users can also set the “Behaviour”property option of the mapped cell to indicate that a supplier should fill in
the field when the datasheet instance is exported as an Excel spreadsheet and sent to a supplier.

This can be achieved by selecting the preferred mapped cell in the case “Description” cell. Click on the
Provide By Supplier from the context menu accessible via Behaviour option.

196
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Behaviour field in the


Properties window is
automatically updated for the
selected cell.

For cells that have been set with the Behaviour as “Provided by Supplier”, when exported as an Excel
spreadsheet. these cells will remain unlocked by default, with the rest of the cells in the datasheet instance
being locked by default.

7.1.6 Auto Database Attribute Mapping to Datasheet


Template

Auto database attribute mapping allows the creation and mapping of attributes to the adjacent cell of the
selected header text cell.

197
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Automap process runs the following algorithm to find the best possible UDA or attribute for selected header
text(s).

• Searches for attributes with the same name as the header text in the data source in datasheet
template
• If no attribute exists then, searches the dictionary database for UDAs with the same name as of the
header text.
• If no match is found, the selected header text row is not matched.

7.1.7 Auto Database Attribute Mapping to Datasheet


Template – A Worked Example
Auto creation and mapping database attributes to datasheet cells can be achieved by selecting the preferred
cell label e.g. “No.Operating” from the displayed datasheet template.

 In the Datasheet Template it is possible to make multi-selections of cells if required


Select the Auto Map icon from the main toolbar to display the ‘Create and Map’ form.

198
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Matched - Selected header text matches one of the attributes available in template explorer. A user can
check the detail for matched UDAs and accept the row to create a mapping for the adjacent cell.

Not Matched -Selected header text does not match any attribute in database. The user needs to select an
attribute or specify the required properties to create a UDA. Complete the required fields as shown below.

Attribute Name Field – Select the appropriate database attribute name (NO OF OPERATION) from the
available pull-down list.

199
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 If the label text does not have any equivalent attribute in the database, the ‘ Create and Map’ window
provides the capability to create a new attribute from the label text. Preferred UDA group can be
preconfigured via the DatasheetsTemplate Settings window to hold the newly created attributes as
shown in this example below.

 The UDA owner (e.g./AUTOMAPPED) should exist in the dictionary database. In this example create a
UDA group ‘AUTOMAPPED-UDAs’. If a predefined owner group is not found a default group will be
created automatically by the application.

Dat
a Source Field – Select the appropriate Data source
(database view) e.g. “MECH-EQUIPMENT-FULL”. If is not selected by default.
Data Type Field: Select the appropriate UDA type from the pull-down list e.g. Text. If is not selected by default.

Category Field: UDA Category, this is not required in this example.

List of Values: UDA Valid values, this is not required in this example.

Unit of Measure: UDA Units; this is not required in this example. This field is only enabled if the UDA type
“real” is selected.

Maximum Length: Enter the appropriate UDA Length e.g. 250. If is not set by default

Select the “Accept” or the “Accept All” to enable the “Create and Map” button. Click the “Create and
Map” button to create the label text in the database as an attribute and map the attribute adjacent cell to the
label text.
200
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “Create and Map” form will display a message, if the UDA creation fails, is successful or the required
data is not specified by user.The selected label text cells are created in the database and mapped to
corresponding label text as shown.

201
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Then do a SaveWork

 The application automatically locks all the mapped cells by default after a savework operation. Unlock
the affected cells, by selecting the locked cells and click on the “Lock” icon in the main toolbar.

7.1.8 Units of Measure Definitions (Unit Sets)

Unit Sets Configuration allows the user to create, configure and delete the unit sets available for selection.

The following figure is an example view of the configuration form:

On the left side, the user can select, create, and update unit sets and their dimensions.

Add new unit


set Creates a new unit set.

Delete unit set Deleteconfirm the deletion.s the selected unit set. A dialog box appears to

Copy unit set Makes a copy of the selected unit set.

The user can edit any unit set by double clicking on any row.

Name The name of the unit set. Any appropriate name can be chosen. If the
Unit Set name is the same as its dimension, then the set will be used as

202
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

the default for this dimension.


Dimension
Select the appropriate dimension from the drop-down list. An alternative
way to enter a dimension is to type a common unit for the dimension,
e.g. if ‘m3/h’ is entered it will be resolved to Volumetric Flow.
 By changing the dimension of the unit set, it will clear all the units that
might exist in the unit set.

In the left side of the form, the user can enter the units for the selected unit set. The grid represents the desired
order of for the units.

Input appropriate unit(s) of measure, if required the user can add multiple units of
Unit measure, by clicking Add or the Enter key on the keyboard.

Select a system of measure from the drop-down list (Imperial, Metric, SI or US).
System
Currently not in use.

Add new unit Adds a new unit to the unit set

Up / Down order Move the selected unit higher/lower in the order of appearance

Delete unit Deletes the selected unit.

The grid has three columns, as shown in the following figure:

Unit The name of the unit as it is known in the Database

The label that will be displayed throughout the system. Unicode


Display Label characters can be used. Each display label should be unique per unit set.
Precision The number of decimal digits that will be used.

203
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The tool also allows the Admin users to set the unit of measure presentation and precision independently
from the project units and precision.

This is explained in the following worked examples.

7.1.9 Units of Measure Definitions (Unit Sets) – A Worked


Example

Compound units based on the available base units e.g. m3/s2, ft3/hours2 can be defined in
CONFIGURATION/LEXICON modules and utilized within Datasheets and AVEVA Engineering List
columns.

The ‘Unit Sets Configuration’ window is accessed by selecting the ‘Configure’ option in ‘Unit Sets’ group of
the ‘Rules’ tab.

The Unit Sets Configuration’ window is then displayed.

Click on the Create Unit Set icon to define a new unit set definition as shown

204
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Enter or select the following data in the appropriate Unit Sets Configuration form textboxes.

Name: Temperature

Dimension: Select from the pull-down list or enter the appropriate dimension e.g. “Temperature”.

Unit: Enter the relevant Units e.g. degC , degF , K . and select enter icon after each entry.

In the “Display Label” field, the user can enter any Unicode character, in any language. If there is a need for
special characters, then the relevant Unicode code can be used, by entering a backslash ( \ ), followed be
the letter u or U and the code of the character.

For example, the symbol ⅓ will be \u2153 or \U2153.

An alternative way to enter special characters is by copy and paste from another application, or by using the
available ALT codes, for example by holding the ALT key and entering 0178 in the “Display Label” field, it
produces the ² (superscript two) character.

By default, every number that is entered in the display label box is converted to a superscript. If the user
wishes to change to a normal or subscript character of that number, then the user can use the Up or Down
arrow keys on the keyboard.

205
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The figure below shows an example of a label that includes superscript.

Repeat the same procedure as described above to create a new unit set definition for Pressure, using the
data below:

Name: Pressure
Dimension: Select from the pull-down list or enter the appropriate dimension e.g. “Pressure”.
Unit:
after each entry.

E
nter the relevant Units e.g. bar, and psi and select enter icon

Finally, click OK button to apply any modifications and close the form. Then do a SaveWork.

206
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.1.10 Assigning Default Units of Measure to Datasheet


Template Cell – A Worked Example

The Datasheet Template Editor dialogue gives the Admin user(s) the capability to assign:

• User defined Unit Sets to datasheet


• Default unit of measure to datasheet
Assigning a default unit of measure to a mapped datasheet templates cell with the appropriate unit dimensions
involves the following steps:

First, map the following database attribute from the ‘Field List’ (MECH-EQUIPMENT-FULL) section of the
Datasheet Template Editor dialog to the appropriate label text cell.

Datasheet Template Database Attributes


label text
Stream Description STREAM DESCRIPTION
Stream Number STREAM NUMBER
Total Vapour Fraction TOTAL VAPOUR FRACTION
Total Temperature TOTAL TEMPERATURE
Total Pressure TOTAL PRESSURE
Total Molecular Weight TOTAL MOLECULAR WEIGHT
Total Mass Flow TOTAL MASS FLOW
Total Heat Flow TOTAL HEAT FLOW
Vapour Flow Rate VAPOUR FLOW RATE
Vapour Mass Flow Rate VAPOUR MASS FLOW RATE
Vapour Density VAPOUR DENSITY
Vapour Viscosity VAPOUR VISCOSITY
Vapour Compressibility VAPOUR COMPRESSIBILITY
Liquid Oil Flow Rate LIQUID OIL FLOW RATE
Liquid Flow Rate LIQUID FLOW RATE
Liquid Glycol Flow Rate LIQUID GLYCOL FLOW RATE
Liquid Density LIQUID DENSITY
Liquid API Gravity LIQUID API GRAVITY
Liquid Viscosity LIQUID VISCOSITY
Liquid Surface Tension LIQUID SURFACE TENSION

207
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Then, select the desired cell in this example (e.g.F27).and double click “Unit of Measure” option or drag and
drop the “Unit of Measure” option from the Standard Control menu to the desired cell.

 Datasheet Editor also supports the mapping of Unit of Measure control to multiple cells.

Select the relevant mapped cell in this case “Total Pressure” and assign the appropriate “Unit of Measure”
(e.g. UoM1-28-6) from the right click menu.

208
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The cell ‘Properties’ is automatically updated with selected Unit of Measure value.

Select the pull-down list button from the mapped Unit of Measure cell to display all the associated unit
derivatives

209
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Use the same procedure as shown above; to define and assign Units of measure to “Total Temperature”
mapped cell as shown.

To change the “Unit of Measure” Name (e.g. UoM1-25-8) to preferred name.

Select the appropriate mapped Unit of Measure cell and enter the desired name, in this case “Pressure” in the
“Properties” section of the Datasheet Template Editor dialog.

210
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.1.11 Assigning Unit Sets to Datasheet Template – A


Worked Example
Users can also assign a user-defined Unit set to datasheet template mapped cells that has the appropriate unit
dimensions, if the user chooses not to use the default unit of measure.

To do this, select the desired Unit set with appropriate assigned mapped cell. From the Properties window
select, the preferred Unit Sets definitions from the Unit Sets pull-down list as shown.

Once the “Unit Set” field is set, select the “Unit Set” option list button to display all the associated unit
derivatives.

211
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Repeat the same procedure as described above to assign “Total Temperature” Units of measure cell to the
previously defined Unit set in this case “Temperature”

212
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
required. C lick on the Unit of Measure pull-down list
button and select the “Precision ” tab. The “ Precision ”
window is then displayed.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the “Precision” window, increase the precision value to “3” using the available buttons.

Alternatively, in the “Properties” section of the “Datasheet Template Editor” dialog, the precision value can
also be increased or decreased by entering preferred value in the Precision field.

Using Standard Controls Operations in Datasheet Template Cells

The Datasheet Template Editor dialog gives users the capability to use the Standard control options such as
Check Box, Radio Button List, Picture Box and Free Text Cell in datasheets template if required.

7.2.1 Mapping Checkbox to Datasheet Template – A


Worked Example

The “Check Box” option is often used in a datasheet template, if the database attribute to be mapped has the
database attribute type “logical”.

Map a ‘Check Box’ option to the datasheet template, by selecting the preferred datasheet cell e.g. “Schematic
Item Link” field.

213
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

From the Standard Control menu, double click on the “Check Box” option to assign the “Check Box” to the
selected cell as shown:

214
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the “Properties” section of the Datasheet Template Editor dialog. Delete the Caption “Check Box” as it is
not required.

 Datasheet Editor also supports the mapping of ‘Checkbox’ control to multiple cells.

Next drag the preferred database attribute in this case “Schematic Item Link” from the “MECH-
EQUIPMENTFULL” Data Source group to datasheet template cell with the mapped “Check Box” definition. If
the mapping is successful, the cell will become yellow.

7.2.2 Mapping Radio Button to Datasheet Template – A


Worked Example

Radio Button option is often used in a datasheet template, if the required database attribute to be mapped to
the template has a defined list of values.

215
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

To map a Radio Button option to the datasheet template, select the preferred cell (e.g. “Inquiry No” text
field), and then double click on the “Radio Button List” option from the Standard Control menu to assign the
“Radio Button List” to the selected cell as shown:

Drag and drop the preferred database attribute in this case “Inquiry No”, from the Data Source field to the
datasheet cell with the “Radio Button List”.

216
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The orientation of the displayed list of values could


be either vertical or horizontal. This can be
modified via the “Properties” section of the
Datasheet Template Editor dialog when the
mapped “Radio Button List”. Cell is selected

7.2.3 Mapping Picture Box to Datasheet


Template – A Worked Example

Picture Box option is used in datasheet template, if the user(s) wants to bind a picture file to the datasheet
template.

Bind the picture file to the datasheet template by selecting the preferred cell. Double click on the “Picture
Box” option from the “Standard Control” menu to assign the “Picture Box” to the selected cell as shown:

In the “Properties” section of the Datasheet Template Editor dialog. Click the browse button in the “Image”
field and select the preferred picture file:

217
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 To display the properties fields of the picture box, the mapped picture box cell must selected

Click on the “Open” tab from the Open File dialog to bind the image to the datasheet template. The bound
image size can be re-sized by selecting the preferred size from the “Size Mode” field.

 The image URL can also be set to the mapped picture box in datasheet template if required

To replicate the mapped image on every page/sheet of the datasheet template, a ‘Repeating Area’ is added to
the mapped image cell using the ‘Add Area’ mechanism as described below:
Select the mapped image cell and click on the Add Area button from the context menu / main toolbar to define
the Repeating Area.

218
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the displayed Properties window, select the appropriate Area Type from the available pull-down list, in this
case ‘Repeating’

Click on the AssoiciatedSheets field to select the desired page/sheet. In the example, select the Page 1, 2,
Sketch Page and Note Page checkboxes.

219
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Repeating Area can also be applied to free text, mapped cells, Header and Footer.

220
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Finally select datasheet template ‘Page 2’ to view the Repeating Area.

7.2.4 Mapping Free Text Cell to Datasheet Template – A


Worked Example

Free Text Cell option is used in a datasheet template, if user(s) or an Administrator wants the cell value to be
editable, when a datasheet instance is created in AVEVA Engineering.

Map a Free Text Cell to cells in the datasheet template by selecting preferred datasheet cells.

221
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Double click on the “Free Text Cell” option from the Standard Control menu to assign the “Free Text” to the
selected cell as shown:

 The mapped cell color feedback can be modified by the Administrator if required via the Datasheet
Template Settings window accessible via Datasheets group of the Libraries tab.

222
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.2.5 Mapping Page Info to Datasheet Template – A


Worked Example

The Page Information option provides the capability to map page numbers to a datasheet template. The
toolbox provides the following properties:

• Page Number- Displays the current Datasheet page number in a cell

• Total Pages- Displays the total number of Datasheet pages in a cell

• CurrentofTotal - Displays the value defined by the Paging Format property, e.g. Paging Format “{0} of
{1}” where {0} represents the current page number and {1} the total number of pages

To map to the page info. Select the “Page Info” control from Standard Controls and then drag and drop onto
the cell. (e.g. “Page No” textfield)

Then update PageInfo properties to the preferred Paging format.

223
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Complete thePageInfo propertiesfield as shown:

Paging Information : From the available pull -down list, select


Current Of Total option.

Paging Format : Enter {0} of {1}

7.2.6 Mapping Process Cases to Datasheet Template

The Case functionality in AVEVA Engineering 14.2, provides the capability to display “Case Names” and
associated Case data in Datasheets. The Case mechanism allows different values for the same attribute(s)
on single tag, which can be accessed as a group by specifying the Case to which they belong.

The new Case control can be accessed via the Datasheet Template Editor Standard Control window. This
control can be connected to cells that have been mapped to Case Variant Attributes. For each attribute that
the user wants to have different values per Case, a property needs to be set to ensure that Cases are
available on that attribute. This property will make the attribute a Case Variant Attribute.

If the new Data Modelling feature is being used then the “Hold multiple Case values” property of the attribute
in this example “STREAM DESCRIPTION” should have been set, as shown below.

224
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

If the new Data Modelling feature is not being used, the same property can be set directly on a user-defined
attribute (UDA) using the “Current Element Editor” in conjunction with the “Dictionary Explorer” in the
Lexicon module of AVEVA Administration 1.5. In the Current Element Editor of Lexicon, this property is
called Engineering Cases.

225
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The following worked example illustrates how to map “Case control” to a datasheet template.

7.2.7 Mapping Process Cases to Datasheet Template – A


Worked Example

Mapping a Case Control to a datasheet template allows user(s) to connect cells that have been mapped to
Case Variant Attributes. For each attribute that the user wants to have different values per Case, a property
needs to be set to ensure that Cases are available on that attribute.

Drag and drop the “Cases Control Cell” from the “Standard Controls” window onto the preferred cell, in this
example “Case Description” text field.
226
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Multiple select all the preferred mapped cells (excluding the Case Control Cell), right-click on the selected cells
and assign them to the newly created “Case Control Cell” by clicking on the appropriate “Case Control Cell”

Select the Case Control Cell to highlights the mapped cell.

 When the Case control is used in a Datasheet template, it shows the same Case Selection
control in the Datasheet instance, which provides the capability to select and display the
preferred Case Name and Case data.

Continuation Area to
Datasheet Template

The Continuation Area functionality


allows the user to specify the number of
columns and rows that are required per
sheet and if the number of objects
exceeds the expected number of
columns and rows in the datasheet
instance the application automatically
generates continuation sheets.

227
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The functionality is necessary if the number of objects expected in the datasheet instance is unknown. This is
mostly applicable to datasheets with Nozzle schedules, Process Cases and List Datasheets.

7.3.1 Continuation Area to Sublist in Datasheet Template


– A Worked Example

A “Continuation Area” can be defined in a datasheet template to hold the information related to a sub-object
of datasheet tag. However before a “Sublist-Continuation Area” is defined, the Datasheet Template
datasource (Database View Set) Column Relation [COLRELATION] definition and the object type [UDETS]
hierarchy [Owner>Member] relationship must be defined as shown below:

 Please refer to DatabaseView Chapter for more information on [COLRELATION] definition.

 Object type [UDETS] hierarchy [Owner>Member] Relationship

 Note: This was done in previous section.

After the Column Relation [COLRELATION] and the object type [UDETS] hierarchy [Owner>Member]
relationship definitions have been set up.

228
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select “Page 2” of the Datasheet Template and map the following database attributes from the
“NOZZLEVIEW” data source section of the Datasheet Template Editor window to the appropriate label text
cells as shown:

Datasheet Template label text Database Attributes

Name NAME

Bore Size BORE SIZE

Specification SPECIFICATION

Owner OWNER

Description DESCRIPTION

Select the preferred area in the template and click on the “Add Area “option from the context menu to define
the continuation area.

229
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

When the Continuation Area is added to datasheet cell, an area will be automatically defined with orange
colour in the datasheet template

Select the defined continuation area and set its properties. In this example set the ‘Add Area’ properties as
shown below:

230
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Area field: From the available pull-down list, select Continuous option.

Orientation field: From the available pull-down list, select Vertical option.

Type field: From the available pull-down list, select SubItems option.

The SubItems continuation area definition in this example will only permit the display of SubItems data in the
specified rows. However, if the Sublist data exceed the specified rows or columns, a continuation sheet will
be created automatically in the datasheet instance to display the remaining SubIltem data.

Mapping Symbols to Datasheet Template

Mapping Symbols to datasheet template label text cells are often used to indicate the information to be
completed by either “Manufacturer” or “Purchaser” in the datasheet instance.

The Datasheet Template Editor provides basic shapes, accessible via the Toolbox > Symbols window as
shown:

231
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.4.1 Mapping Symbols to Datasheet Template – A


Worked Example

To map a symbol to a label text cell, drag and drop the desired symbol to assign the shape to the label text
cell. In this example, assign the following shapes (circle, square, and triangle) to the label text cells in “Page
1 & 2” as shown.

232
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Once the symbol is assigned to the preferred label text cells, the properties of the assigned symbols can be
modified using the Properties form as shown.

233
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Alignment:

[Horizontal/Vertical] – Used to align the symbols/texts.

Appearance:

Fill State: In this example set text field to Filled via the Properties window. Alternatively click on the assigned
symbol to fill the shape.

Lock Fill State: In this example set text field to “False”.

 Setting the Lock Fill State to ‘False’ allows the end-user to update the ‘Fill State’ from the datasheet
instance

Adding Sketch Control to Datasheet Template

The Sketch control mechanism provides the capability to map process sketches to datasheet templates as
well as allowing the end-user to change the process sketches / pictures on the datasheet instance if the
picture is defined as editable in the datasheet template.

234
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.5.1 Adding Sketch Control to Datasheet Template – A


Worked Example

In this example, select the “Sketch Page” add a ‘Picture Box’ control by double clicking on the “Picture Box”
option or drag and drop the “Picture Box” option from the Standard Controls menu to the desired cell.

Select the mapped area and set its properties. Click the browse button in the “Image” field and select the
preferred picture file.

235
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The image URL can also be used to reference a picture file if required.

Set the “Is Editable” field to True to allow the end users to update the sketch/image from the datasheet
instance if required.

Then select the sketch Page in this case “Sketch Page” to define its properties such as “Sheet Type” and
Sheet Type Name.

236
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In the Sheet Type, option field: Select “Additional page” from the pull-down list.

Updating the Sheet Type from Default to “additional page” automatically display a warning dialog. Click on
the ‘Yes’ button to continue.

237
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 A Default Page is a normal page mainly used to add


Process and Mechanical information. Additional Page
gives an option to add new pages, Notes page or
Sketch Pages .

In the “Sheet Type Name”, option field: Select “Sketch Page” from the pull-down list

Additional new options have been added to the properties of a sheet in a Datasheet Template.
These options are:

Can Delete option field: Sketch page sheet type default setting is “True”

 This option has been added to the properties of a sheet in the Datasheet Template Editor, which
allows the sheet to be set as being deletable when the Datasheet Template is used to create a
Datasheet Instance. The setting allows the user to delete the pages from the Datasheet instance that
are not relevant to a particular Datasheet Instance.

238
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Can Duplicate option field: Select “True” value from the pull-down list

 This feature allows the user to create just one page in a Datasheet Templates, which can then be
repeated with in a particular Datasheet instance if, for example, a separate page is required to show
each Case on a Datasheet.

Default Print field: Select “True” value from the pull-down list.

 If “Default Print” is set to “True”, it prints the sheet


with default page properties

 If “Default Print” is set to “False”. It allows users to


define the sheet print page properties.

Adding Note Page Control to Datasheet Template

A new option “Notes Control” has been added to the “Standard Controls Tool Box” in the Datasheet
Template editor. The Notes control mechanism provides the capability to map long string UDAs types onto
the Datasheet Notes Control.

A new long string type [user-defined attributes (UDAs)]


can now be defined with no upper limit on the number of
characters that can be stored in the attribute.

This then makes the string data type suitable for the
storage of Notes directly against a tag itself; and in turn,
these attributes can be mapped onto a Datasheet
template using a Notes Control. This is illustrated in the
following worked example.

7.6.1 Adding Note Page Control to


Datasheet Template – A Worked Example

Navigate to the “Note Page” and then multi-select the


preferred area in this example Note page cells as shown:

239
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Add a ‘Note Control’


by double clicking on
the “Note Control”
option or drag and
drop the “Notes
Control” option from
the Standard
Controls menu to
the desired cell.

Drag and drop the preferred database attribute in this case “MECH COMMENT” from the Data Source group
[MECH-EQUIPMENT-FULL] onto datasheet cells with the “Note Control” mapping.

240
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The Notes control also supports continuation area in case of notes flowing over. This new feature enables
the storage of all of the information about a tag in the database and no longer making it necessary for the
Notes to have to be stored only in the Datasheet document.

 When exiting Datasheet Editor window do remember to save the template in Datasheet Editor Form and
“SaveWork” in Lexicon

Adding Front Page to Datasheet Template

A new Sheet-type option has been added to the properties of a sheet in a Datasheet Template Editor, which
allows creation of a Datasheet Front Page.

The definition of a Front Page sheet is done in the same way as existing types of additional page, by identifying
a sheet as a Front Page in a Datasheet Template.

This is then made available to a Datasheets instance for insertion in the same way as other additional pages
with the exception that, by default, it is inserted as the first page of a Datasheet instance. The following
worked example demonstrates how to define Datasheet Front Page sheet.

7.7.1 Adding Front Page to Datasheet Template – A Worked Example

In this example, navigate to the Datasheet Template “Front Page”:

241
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

First, map the relevant fields as shown:

[1] --------- Add Picture Box


[2]-----------Map [Project Description] database attribute from PROJECT_VIEW
[3]---------- Enter [PUMP PROCESS DATASHEET]
[4]-----------Map [EQUIP TYPE] database attribute from MECH-EQUIPMENT-FULL
[5]---------- Add Picture Box
[6]---------- Map [Dsno] database attribute from DS-VIEW
[7]---------- Map [Name] database attribute from MECH-EQUIPMENT-FULL

242
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Then select the Front Page tab to define its properties such as “Sheet Type”.

In the Sheet Type, option field: Select “Front Page” from the pull-down list.

Updating the Sheet Type from Default to “Front Page” automatically display a warning dialog. Click on the
‘Yes’ button to continue.

243
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Can Delete option field: select is “True” value from the pull down list

Can Duplicate option field: Select “True” value from the pull-down list.

Datasheet Revision Control Configuration

Datasheets revision control is based on Status definitions and as a result, administrator must ensure that there
is a preferred status definition that has the datasheet instance element type in its list of controlled element type

Revision Control configuration setup consists of three parts, this is illustrated below:

244
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

7.8.1 Datasheet Revision Control Configuration – A


Worked Example
This worked example illustrates how to create revision elements. To start the creation of revision elements,
select the “Workflow” tab.

Navigate to the Statuses and Revision node, select “New” from right-click menu and click on “Revision
Configuration World” option from the right-click submenu.

245
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Alternatively, the Revision Configuration World can also be created via the “New” option on the
Workflow tab context menu

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: ENGINEERING-REVISION-CONFIGURATION

 This field is not mandatory.

Click the OK button to create the Revision Configuration World.

Navigate to the Revision Configuration World, select New from right-click menu and click on “Revision
Configuration Group” option from the right-click submenu.

246
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Name: ENGINEERING-DATASHEET-REVISION-GROUP

 These fields are not mandatory


 Revision Configuration World and Revision Configuration Group are the top level containers

Click the OK button to create the Revision Configuration Group.

 Revision Number Definition

247
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Navigate to the Revision Configuration Group, select the new option from right-click menu. Click the
“Revision Number Definition” option from the right-click submenu to create a Revision Number element.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Name: ENGINEERING-DATASHEET-REVISION-NUMBER

Click the OK button to create the Revision Number Definition.

Select the newly created “Revision Number Definition”, from the right-click menu click the ‘Edit Revision
Number Definition’ option to display the “Revision Number Definition” form.

248
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Fill in the following data in the appropriate textboxes as shown.

Display Name: Revision Number

 The displayed name is a user-defined name. Users can


enter any desired name. The displayed name is not
checked for uniqueness.

Working Revision text: Enter any desired text e.g. *

 Working revision text is displayed after the revision


number on a non-issued version of a datasheet
instance e.g. A1*

 The ‘Increment at’ option provides the capability to


select the state at which the revision number will be
incremented. The available options are at the creation
of a working revision or at the issuing of a revision

249
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Number of Parts: Select the number of revision parts e.g. “2”

A revision number can have several parts. Each part is either alphabetic or numeric

Part: Select the revision part number e.g.”1”,

Part Name: Enter appropriate Part Name e.g. Major

Value type: Set the part number value type e.g. Alphabetic

Part: Select the second revision part number e.g.”2”,

• Part Name: Enter appropriate Part Name e.g.


Minor

• Value type: Set the part number value type


e.g. “Numeric”

 The Custom option provides the capability to


customise the definition of numbering
digits/letters via the Custom Values Editor
dialog

250
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the ‘Test’ button to preview the configured numbering format.

Click the OK button to save the settings

• Revision Block Definition

Navigate to the “Revision Configuration Group”, select the “New” option from the right-click menu. Click
the “Revision Block Definition” option from the right-click submenu to create a Revision Block element.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

251
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Name: ENGINEERING-DATASHEET-REVISION-BLOCK

Click the OK button to create the Revision Block Definition.

Select the newly created “Revision Block Definition”, from the right-click menu. Click the ‘Edit Revision
Number Definition’ option to display the “Revision Block Definition” form.

252
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Enter the following data in the appropriate textboxes

Display Name: Revision Block

Status definition: Status Definition for Engineering items (Datasheets)

 The displayed name is a user-defined name. Users can enter any desired name.

253
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The datasheet instance element type “DSINST” must be added to status definition list of controlled element
type.

Select the “Add attribute” option to add desired attributes to the attribute column as listed below and enter
preferred name in the “Header” column.

Attribute Header
Revision Rev No
Approved Date Date
Pending Approval User Alias Rev'ed
Approval User Alias App'ed

254
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The attributes are derived from information about


a status. The attribute drop down contains fields
for all states in the selected status definition

 Revision Configuration Definition


Navigate to the “Revision Configuration Group”, select the New option from the right-click menu. Click the
“Revision Configuration Definition” option from the right-click submenu to create a Revision Configuration
element.
.

255
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Name: REVISION-CONFIGURATION-FOR-DATASHEET

Click the OK button to create the Revision Configuration Definition.

Select the newly created “Revision Configuration”, from the right-click menu click the ‘Edit Revision Number
Definition’ option to display the “Revision Configuration Definition” form.

256
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Fill in the following data in the appropriate textboxes as shown.

Display Name: Revision Configuration for Datasheet

Element type: Select the datasheets


element type “DSINST” via the ellipsis
button.

257
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Status definition: Select the appropriate Status definition


from the pull-down list e.g. “Status Definition for engineering
items (Datasheets) ”. Associated revision block definition will
automatically be displayed.

Create working revision at: Select the appropriate Status


definition valuefrom the pull-down list e.g. “Working ”.

Issue revision at: Select the appropriate Status definition


value from the pull-down list e.g. “Approved ”.

Revision number definitions : Select the appropriate


Revision number definitionfrom the pull-down list e.g.
“Revision Number”.

Revision block definitions : R evision number definition


checkbox must be selected.

258
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The Datasheets application will list the selected revision blocks in the datasheet template explorer

Click the “OK” button from the Revision Configuration form to save the settings.

Once the revision configurations are completed, the administrator must link the revision configuration to the
datasheet template using the “Datasheet Template Settings” form as shown.

259
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Fill in the followingdata in the appropriate textboxesas shown:

Configuration : Select ‘ Revision Configuration for


Datasheet ’ from the available pull-down list.

Click the “OK” button from theDatasheet Template Settings


window to save the settings.

 The “ Bound Cell Colour ” field is used to set the Mapped


cell colour feedback in Datasheet template.

 The “Free Text Cell Colour” is used to modify or set preferred free
text cell colour feedback in Datasheet template.

 The “UDA Setting Owner” field is used to modify or set preferred User defined attribute group. This is only
applicable if auto database attribute creation is in use.

260
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 .The “UDA Setting Default Type” field is used to modify or set preferred UDA type. This is only applicable
if auto database attribute creation is in use

Mapping Revision Block and Mark to Datasheet Template

A Revision block is a block, which defines the number of columns and rows to be displayed in relation to
revision in datasheet. Revision block can be mapped to a cell by:

 Clicking on the desired revision block in the template explorer and then drag and drop onto cell.
 Selecting the cell and double click on the desired revision block in template explorer.

7.9.1 Mapping Revision Block and Mark to Datasheet


Template – A Worked Example

Open the desired datasheet template and map a revision block to datasheet template as shown:

Select the Datasheet Template e.g. “CENTRI-PUMP-DATASHEET-TEMPLATE” from right- click submenu click
“Edit Datasheet Template”.

261
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on the desired revision block in the template explorer and then drag and drop onto the preferred cell as
shown:

When a revision block is mapped to datasheet cell, an area will be automatically defined by Orange colour in
the datasheet template to hold the defined data in the revision block.

 The number of rows defined in the Revision blocks is control by the setting “Limit the number of revisions
displayed to” option in the Revision Block Definition form. In the example the value is set “3”, hence
three rows are automatically defined; when the revision block is mapped to the Datasheet Template
cells.

262
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Revision mark can also mapped to datasheet template if required, by clicking on the “Revision Mark”
option in the template explorer and then drag and drop onto desired cell.

Alternatively, select the preferred cells and then double click on the “Revision Mark” in Template Explorer.

 The “Revision Mark” is generated by the System


and is not manually configured

 Exit Datasheet Editor window


remembering to “Save” the
template in “Datasheet Editor”
Form and “SaveWork” in
Configuration Module

 After the “SaveWork”, exit the


Configuration Module

Adding Display Rules to Datasheet Template

Display rules in datasheets can also be referred to as Substitution rules. The Display rules mechanism
allows users to define and apply substitution rules on datasheet cells both at template and instance level
with the help of the rule editor.

In the Rule Editor window the user has options to select a prefix, postfix, and comment and value a condition
to display in datasheet cell. The prefix, postfix and comment values must be pre-defined as a UDLOV, via the
Dictionary Explorer / Conceptual Model.

 The “Display Rules” can also be applied to List Datasheet.

263
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The default Display Rules Configuration .xml is generated by default in the Folder>/<DFLTS>/Data folder if it
does not already exist. The user(s) can change the Prefix, Postfix and Comment values list names. The
same names should be used in the Lexicon for configuration.

 The DisplayRulesConfiguration is stored in an xml file. This can be found in the project default
folder as shown below.

In this example the DisplayRuleTextValues have been pre-defined as UDLOV, via the Conceptual Model and
instantiated in dabacon as shown the Lexicon Dictionary Explorer

The DisplayRuleTextValue e.g.(Prefix, Postfix and Comment) List definition names.must be the same name
used in the DisplayRulesConfiguration xml.

Rename the (UDLOV) definition names in the Lexicon (Dictionary Explorer) as shown. In order to align the

264
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

DisplayRuleTextValues (UDLOV) definition names in the Dictionary Explorer with the default names in the
DisplayRulesConfiguration xml

To do this; in a separate session, enter AVEVA Admin – Lexicon Module with following details:

Project – Training
Username – SYSTEM
Password – XXXXXX
MDB ----- Lexicon

 The DisplayRuleTextValue e.g.(Prefix, Postfix and Comment) list names can also be changed in the
DisplayRulesConfiguration xml.

 After the (UDLOV) definition names modification do a “SaveWork”, exit the Lexicon Module

7.10.1 Datasheets Template – Display Rules Creation – A


Worked Example

265
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

A Rule Created in a DatasheetTemplate is called an “Original rule”. Rules can be a combination of “Static
Text” (Prefix, Postfix, and Comment) and “Condition” (Operator, Value, Units) or only Text (combination of
Prefix, Postfix, and Comment values or at least any one of these).

 The Original rules are only editable in Datasheet templates


In the Configuration module do a GetWork. Then select the Libraries tab from the main menu to display the
Datasheet Explorer.

Select the datasheet template (DSTMPL) e.g. “CENTRI-PUMP-DATASHEET-TEMPLATE” from right- click
submenu click on the “Edit Datasheet Template “to display the Datasheet Editor window.

266
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The “Rule Editor” Window automatically opens in Datasheet Template Editor, If not open, we can open
from Toolbar -> Display Rule Editor

 Create a Display Rule with Static Text:


Select the mapped field for “Total Temperature” and then check the “Display Rule” checkbox in the “Rule
Editor” to enable the rule.

 The “Display Rule” option will be enabled only for


double (real) and integer type values.

A Rule can be a combination of Prefix, Postfix and Comment text or any one of these texts. Select drop down
list to select Prefix, Postfix and Comment text.

 The Drop down lists for display rules (prefix, postfix or comment text) this has been pre-configured in
section 7.10

 Users can also enter preferred text if there is no default display rules (prefix, postfix or comment text)

Once the appropriate field [i.e. Prefix, Postfix and comment text] is defined, the Preview part of the form
automatically displays the rule as shown.

267
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The “Cell Value” is data base values, which displays in Datasheet instance.)

From Prefix, Postfix and Comment values, all of these values are needed to create a rule otherwise error icon
displays.

User (s) can also create the rule, with only comment text, simply by selecting the Use Comment Only checkbox
text. Preview displays comments text only.

268
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Create Display Rule with Condition:


To create a Display Rule with “Condition”, select the “Condition” checkbox to enable the Operator and Value
and Tolerance and units.

Then complete the appropriate text fields, for example Operator, Value and Tolerance with the preferred
values.

Operator: =
Value: 60
Tolerance : 0

 The “Value” is a condition database value, which means if the cell on the datasheet instance contains
this value, the conditions gets satisfied and preview text will be displayed on the datasheet cell instead
of actual value

 The “Tolerance” field is shown only for floating point numbers and the operator selected is “=”
 The “Units” field is the unit of measures of the data base value
 Note: On the Datasheet instance, the display rule (static text) will display on the cell only, if the cell value
matches with Condition value only.

269
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Once the “Display Rule” is defined. The rule can be Disable, Enable, Remove, Copy and Paste via the
Display Rule context menu if required. These options enabled for only for DbDouble, Double and Integer
data types.

270
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 12 – Datasheet Configuration

1. In a separate session, enter AVEVA Engineering –Tags Module; as SYSTEM user, with
the following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags

2. Create a new List View based on the database view “MECH-EQUIPMENT-FULL” using the details
below:

 Category: Equip

 Category Type: Project

 List Name : Equip List

 Project Views: MECH-


EQUIPMENTFULL

4. Open the new list view “Equip List”.


Create a new-tagged item “P1501A”. In
addition, complete the following attribute
fields as shown.

271
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

5. Create a new datasheet instance and complete the appropriate fields as shown.

 For project without existing


datasheet instance, user must ensure that
the Admin User in Engineering Explorer
creates datasheet instance world (DSIWLD)
and group (DSIGRO).

272
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

6. Update the following attributes fields in the datasheet instance as shown

 Do a savework and exit AVEVA Engineering –Tags module.

273
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

List Datasheet Template Definition

The List Datasheet functionality is an extension of the existing Datasheets feature. It allows the Datasheets
functionality to be able to be used to create Lists.

This feature is based around the “Continuation Area” feature, already discussed in Datasheets Template
definition chapter, for displaying all of the records defined in the Database View that is the Data Source for a
List Datasheet.

7.11.1 List Datasheets Template Definition– A Worked


Example

The first step of creating a new list datasheet template follows the same process as creating a normal
datasheet template.

Select the created Datasheet Template Group ‘ENGINEERING-DATASHEETS-TEMPLATES-GROUP’, and


click the New Datasheet Template option from right-click menu.

The “New Datasheet Template” form is then displayed, enter the following data in the appropriate textboxes:

Name: PROCESS-LINELIST-DATASHEET-TEMPLATE

Description: PROCESS LINE LIST DATASHEET TEMPLATE

274
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Data Source: Select the browse add button , next to the Data Source field. The “Add Data Source”
dialog is then displayed. Select the preferred Database View Set “LINE-FULL” from the “Views” tab and
click on the “Add” button.

From “T emplate File ”, select the browse


button , next to the “Template File ” field
and select the preferred Excel file from the
desired location.

275
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 List Datasheets does not support multiple data sources i.e. multiple Database Views or Database View
Sets. Only single Database View as data source is currently supported

Select the Open button to update the Template File field.

 The trainer
will provide the
sample list
datasheet
template.

Click the “OK” button from the


“Ne w Datasheet Template”
dialog to Datasheet
Template Editor Dialog.

276
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “Datasheet Template Editor” window is then displayed.

The “Datasheet Template Editor” main tool bar has a new “List Type” checkbox on the top panel of
controls. The List Type checkbox which will be unchecked by default. In order to define the template as a List
Datasheet template the “List Type” check box must be checked as shown below.

The List Datasheet mappings can be made in the normal manner, using the drag-and-drop
behaviour from the selected element type.

Map the following database attributes from the “Field List” (LINE-FULL) section of the Datasheet Template
Editor dialog to the appropriate label text cell:

List Datasheet Template Cells Database Attribute


Name NAME
Size BORE SIZE
Service SERVICE
P&ID Number PID NO
Pipe Spec SPECIFICATION
277
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Fluid Phase FLUID


From FROM
To TO
Operating Pressure Min MIN OPERATING PRESS
Operating Pressure Norm NORMN OPERATING PRESS
Operating Pressure Max MAX OPERATING PRESS

List Datasheet Template Cells Database Attribute


Operating Temp Min MIN OPERATING TEMP
Operating Temp Norm NORMN OPERATING TEMP
Operating Temp Max MAX OPERATING TEMP
Design Press Min MIN DESIGN PRESS
Design Press Max MAX DESIGN PRESS
Design Temp Min MIN DESIGN TEMP
Design Temp Max MAX DESIGN TEMP
Test Medium TEST MEDIUM
Test Temp TEST TEMP
Insulation Specification INSULATION SPECIFICATION
Insulation Thickness INSULATION THICKNESS
PED Line Category PED LINE CATEGORY
PED System Category PED SYSTEM CATEGORY
Stress Critical STRESS CRITICAL
Remarks PROCESS COMMENTS
Document No INQUIRY NO

Example of mapped List Datasheet Template cells shown below.

Then add a Continuation Area where the list of Tags will be shown, to create a List Datasheet Template by
selecting the preferred area [in this example row 12-29] in the Datasheet List template.

278
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click on the “Add Area “option from the context menu to define the continuation area.

When the Continuation Area is added to datasheet cells, an area will be automatically defined with “ Peach”
“colour in the datasheet template.

 If the Continuation Area feedback colour is not visible, “Save” the template in the “Datasheet Editor”
Form and “SaveWork” in the Configuration Module

279
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Mappings inside and at the top of the Continuation Area will be propagated down in a List Datasheet,
when the instance is created in Engineering- Tags module, to show the list data.

Select the defined Continuation Area to view and modify its properties if required.

Area field: Leave as default

Orientation field: Leave as default

Type field: Leave as default

Sort Attribute Name: From the available


pulldown list, select Name attribute option.
This option is not mandatory. Only set if
required.

Sort Order: From the available pull-down


list, select Descending option. This option is
not mandatory. Only set if required.

Finally, Save the Datasheet Template Editor and Save work in the Configuration module to save the List
Datasheet Template.
280
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 List Datasheet supports the same basic functionalities as Datasheet Template such as Revision Block,
Picture Box, Unit of Measure, Page Info etc.

281
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 13– List Datasheet Configuration

Using the List Datasheet Template “PROCESS-LINELIST-DATASHEET-TEMPLATE”; which was created


section 7.11;

[1] Add the following configurations to the List Datasheet Template [Page 1]

 Add the “Revision Block” to the List Datasheet Template as highlighted

 Add the “Unit of Measure” controls to the highlighted cells and assign the appropriate mapped cells
to the “Unit of Measure” control

 Add the “Picture Box” control to the cells highlighted and map the preferred images such as
company logos to the cells

282
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
 Add the “Page Info ” control to the cellhighlighted and define the
Paging Information as shown

[2] Navigate to the List Datasheet Template [Front Page] and add the following configurations:

 Define the Sheet Type, in this example the “Sheet Type” textfield is set to “Front Page”

www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Add the Picture Box [Company logo] and Revision Block as highlighted

CHAPTER 8

8 Project Explorer Configuration


The engineering Project explorer is a configurable user interface based on the AVEVA Flexible explorer
tool.

This interface allows the presentation of engineering items structured according to functional locations or any
other user defined structure formats. These structure formats are displayed in a hierarchical form within the
AVEVA Engineering Tags application.

Each structure is based on a template, which is also defined as a ‘Root Node’. Further nodes can be built
beneath the root node. Templates and their contents are represented as individual hierarchies within the
Project Explorer. Every template is configured to be primarily based on a type of data, e.g. Systems,
Classes, and Documents or as a Project BreakDown Structure (PBS). Unlike a conventional tree view
explorer, the Project explorer has a dynamically active hierarchical structure. This means that the location of
items will be dependent on the current set criteria and attribute values.

The Project explorer is fully configurable and setup within the LEXICON/CONFIGURATION module this is
demonstrated in this chapter.

284
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Copyright ©2015.
249
Flexible Explorer Configuration Structure

Using the Flexible explorer tool the Project Explorer can be configured according to the LEXICON/
CONFIGURATION elements structure shown:

Each block on the diagram is defined as shown:

www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

PBS Templates world:


PBSWLD
The top-level administrative element, which
holds the PBS Templates.

PBS Template Definition:


This is a definition of separate hierarchy structure and is presented
PBSTPL as a single root node

PBS Object Node:


Used to define the generation of a set of nodes at the hierarchical
PBSOBN level it is placed. The nodes and their inherented members will be
dynamically updated when the attributes or criteria of related
database objects are modified

PBS Text Node:


This is simply a generating node, and does not represent any database
PBSTXN object. However, they can contain PBSOBNs

PBS Criteria:
This element is used to position resulting nodes below appropriate/required
PBSCRT parent nodes

286
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Flexible Explorer Configuration without Reference to External PML Functions Files – A

Worked Example

The demonstration in the following examples covers the creation and definition of the dictionary elements for
a demo project explorer. This explorer will be developed and structured to display hierarchies for Engineering
Classes and Document Based Project BreakDown structure (PBS).

 This Flexible Explorer Configuration example is based on basic PML 1 expressions; there is no reference
to external pml function files.

8.2.1 Create a PBS World (PBSWLD) – Worked Example

The PBS World (PBSWLD) is the top-level administrative element, which holds the PBS Templates

Select the topmost element in the Structure Explorer (Project Breakdown Structure), click the ‘New’ from
the right-click menu and click on ‘Template World’ option from the right-click submenu.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: ENGINEERING-PROJECT-EXPLORER

 This fields is not mandatory

287
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the OK button to create the Template World.

Within the Current Element Editor, fill in the Description attribute of the created PBS world as shown.

Description: Project Explorer World for Engineering

288
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

8.2.2 Create a PBS Template (PBSTPL) – Worked


Example

The PBS Template (PBSTPL) is a definition of separate hierarchy structure and is presented as a single root
node

Select the created PBS World, display the context menu and click ‘Template Definition’ to create PBS
Template definition.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: DOCUMENT-TEMPLATE

Click the OK button to create the Template Definition’.

289
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 The ‘Flexible Explorer Text’ entry specifies the text to be displayed on the created template, like a
node name

 The ‘Flexible Explorer Sorting’ entry specifies the order in which items generated from nodes
beneath the root node/template will be placed. This is set to ‘Natural Alpha Numeric’, which is
selected from the pick list. Hence, items will be sorted alphabetically

 The ‘Flexible Explorer Context menu’ text field provides the capability to reference desired
context menu for the template node. A further example of this function will be demonstrated later in
this chapter

 Each node and items on the Flexible Explorer interface can have an icon displayed next to its text.
The ‘Flexible Explorer Icon’ entry specifies what icon is to be displayed by typing in the icon name
(as this must already exist in the Shared Resources location) or can be derived with a PML 1
expression

Within the Current Element Editor, fill in the attribute details of the created PBSTPL as shown.

Flexible Explorer Text : Document-based Structure

Flexible Explorer Text : Natural Alpha Numeric

290
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The definitions can be previewed be selecting the Structure “Preview Explorer” tab as shown:

291
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

8.2.3 Create a PBS Text Node (PBSTXN) – Worked


Example

The PBS Template-Object Text Node (PBSTXN) is used to a generate node, and does not represent any
database object. However, they can contain PBSOBNs.

Define a PBS Text Node to specify what text should be displayed on nodes generated by the PBS Object.

Select the created PBS Template, display the context menu and click ‘New’ > ‘Text Node’ to create PBS
TextNode.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: Document-TextNode-1

Click the OK button to create the Text Node.

292
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Within the Current Element Editor, fill in the attribute details of the created Text Node as shown.

- Flexible Explorer Formula Type: The ‘Flexible Explorer formula type’ entry is set to ‘Static text’

- Flexible Explorer Formula: For the ‘Flexible formula entry’, enter: ‘Engineering Classes’

- Flexible Explorer Context Menu: For the ‘Flexible Explorer Context Menu’ entry, enter:
‘AVEVA.PBS.TAGS_Class.Menu’

The definitions can be previewed be selecting the Structure “Preview Explorer” tab as shown:

293
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

8.2.4 Create a PBS Object Node (PBSOBN) – Worked


Example

The PBS Object Node (PBSOBN) is used to define the generation of a set of nodes at the hierarchical level it
is placed. The nodes and their inherited members will be dynamically updated when the attributes or criteria
of related database objects are modified.

Select the created PBS Text Node [Document-TextNode-1], display the context menu and click ‘New’ >
‘Object Node’ to create PBS Object Node.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: Document-Class-ObjectNode-01

294
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the OK button to create the ‘Object Node’.

Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.

- For the ‘‘Flexible Explorer Text’ field: Enter: NAMN

- For the ‘Flexible Formula’ text field’: Enter: coll all :Equipment’

- For the ‘Flexible Explorer Group By’ text field’: Enter: :EquipClass

295
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The definitions can be previewed be selecting the Structure “Preview Explorer” tab as shown:

In order to view the result of the newly created the definition [PBS Object Node (PBSOBN)] an “Equipment”
item instance data should be created in AVEVA Engineering- Tags module.

In a separate session,enter AVEVA Engineering –Tags Module with the following details: Username:
SYSTEM; Password: XXXXXX; MDB: A-Tags

• Create a new “List View” based on “MECH-EQUIPMENT-FULL” database view


• Create a new “Equipment” item instance data as shown.

296
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exit AVEVA Engineering –Tags module.

Previously defined PBS Object Node can be extended to generate a node to group and hold documents
items such as Datasheets items.

To do this, re-enter previously opened session of AVEVA Engineering -Configuration Module and conduct
a GetWork.

Select the created PBS Object Node [Document-Class-ObjectNode-01], display the context menu and click
‘New’ > ‘Text Node’ to create PBS Text Node.

297
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: Document-TextNode-01-1

Click the OK button to create the Text Node.

Within the Current Element Editor, fill in the attribute details of the created ‘Text Node as shown:

Flexible Explorer Formula Type: The ‘Flexible Explorer formula type’ entry is set to ‘Static text’

- Flexible Explorer Formula: For the ‘Flexible formula entry’, enter: ‘Datasheets’

298
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

The definitions can be previewed be selecting the Structure “Preview Explorer” tab as shown:

The next step is to create a new PBS Object Node (PBSOBN) item, which will generate/collect all the
Datasheets items according to their element types.

299
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Select the created PBS Text Node [Document-TextNode-01-1], display the context menu and click
‘New’ > ‘Object Node’ to create PBS Text Node.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: Datasheet-ObjectNode-01-1_2

300
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Click the OK button to create theObject Node.

Within the Current Element Editor, fill in the attribute details of the created ‘Text Node as shown:

- For the ‘‘Flexible Explorer Text’ field : Enter: ‘NAMN’

- For the ‘Flexible Formula’ text field’: Enter: ‘Collect all DSINST

In order to view the result of the newly created the definition [PBS Object Node (PBSOBN)] a datasheet
instance should be created in AVEVA Engineering- Tags module.

In a separate session, enter AVEVA Engineering –Tags module with the following details: Username:
SYSTEM; Password: XXXXXX; MDB: A-Tags.

301
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

• Open the Equip List view


• Select the previously created tagged item in this P-C-788 and create a new datasheet instance

Exit AVEVA Engineering –Tags module.

8.2.5 Create a PBS Criteria Node – A Worked Example

The next step is to define “PBS Criteria” element; which ensures that a given node fits to a specific parent
hierarchy.

 This means that when items are created, the criteria element will help determine enforce the placement

of these items within the appropriate node.  The PBS Criteria” element is used to position resulting nodes
below appropriate/required parent nodes.

Re-enter previously opened session of AVEVA Engineering -Configuration Module and conduct a
GetWork.

 Using the PBSOBN definition [Datasheet-ObjectNode-01-1_2] in section 8.3.3 as a starting point.


Define the “PBS Criteria” element; which ensures that a given node fits to a specific parent hierarchy.

302
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 Select the last created PBS Object Node [Datasheet-ObjectNode-01-1_2], display the context menu
and click ‘NEW’ > ‘PBS Criteria’ to create a PBS Criteria.

The “New” form is then displayed; enter the following data in the appropriate textboxes:

Enter Display Name: Filter-Datasheet-Criteria

Click the OK button to create the ‘Criteria Node’.

303
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Within the Current Element Editor, fill in the attribute details of the created ‘Text Node as shown:

- For the ‘‘Flexible Explorer Formular Type’ text field : Select ‘Attribute’ from the available option

- For the ‘Flexible Formula’ text field’: Enter/Select ‘DSIAST’ [Datasheet Instance assigned tags
reference array for Datasheet Instance] from the available option

For the ‘Flexible Explorer Query Node’ text field : Select ‘Document-Class-ObjectNode-01’ from the
available option

The definitions can be previewed be selecting the Structure “Preview Explorer” tab as shown:

304
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 In the screenshot shown above, the datasheets instance is displayed beneath the Datasheet folder for
specific tagged item. If there are more than one tagged items a Datasheet folder with associated
datasheets instances will be created for each tagged item.

Exercise 14 – Flexible Explorer Configuration

In order to create the PBS definitions required for this training, run the macro “Flexible Explorer
Definitions.txt’’ provided by the trainer.

305
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

 This PBS definition is based on the following pml functions files. These pml functions files will be
provided by the Trainer

 getAreasForSystemACE.pmlfnc

 getEngineeringClassesACE.pmlfnc

 getSubSystemsACE.pmlfnc

306
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

307
Copyright © 2014 www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 9

9 AutoNaming Engineering items


AutoNaming allows for automated / dynamic selection of appropriate names for engineering items when
they are created or renamed. These names can be in a sequential format, can be placed in several patterns
and are rule based.
AutoNaming Feature

Within the Configuration module, the AutoNaming feature can be reached from the ‘Rules’ tab.

Click on the ‘AutoNaming Setup’ button to display the ‘Naming Settings’ form which allows for controlling
the use of the AutoNaming function in a session.

AutoNaming actions can be switched On or Off with the ‘Auto Naming On/Off’ checkbox, and
AutoNaming rules can be managed through the ‘Define Naming Rules’ button.

The ‘Naming Mode’ group allows for the selection of required behaviours for sequential indexed naming.
‘Infill’ indicates that the any available index number will be used to name an element.
‘Append’ indicates that elements will be named using increasing index numbers.

The ‘Load’ and ‘Save’ buttons are used when defined naming rules are to be saved or loaded from the
Naming rules file.

 The user will need to be an ADMIN user, or a member of the Tags ADMIN team, in order to view and
access the Rules tab
www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Copyright ©2015.
267

 The use of ‘Auto Naming’ Rules configuration overrides any existing ‘Creation Rules’ already in
place.

9.1.1 AutoNaming Configuration Setup – A Worked


Example

On the ‘Naming Settings’ form, ‘Click on the ‘Define Naming Rules’ label button to display the ‘Naming
Rules’ form.

This form allows for the creation of rules to


generate and control the behaviour of the
AutoNaming actions.

Before the naming rules can be defined, ensure


that the appropriate Element rules exist. Click on
the ‘Element Rules…’ button to display the
‘Define Rules’ form.

309
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

This form allows for the definition of the conditions (Element Rules) with which the naming rules must follow.
In other words, this form specifies the items, which the naming rule(s) will be applicable .

The ‘Location’ dropdown allows for the saving and loading of element rules file from the appropriate rules
folders.

Each location entry specifies the possible folder/path to be utilised to save a newly defined rule:

‘User’ indicates that the rules will be stored in the ‘C:\Users\Public\Documents\AVEVA\USERDATA’


directory.

‘Project’ indicates that the rules will be stored in the


‘C:\Users\Public\Documents\AVEVA\Projects\E3D2.1\Training\tradflts’ project location.

‘Default’ indicates that the rules will be stored in the


‘C:\Users\Public\Documents\AVEVA\Engineering\Data14.2.0\DFLTS’ directory.

In this example, select the ‘User’ location, and fill in the details as shown, then click the ‘Include’ button.

310
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Location – User

Name – ALLITEMS

Types –ENGITE

Description– AUTO NAMING FOR ALL ITEMS

The Include button places the name of the element rule in the ‘Defined’ list. It is added in the “Defined” area
beneath the ‘User Defined Rules’ group.

Click the ‘Apply’ and then ‘Cancel’ buttons to return to the ‘Naming Rules’ form.

On the ‘Naming Rules’ form, fill in the details as shown:

Key – SYSTEM

Scan Level – WORL

Rule Name –ALLITEMS

Description– AUTONAMING FOR


ENGINEERING ITEMS
311
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Format – ‘ITEM-‘& !index


Indices – 0000

The ‘Scan Level’ indicates the scope of the AutoNaming actions. In this case, all applicable items created
beneath the World level will be Autonamed.

The ‘Rule Name’ entry is selected by clicking on the arrow button


next to the entry. This brings up a form listing available
conditions/Element rules, which this naming rule will apply to.

The ‘Format’ is an expression, which will control the pattern of the generated names. The ‘Indices’ is the
parameter for including numbering character in the generated name.

After filling in the details, click the ‘Insert


button to place the created naming rule in
the Data Display key list, and also view a
summary on the Data section

Rules in the Data Display key list can be


Cut, Copied, and Replaced using the
buttons, as part of rules management activities.

312
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Test the defined rules by selecting an engineering item on a list, and clicking the ‘Test’ button, to display a
sample of how the generated autoname will appear. Click the ‘OK’ button to return to the ‘Naming settings’
form.

On the ‘Naming Settings’ form, select File > Save to save the rules, then check the ‘Auto Naming On/Off’
checkbox, to turn the naming rule on. Click the ‘OK’ button.

313
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

In order to apply the newly defined “AutoNaming” configuration. Enter AVEVA Engineering –Tags Module;
with the following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags and create a tagged
item.

The screenshot below, shows tagged items, that were previously created in AVEVA Engineering –Tags
module.

Create 2 new Mechanical equipment items, and observe their auto generated names.

Create 2 new Electrical equipment items, and observe their auto generated names.

314
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Finally create 2 new Line items, and observe their auto generated names.

 The created rule being utilised applies to all Engineering items (ENGITEs) and will apply the naming
structure to all engineering elements

Any created item with the ENGITE basetype, will be autonamed, using the configured naming rule.

 Do a savework and exit AVEVA Engineering –Tags module

9.1.2 AutoNaming Configuration Setup with Rule


Definition – A Worked Example
Re-enter Engineering-Configuration module; with the following details: Username: SYSTEM; Password:
XXXXXX; MDB: A-Tags.

If the Engineering-Configuration module previously


opened, do not re-enter the application, simply proceed
with the following steps.

Create an Element rule with the following details as


shown.

Enter the rule expression as shown, as this will set the


element condition for the naming rule to apply to Line
items only.

315
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Select the newly created element rule for the ‘Rule Name’ within the ‘Naming Rules’ form as shown:

Create a “Naming Rule”, ensuring to fill in the details as shown.

Key – LINES

Scan Level – WORL

Rule Name –LINE ITEMS

Description– AUTONAMING FOR LINE ITEMS ONLY

Format – ‘Line-D-‘& !index

316
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Indices – 00

In order to apply the newly defined “AutoNaming” configuration. Enter AVEVA Engineering –Tags Module
with the following details: Username: SYSTEM; Password: XXXXXX; MDB: A-Tags and create the tagged
item instance data.

The screenshot below, shows previously created tagged items in AVEVA Engineering –Tags module.

Create 2 new Line items, and observe their auto generated names.

317
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

New items of other element types will continue to be autonamed with the previous naming rule setup earlier,
as that still applies to ENGITEs without the extra element rule condition for LINEs.

9.1.3 AutoNaming Configuration with Condition based Rule


– A Worked Example

Re-enter Engineering-Configuration module, with the following details; Username: SYSTEM; Password:
XXXXXX; MDB: A-Tags.

Autonaming rule for Mechanical equipment:

First, define the “Element Rule” using the data below:

318
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Location: Project

Name: Mechanical Equipment


rule

Type: ENGITE

Rule: Acttype eq ':EQUIPMENT'


and NAME of OWNER eq
'/Mechanical-Items'

Description: Autonaming for


Mechanical equipment

Then define the “Name Rule” as shown:

Key – MECHANICAL EQUIP NAMING


RULE

Scan Level – WORL

Rule Name – MECHANICAL


EQUIPMENT RULE

Description– AUTO NAMING FOR


MENCHANICAL EQUIPMENT

Format – :Prefix+’-+:Tagletter+’-
‘+:TagNumber

This rule applies to items element types (:EQUIPMENT) whose database owner is an ENGGRP named:
‘Mechanical-Items’.

319
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Exercise 15– AutoNaming Definition

1. Delete the naming and element rules created during the exercise

2. Have the ‘Auto Naming’ turned ‘ON’

3. Switch to the ‘Infill’ Naming Mode and save rules in the ‘User’ Location

4. Create an element rule which applies to all engineering items

5. Create a naming rule with the format 'ENGITE-' & !Index & 'B'

6. Create 2 items each, of Line items, Mechanical equipment and Electrical equipment

7. Create an element rule which applies to instrument tags only, using the rule expression: ActType
EQ ‘:INSTRUMENT’

8. Create an element rule which applies to valve tags only, using the rule expression: Owner EQ
( ID /Valve-items )

Create naming rules with the above element rules, and observe the AutoNaming on newly created
applicable items

320
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Appendix A

10 Appendix A
Syntax 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

321
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
The existing Q ATT has 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

Copyright ©2015.
278
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 attributes 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
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

323
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Pseudo Attributes Associated with Distributed


Attribute Syntax

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 the 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 the 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 the 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

XRQCNT - Count of Distributed Attributes Member Associated

The attribute returns the number of distributed attribute members (elements) associated with the current
element. The attribute may take an optional qualifier on typename.

324
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

Example:

Q XRQCNT
XRQCNT 2

Q XRQCNT (TYPENAME :PROCESS )


XRQCNT 1

XRQELE - Return a Single Distributed Attribute Member

The attribute returns a specified distributed attributes member of distributed attribute members (elements)
associated with the 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 attributes 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 a 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
325
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
AVEVA Engineering (14.2)
Engineering Administration (TM-3652)

the ID value held in the DHTEXT attribute of the resulting DSXDST. The CE is passed to the expression for
evaluation.

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 from the evaluation of 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 Syntax, please refer to Database Management Reference Manual.

326
Copyright © 2014AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Appendix B

11 Appendix B

Version Control Configuration (VERCON)

If VERCON object is given a user-preferred name, the Engineering Configuration World (ENGCWL) object
must be created and configured in order to utilise the Version control configuration within the Engineering
Tags application.

For example If the ‘VERCON’ object has a user preferred name e.g. ‘TagsVercon’ instead of the default
name ‘Tags’.

The Administrator is required to create an Engineering Configuration World (ENGCWL) object and
configured the COR Configuration field as shown.

Select the newly created ENGCWL object and Configured the COR Configuration field by entering the
VERCON object name in this case ‘/TagsVercon’ via the ‘String Collection Editor’ dialog.

www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering

Copyright ©2015.
283
(14.2)
Engineering Administration (TM-3652)

www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
284 Copyright
© 2014

www.aveva.com
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like