TM-1860 AVEVA Administration (1.4) Fundamentals Rev 2.0

Training TM-1860
AVEVA Administration
Guide Adminstration Fundamentals
1
AVEVA Administration (1.4)
TM-1860 AVEVA Administration Fundamentals
This page is intentionally left blank.
2
Copyright © 2015.
AVEVA Solutions Limited and its subsidiaries.
www.aveva.com
All rights reserved.
Revision Log
Date Rev Description Author Reviewed Approved
19/10/15 0.1 Issued for Review WR

16/11/15 0.2 Reviewed WR SK/MB
26/11/15 1.0 Approved for Training AVEVA Administration 1.4 WR SK/MB KB
Page 45 Cross Product database name changed
from ScGroup Name to CMTWLD
06/01/16 1.1 Chapter 9 moved to after chapter 18, chapters WR
and exercises renumberd accordingly
Page 147 Note added for displaying Valid values
18/01/16 2.0 Approved for Training AVEVA Administration 1.4 WR KB
Updates
Change highlighting will be employed for all revisions. Where new or changed information is presented section
headings will be highlighted in Yellow.
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 © 2015.
www.aveva.com
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.
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 2015
Trademark Notice
AVEVA™, AVEVA Everything3D™, AVEVA E3D™, [AVEVA Tags], 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 trademark is strictly forbidden.
All other trademarks belong to their respective owners and cannot be used without the permission of the owner.
4
Copyright © 2015.
www.aveva.com
CONTENTS
1 Introduction ............................................................................................................................ 9
Aim...................................................................................................................................................... 9
Objectives .......................................................................................................................................... 9
Prerequisites...................................................................................................................................... 9
Course Structure ............................................................................................................................... 9
Using this guide ................................................................................................................................ 9
2 Project Creation.................................................................................................................... 11
Project Creation Wizard – A Worked Example............................................................................. 11
Project Structure ............................................................................................................................. 13
AVEVA Environment Variables...................................................................................................... 14
2.3.1 The Evars Batch File.................................................................................................................. 14
2.3.2 Environment Variable ‘AVEVA_DESIGN_WORK’..................................................................... 14
2.3.3 Environment Variable ‘AVEVA_DESIGN_USER’ ...................................................................... 15
2.3.4 Environment Variable ‘PMLUI’ ................................................................................................... 15
2.3.5 Environment Variable ‘PMLLIB’ ................................................................................................. 15
2.3.6 Serialisation Files ....................................................................................................................... 15
3 AVEVA Projects .................................................................................................................... 17
AVEVA Product Structure .............................................................................................................. 17
AVEVA Administration ................................................................................................................... 17
3.2.1 Admin ......................................................................................................................................... 17
3.2.2 Lexicon....................................................................................................................................... 18
Typical AVEVA Project Design Teams.......................................................................................... 18
Typical Project Databases.............................................................................................................. 20
3.4.1 Typical 3D Design Databases.................................................................................................... 21
3.4.2 Typical 2D Drawing Databases.................................................................................................. 21
3.4.3 Specialist Project Databases ..................................................................................................... 21
Sharing Data between Projects ..................................................................................................... 22
4 Project Access...................................................................................................................... 23
Project Access................................................................................................................................. 23
Modifying Project Environment Variables.................................................................................... 25
5 Teams and Users.................................................................................................................. 27
Starting in Admin ............................................................................................................................ 27
Teams, Users and Database Names.............................................................................................. 28
Admin Elements Form .................................................................................................................... 29
Creating Teams and Users – A Worked Example ........................................................................ 30
5.4.1 Modifying Users ......................................................................................................................... 32
5.4.2 Reset Password ......................................................................................................................... 32
5.4.3 Copy User .................................................................................................................................. 33
Exercise 1 – Creating Teams and Users.................................................................................... 34
6 Databases ............................................................................................................................. 37
Database types ................................................................................................................................ 37
6.1.1 Administration Databases .......................................................................................................... 37
6.1.2 Model Databases ....................................................................................................................... 38
6.1.3 Controlled Databases ................................................................................................................ 38
6.1.4 Design Reference Databases .................................................................................................... 39
6.1.5 Protected Databases ................................................................................................................. 39
Database Access Mode .................................................................................................................. 39
6.2.1 Claim Mode ................................................................................................................................ 40
Multiwrite Databases ...................................................................................................................... 40
Area Number.................................................................................................................................... 40
Database Number............................................................................................................................ 40
File Number...................................................................................................................................... 41
Deleting Databases ......................................................................................................................... 41
5
Copying Databases ......................................................................................................................... 41

Modifying Databases ...................................................................................................................... 41
Configuring the Admin Elements Form .................................................................................... 42
Creating Databases - A Worked Example ................................................................................. 43
6.11.1 Design Databases...................................................................................................................... 43
6.11.2 Catalogue Databases ................................................................................................................ 44
Exercise 2 – Creating Databases ............................................................................................... 45
Foreign Databases ..................................................................................................................................... 46
Including and Copying Foreign Databases .............................................................................. 46
Including Foreign Databases - A Worked Example ................................................................. 47
Copying a Foreign Database – A Worked Example ................................................................. 49
Database Sets .............................................................................................................................. 49
Creating a DB Set - A Worked Example .................................................................................... 50
Exercise 3 – Copying Foreign database & Database set creation........................................... 52
7 Multiple Databases (MDBs).................................................................................................. 53
MDB Overview ................................................................................................................................. 53
Database Order in the MDB............................................................................................................ 53
Creating MDBs – A Worked Example............................................................................................ 54
Exercise 4 – Creating MDBs....................................................................................................... 57
8 Inter Databases References................................................................................................. 59
Design Connection References ..................................................................................................... 59
Inter-Database Macros – A Worked Example............................................................................... 60
8.2.1 Creating an Inter-Database Macro ............................................................................................ 60
8.2.2 Checking and Processing Inter-Database Macros .................................................................... 62
Exercise 5 – Inter Database Macros .......................................................................................... 63
9 Multiwrite Databases............................................................................................................ 65
Use of Multiwrite Databases .......................................................................................................... 65
Working with Multiwrite Databases – A Worked Example.......................................................... 65
Claim Lists ....................................................................................................................................... 69
10 Database Stamps .............................................................................................................. 71
Creating Date Stamps ................................................................................................................. 71
Creating Date Stamps – A Worked Example ............................................................................ 72
Exercise 6 – Date Stamps........................................................................................................... 74
11 Project Setup Excel Import/Export................................................................................... 75
Export to Excel – A Worked Example........................................................................................ 75
Admin Excel Spreadsheet .......................................................................................................... 76
11.2.1 Admin Excel Spreadsheet – Teams .......................................................................................... 76
11.2.2 Admin Excel Spreadsheet - Users ............................................................................................. 76
11.2.3 Admin Excel Spreadsheet – NT Authenticated Users ............................................................... 77
11.2.4 Admin Excel Spreadsheet – Databases .................................................................................... 77
11.2.5 Admin Excel Spreadsheet – Included Foreign Databases ........................................................ 78
11.2.6 Admin Excel Spreadsheet – Multiple Database......................................................................... 79
Admin Import from Excel – A Worked Example ....................................................................... 79
11.3.1 Selecting an MDB for User Defined Data .................................................................................. 81
Admin Database Rollback – A Worked Example...................................................................... 81
Exercise 7 – Excel Expport and Import ..................................................................................... 83
12 Miscellaneous Administration Functions ........................................................................ 85
Querying User Details ................................................................................................................. 85
Querying Database Details ......................................................................................................... 86
Project Information...................................................................................................................... 89
Changing Passwords .................................................................................................................. 89
Locking Projects.......................................................................................................................... 90
Expunging Users ......................................................................................................................... 91
Session Comments ..................................................................................................................... 92
6
Copyright © 2015.
www.aveva.com
User Messages ............................................................................................................................ 92

Exiting the Admin Module .......................................................................................................... 92
The Global Explorer .................................................................................................................... 92
Module Definitions ...................................................................................................................... 92
12.11.1 The Module Definition Form ................................................................................................... 93
Backtrack Changes ..................................................................................................................... 94
Merge Changes ............................................................................................................................ 95
Font Families................................................................................................................................ 96
12.14.1 Character Sets ....................................................................................................................... 96
12.14.2 Character Styles ..................................................................................................................... 97
12.14.3 User-defined Fonts ................................................................................................................. 97
12.14.4 Sloping Fonts ......................................................................................................................... 97
12.14.5 Configuring Font Families ...................................................................................................... 98
True Type Fonts........................................................................................................................... 98
Draw and True Type Fonts ......................................................................................................... 99
Isodraft and True Type Fonts ................................................................................................... 100
Draft Line Widths ....................................................................................................................... 101
12.18.1 Draft Line Widths – A Worked Example............................................................................... 101
Replicating Project .................................................................................................................... 102
12.19.1 Replicate Project Data – A Worked Example....................................................................... 102
12.19.2 Replicate Project Structure – A Worked Example................................................................ 102
13 Overview of the Lexicon Module.................................................................................... 105
Entering Lexicon ....................................................................................................................... 105
Data Hierarchy and Element Types ......................................................................................... 106
User-Defined Attributes ............................................................................................................ 107
13.3.1 User System Defined Attributes............................................................................................... 107
13.3.2 User- Defined Element Types.................................................................................................. 107
13.3.3 Status Definitions and Values .................................................................................................. 107
13.3.4 Database Views ....................................................................................................................... 108
Features of the Lexicon User Interface ................................................................................... 108
The Lexicon Menu ..................................................................................................................... 109
The HOME tab ............................................................................................................................ 109
13.6.1 Create ...................................................................................................................................... 109
13.6.2 Modify....................................................................................................................................... 110
13.6.3 Check ....................................................................................................................................... 110
13.6.4 Search...................................................................................................................................... 111
13.6.5 Comment.................................................................................................................................. 111
The TOOLS tab .......................................................................................................................... 111
13.7.1 Display ..................................................................................................................................... 112
13.7.2 Explorers .................................................................................................................................. 112
The MANAGE Tab...................................................................................................................... 113
13.8.1 History ...................................................................................................................................... 114
13.8.2 Access...................................................................................................................................... 114
13.8.3 Pipe Stress Interface................................................................................................................ 114
13.8.4 Schematic Model Manager ...................................................................................................... 115
The ENGINEERING tab.............................................................................................................. 115
Current Element Editor ............................................................................................................. 116
Exercise 8 – Exploring the Lexicon UI..................................................................................... 117
14 User Defined Attributes .................................................................................................. 119
UDA Hierarchy ........................................................................................................................... 119
UDA Fields (Current Element Editor) ...................................................................................... 120
14.2.1 General .................................................................................................................................... 120
14.2.2 Basic Definition ........................................................................................................................ 121
14.2.3 Presentation ............................................................................................................................. 123
14.2.4 Protection ................................................................................................................................. 124
14.2.5 Design ...................................................................................................................................... 124
14.2.6 Miscellaneous .......................................................................................................................... 124
Creating User- Defined Attributes – A Worked Example....................................................... 125
14.3.1 Setting up the Training Environment ....................................................................................... 125
14.3.2 Creating a UDA World (UWRL) ............................................................................................... 125
7
Copyright © 2015.
www.aveva.com
14.3.3 Creating a UDA Group (UGRO)............................................................................................... 126

14.3.4 Creating a User Defined Attribute ............................................................................................ 126
Exercise 9 - Creating and Using UDAs .................................................................................... 130
15 User System Defined Attributes..................................................................................... 131
USDA Hierarchy......................................................................................................................... 131
USDA Definition ......................................................................................................................... 131
15.2.1 USDA Limits and Valid Values................................................................................................. 132
Creating a USDA – A Worked Example ................................................................................... 132
Exercise 10 - Creating and Using USDAs................................................................................ 136
16 User Defined Element Type ............................................................................................ 137
UDET Hierarchy ......................................................................................................................... 137
16.1.1 Basic Definition ........................................................................................................................ 138
16.1.2 UDET Hierarchy....................................................................................................................... 138
Creating a User- Defined Element Type (UDET) – A Worked Example ................................ 139
16.2.1 Creating a UDET Element World (UDETWL) .......................................................................... 139
16.2.2 Creating a UDET Group (UDETGR) ........................................................................................ 140
16.2.3 Creating a User Defined Element Type (UDET)...................................................................... 140
Exercise 11 - Creating and Using UDET’s ............................................................................... 142
17 Configure Comment Databases ..................................................................................... 143
UDA’s on Comment Threads.................................................................................................... 146
17.3.1 Adding a User Defined Attributes to a Comment Thread – A Worked Example ..................... 146
17.3.2 Testing Comment UDA’s in Model........................................................................................... 148
18 Adding Comments In Model ........................................................................................... 151
Adding Comments – A Worked Example............................................................................... 151
18.1.1 Adding Captured Images and Attachements ........................................................................... 153
Filtering Comments................................................................................................................... 154
Comment Highlighting .............................................................................................................. 154
Exercise 12 - Comments........................................................................................................... 156
8
Copyright © 2015.
www.aveva.com
CHAPTER 1
1 Introduction
Aim
Over the duration of the course the Trainee will be given a basic understanding of how to administer an AVEVA
Everything3D™ (AVEVA E3D™) project.
Objectives
 Set up new AVEVA Plant Projects, including databases access control.
 Administer projects, including change management and setting AVEVA E3D fonts.
 Control User access to various AVEVA Plant product modules.
 Create and use User- Defined Attributes (UDA’s), User System Defined Attributes (USDA’s), and
User- Defined Element Types (UDET’s).
Prerequisites
Trainees should be familiar with AVEVA Everything3D, AVEVA Catalogue and Microsoft Windows 7.
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.
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
This page is intentionally blank.
10
Copyright © 2015.
www.aveva.com
CHAPTER 2
2 Project Creation
This chapter explains how to create a new AVEVA Project.
Project Creation Wizard – A Worked Example
AVEVA Projects are created using the Project Creation Wizard. This utility enables the creation of the project
structure and the associated environment variable batch files.
Select Start > All Programs > AVEVA > Manage > Project Creation Wizard 1.4.0 or alternatively by clicking
the New Project button from the AVEVA Administration Login form.
This displays the Project Creation Wizard form .
The Project textbox enables the user to enter a project name, up to a maximum of 8 characters. Enter Training
in the textbox. As the project identifier is entered it is appended to the end of the entry in the Address textbox.
A folder will be created with the project name at the specified address.
The Code textbox enables the user to enter a 3-letter project code. Enter TAD in the textbox.
The Address textbox specifies the path to where the newly created project will be stored. By default it is
automatically populated with the default project path as specified in evars.bat/evars.init and the project
identifier is appended to it, however, a different address, such as network location may be entered manually.
Clicking the Browse button displays the Browse For Folder form which enables a pre-existing folder to be
selected.
Set the address to C:\Users\Public\Documents\AVEVA\Projects\E3D2.1\Training.

Click the Project Variables… button to display the Project Variables form.
11
The upper frame of the form displays the address of the project folder and a list of project variables for which
environment variables will be created in the project batch file. The checkboxes enable the variable creation to
be toggled on and off.
The lower part of the form enables additional folders to be created for the project so that the project can be
split across different file locations. Clicking the Extra Project Areas counter makes an entry in the list below
showing the variables together with the folders that will be created.
Right clicking on a list entry displays a

Browse… sub-menu which, when clicked,
displays the Browse For Folder form to
enable a pre-existing folder to be selected.
For the purposes of the training, only the main project area is required. Ensure the Extra Project Areas is set
to 0 and click the OK button to enter the data and dismiss the form.
Click the Existing Projects… button to display the Existing Projects form:
The form displays all of the projects for which there are environment variables in the custom_evars.bat file.
The options list and checkbox at the top of the form enable the list to be filtered on Project Name or Code.
Click the Cancel button to dismiss the form.
Click the Details… button to display the

Project Details form.
This form enables additional data to be

added to the project, i.e. Name, Description
and a message that will be displayed when
the project is opened.
The Number textbox is automatically

populated with the project identifier.
Enter the following data in the appropriate textboxes:
Name Administration Training Project
Description Training
Message Hello
Click the OK button to enter the data and dismiss the form.
12
Copyright © 2015.
www.aveva.com
The Project Creation Wizard form should now look like this:
Click the Create… button. The project structure and project batch file are automatically created and the
evars.bat file is automatically modified to point to the newly created project. The following message is
displayed.
Click the OK button and then the Close button on AVEVA Project
Creation Wizard form. The AVEVA Administration Login form is now
displayed.
Project Structure
Navigating to the project location using Windows Explorer displays the folder structure of the Project.
 As well as the standard project folders, a folder has been created to hold any project defaults and folders
for Diagrams, Supports, Pipe Stress Interface, and AVEVA Engage files have also been created.
Note that a project batch file named evarsTraining.bat that contains the project environment variables has
been created in the Training folder.
The evarsTraining.bat file can be viewed by editing the file with a suitable text editor.
13
Copyright © 2015.
www.aveva.com
The project code in an AVEVA project is limited to 3 characters e.g. (TAD, APS etc.); the display can be
extended on the Product Login Screen to 8 characters using the project ID variable. In the example above
TAD000ID is set to Training.
AVEVA Environment Variables

“Project Environment Variables” ABC000, ABCPIC, ABCISO and ABCMAC are used to point to the project’s
folders. All AVEVA Products and projects make extensive use of these variables.
The AVEVA Everything3D installation guide has a full list of these variables and their use. The following section
describes the use and modification of some of these variables.
2.3.1 The Evars Batch File

AVEVA suite of products utilise an environment variable file, custom_evars.bat file which calls the project batch
files and set paths for other variables that control PML libraries and set storage areas.
By default, the custom_evars.bat file is located in the Projects folder, typically C:\Users\Public \Documents
\AVEVA\Projects\E3D2.1 The contents of the file can be viewed and edited using a suitable text editor such
as Notepad.
Calls to new project environment variable files (e.g. evarsTraining.bat) are added to the bottom of the file.
Other parts of the file, relating to default paths for storage areas and PML libraries are considered in the
sections that follow.
2.3.2 Environment Variable ‘AVEVA_DESIGN_WORK’

When working with AVEVA suite of products, designers are effectively working on a copy of the data. The data
is only written back to the database(s) with a Savework or an Exit.
The AVEVA suite of products uses a work area folder that is normally local on the PC. This folder is described
by the Environment Variable AVEVA_DESIGN_WORK, for example:
set AVEVA_DESIGN_WORK=C:\temp\
This variable should be set in the main evars.bat and evars.init file.
 There should be no spaces at the equal (=) sign.
14
Copyright © 2015.
www.aveva.com
2.3.3 Environment Variable ‘AVEVA_DESIGN_USER’
AVEVA suite of products makes use of the Environment Variable AVEVA_DESIGN_USER to place its reports
etc. It is often convenient to have this variable set to the same as the shortcut “Start in” folder and it should be
local on the PC.
The default path is as shown C:\Users\Public\Documents\AVEVA\USERDATA\
set AVEVA_DESIGN_USER=C:\Users\Public\Documents\AVEVA\USERDATA\
This variable should be set in the main evars.bat and evars.init file.
 There should be no spaces at the equal (=) sign.
2.3.4 Environment Variable ‘PMLUI’
The Environment Variable PMLUI points at the PML 1 Interface (Forms and Menus) folder structure. This
variable can be used to point at a search path. The PMLUI environment variable can be set to more than one
folder path. The AVEVA suite of products will find the files in the search path, in the search order.
This facility can be used to customise the AVEVA suit of products. Modified Forms, Menus or Macros can be
placed in a parallel folder structure and AVEVA suite of products will find these modified files first. The default
setting for PMLUI is:
set PMLUI=%AVEVA_DESIGN_EXE%PMLUI\
For the purposes of training, this is currently also set to C:\AVEVA\Plant\PlantTraining2.1\Training\pmlui.
The folder structure contains sub-folders where DES holds the Design Interface, ISO holds the Isometric
interface, etc.
2.3.5 Environment Variable ‘PMLLIB’
The PMLLIB environment variable works similar to the PMLUI environment variable with the exception that
an index called ‘pml.index’ is used to describe the location of PML 2 Forms, Objects, and Functions.
This facility can be used to customise Forms, Menus, Objects, and Functions. The folder structure is not
important as E3D will find these modified files first via the index. The default setting for PMLLIB is:
set PMLLIB=%AVEVA_DESIGN_EXE%pmllib\
For the purposes of training, this is currently set to C:\AVEVA\Plant\PlantTraining2.1\Training\pmllib.
This folder structure contains forms, objects, and functions.
2.3.6 Serialisation Files
On exit from any of the AVEVA products, the screen layout is saved to serialisation files. Some of these files
are located in the AVEVA_DESIGN_USER folder and others are located in local data folders specific to the
user.
The exact path for the local data folders varies with each Windows operating system; however typical examples
are listed below.
C:\Users\<user name>\AppData\Local\Aveva on Windows 7 systems, where <user name> is the users

Windows login name.
15
Copyright © 2015.
www.aveva.com
This page is intentionally left blank
16
Copyright © 2015.
www.aveva.com
CHAPTER 3
3 AVEVA Projects
Three primary products within the AVEVA suite of products are AVEVA Administration,
AVEVA Everything3DTM and AVEVA Catalogue.
AVEVA Product Structure
The AVEVA Administration, AVEVA Everything3D and AVEVA Catalogue products are all divided into modules
to perform the various functions and are as explained below.
AVEVA AdministrationTM
Admin Project and User administration.
Lexicon Creation of User Defined Attributes, User Defined Element Types, Status Definitions
and Database Views.
New Project Project creation wizard
AVEVA Everything3DTM
Model 3D modelling.
Draw 2D drawing Production.
Isodraft Isometric drawing production.
Spool Pipe spooling.
AVEVA CatalogueTM
Paragon Catalogue and Specification construction.
Propcon Element and component properties.
AVEVA Administration
The AVEVA Administration product consists of 3 modules, Admin, Lexicon, and New Project which are
explained in the sections below.
3.2.1 Admin
Large plants designed using AVEVA Products are usually broken down into individual areas (either physical
areas or design areas), depending on the size, complexity and configuration of the plant. On a large project,
the System Administrator will first agree with Project and Design Management the breakdown of the AVEVA
project into sections which:
 Are relevant to the needs of project reporting and control.
 Form reasonable design subdivisions with sensible match-lines and design content.
 Enable enough designers to work in parallel with simultaneous access to carry out their design tasks.
17
In much the same way as in a design office (with its section leader, drafts people, etc.), AVEVA Administration
allows uses Teams, the members of which are called Users. These Teams can consist of any number of
Users and can be organised by discipline or physical work areas. The main features of the Admin module
include:
 Access Control (Teams and Users)
 Databases (DB’s)
 Multiple Databases (MDBs)
 Database management functionality
3.2.2 Lexicon
Lexicon enables the definition of User Definable Attributes (UDA) that may be assigned to AVEVA E3D
elements so that additional information may be stored in the databases and extracted into drawings and
reports.
Lexicon also enables the definition of User Defined Element Types (UDET) that may be defined to enhance
the engineering terminology in the project and differentiate between types of the base element. For example,
an EQUI element may be designated as an element type of :PUMP or :EXCHANGER.
Lexicon also enables the definition of User System Defined Attribute (USDA) allows the administrator to place
behaviour on a standard AVEVA E3D element. For example limits may be applied to attributes of top level
elements within AVEVA E3D.
In addition, Lexicon enables the definition of Status elements for use with Status Controller and Database
Views for use with Report Designer.
Typical AVEVA Project Design Teams
The example shown below shows a project that is split into 3 graphical areas North, South and the Pipe Bridge
and 7 Discipline Teams. Please note that the image below has been captured in Isometric 3 view.
18
Copyright © 2015.
www.aveva.com
For this project the AVEVA Plant Administrator may create the following Discipline/Area Teams:
Discipline North Area Pipe Bridge South Area
Piping PIPEN PIPEPB PIPES
Equipment EQUIPN EQUIPPB EQUIPS
Structural STEELN STEELPB STEELS
Civil CIVN CIVPB CIVS
Heating and Ventilation HVACN HVACPB HVACS
Electrical ELECN ELECPB ELECS
Instrumentation INSTN INSTPB INSTS
By splitting the project in this way the Administrator can control which users have access to each discipline
and in which areas.
A Designer may be a member of several teams, e.g. an HVAC Designer could be a member of the HVACN,
HVACS and HVACPB Teams.
 The Administrator may also create some Project Teams, e.g. PPROJECT, which will give its member’s
access to the Project Catalogue and other specialist databases, as discussed later in this training guide.
19
Copyright © 2015.
www.aveva.com
Typical Project Databases
The AVEVA product suite has several database types for storing the design information:
Design (DESI) Databases which contain all the 3D design information for the project.
Draft (PADD) Databases which contain data about 2D drawings produced by DRAW.
Catalogue (CATA) Databases which contain the project catalogue and specifications created
using AVEVA Catalogue product.
Properties (PROP) Databases which can contain material properties, and can be referenced by
the catalogue.
Dictionary (DICT) Databases which contain information on User Defined Data such as User
Defined Attribute Definitions.
Isodraft (ISOD) Databases which contain spool drawings produced by SPOOLER.
Schematic (SCHE) Databases used by PID 3D Integrator.
Manufacturing (MANU) Database contains detailed manufacturing data, currently used for AVEVA
Marine and AVEVA Fabrication.
Namesequence (NSEQ) Database for storing of name sequences, currently used for AVEVA Marine
Assembly Planning and Curved Hull.
Engineering (ENGI) Databases used by the Tags Module from within the AVEVA Engineering
product.
Analysis (ANYS) Database for Analysis, currently can store the AVEVA Marine Initial Design
Hydrostatics data.
CrossProduct (XPRD) Database is currently used to store comments.
Task (TASK) Database used by Bocad Structural Steel for steelwork planning.
ConceptualModel (RDFN) Database used to store external data models e.g. engineering class
libraries.
Configuration (CONF) Database for extracting reference files and settings into a common place.
20
Copyright © 2015.
www.aveva.com
3.4.1 Typical 3D Design Databases
The example project shown above would have the following Design Databases:
Discipline North Area Pipe Bridge South Area
Piping PIPEN/DESIGN PIPEPB/DESIGN PIPES/DESIGN
Equipment EQUIPN/DESIGN EQUIPPB/DESIGN EQUIPS/DESIGN
Structural STEELN/DESIGN STEELPB/DESIGN STEELS/DESIGN
Civil CIVN/DESIGN CIVPB/DESIGN CIVS/DESIGN
Heating & Ventilation HVACN/DESIGN HVACPB/DESIGN HVACS/DESIGN
Electrical ELECN/DESIGN ELECPB/DESIGN ELECS/DESIGN
Instrumentation INSTN/DESIGN INSTPB/DESIGN INSTS/DESIGN
3.4.2 Typical 2D Drawing Databases
Projects will have a similar set of Drawing databases to that of Design, however, these may sometimes be
reduced to just one per discipline and, on smaller projects, a single drafting team is often created.
The above example project is considered to be too small to warrant a full set of Drawing databases based on
Discipline/Area, so a Drawing Team and single Draw database would be created, e.g. a Team called Drawing
and a database called DRAWING/DRAW.
3.4.3 Specialist Project Databases
The project also requires some other special project databases, for example:
 A Project Catalogue database to store project discipline catalogues and specifications called
PPROJECT/CATA.
 A Project Properties database to store project component weights and materials called
PPROJECT/PROP.
 A Project Dictionary database to hold project UDAs, UDETs, Status data and Database Views called
PPROJECT/DICT.
21
Copyright © 2015.
www.aveva.com
Sharing Data between Projects
AVEVA suite of products has the ability to share data between multiple projects. For example, a catalogue of
industry standard piping components and specifications may be used across a number of projects.
Most companies have a corporate Project containing a corporate catalogue, typical design models, and 2D
graphical symbols and backing sheets.
AVEVA supply their catalogue in a project called AVEVA Catalogue Project (ACP) which contains typical
piping components and specifications, structural steelwork catalogues, drawings backing sheets and symbols.
When an administrator is creating reference data they must decide if the data is project specific. If the data
only relates to one project, for example a piping specification, it would be put in the project catalogue.
Alternatively, if it is a variation on a company piping specification, it would be in the corporate catalogue.
If the data is common, for example an elbow that could be shared across all projects, it should be put in the
corporate catalogue so it would be instantly available on all projects.
When a project references other projects databases they are called foreign databases, and a pointer to the
foreign project is created.
A Project may get its data from several projects. The following example shows the use of three projects:
 The Training Project (Training)
 A Corporate Catalogue (Corporate)
 The AVEVA Master catalogue (AVEVA Catalogue Project)
22
Copyright © 2015.
www.aveva.com
CHAPTER 4
4 Project Access
The AVEVA suite of products makes extensive use of Environment Variables, which are used to define the
location of the AVEVA Plant software and Projects. In this chapter the setting and the location of Projects with
the use of Project Environment Variables is explained.
Project Access
An AVEVA project requires a minimum of 4 Project Environment Variables which must be set for each project.
The latest versions of AVEVA Everything3D™ also make use of extra project areas, e.g. the project defaults
area.
Projects must have a three character Code and up to an eight character name. The Code is used to prefix the
environment variables.
For example, for a Project ABC the following 4 Project Environment Variables are required:
ABC000 Project database folder.
ABCISO Project Isodraft options folder.
ABCMAC Project Inter-DB connection macro folder.
ABCPIC Project Drawing Picture File folder.
The following Project Environment Variables are optional but are used as follows:
ABCDFLTS Project Defaults.
ABCDIA Diagrams Drawing Storage Area.
ABCDWG Project Final Designer Drawings folder
ABCTPL Diagram Templates.
ABCSTE Diagram Stencils.
ABCINFO Used by Supports
ABCREPORTS Used by Supports Reports.
ABCPSI Pipe Stress Interface.
ABCGCD Engage (CGD creator) file folder.
An additional Project Identifier Project Environment Variable of up to 8 characters long can also be defined,
for example: ABC000ID. This variable is used by the login screen to define the project name.
 For AVEVA E3D 2.1 an optional feature is available whereby a customer may remove all the Project evars
from the corresponding bat files apart from <proj>000 and ID (required to display project in Login form).
On selecting the project and entering AVEVA E3D 2.1, the start-up process will look to the project and
set up any required environment variables. Where an evar is already set, the start-up process will leave
that untouched, thus avoiding any unnecessary changes.
23
AVEVA supply a range of sample and catalogue projects that can be installed. Typically the sample and
catalogue projects supplied are:
APS AVEVA Plant Sample.
AMS AVEVA Marine Sample
ACP AVEVA Catalogue Project.
Product installation can be tested using the APS or AMS project. The environment variables for the APS
project are set in a batch file named evarsAvevaPlantSample.bat which is stored in the Project folder,
typically located at C:\Users\Public\Documents\AVEVA\Projects\AvevaPlantSample.
All catalogue and other data for the APS project is stored in the AVEVA Catalogue project (ACP), so the
environment variables for ACP have been set in a similar manner. The settings of APS000, APSPIC, APSISO,
APSMAC, ACP000 and ACPPIC should be checked. Normally the APCMAC and APCISO will never be
required as no Design or Isometrics will be produced from this project.
Navigate to the Projects folder, in this example C:\Users\Public\Documents\AVEVA\Projects\E3D2.1. All

AVEVA supplied Projects are displayed.
Navigate to the AVEVAPlantSample Project, the project folders are displayed along with the batch file
“evarsAvevaPlantSample.bat” that defines the “Project Environment Variables”.
The batch file evarsAvevaPlantSample.bat is called from the custom_evars.bat which is also located in
Projects\E3D2.1.
24
Copyright © 2015.
www.aveva.com
Modifying Project Environment Variables
To locate the project to another location on the network the project environment variables must be changed.
Modifications or additions to the Project Environment Variables should be made in the Project Batch file and
the main Product Environment Variables file custom_evars.bat.
The following is an example of how these project variables might be set on the AVEVA Plant Sample Project:
The AVEVA Catalogue is also required and this is set via the AVEVA Catalogue project evars file,
evarsAvevaCatalogue.bat, held in the AvevaCatalogue folder.
Both Project batch files are called from the main Plant Product Environment Variables file evars.bat/evars.init
which in turn call the custom_evars.bat file, which is located in the Everything3D2.10 folder. This can be
updated as required.
25
Copyright © 2015.
www.aveva.com
Typical entry in the custom_evars.bat file:
 Always make modifications to environment variables in the batch file, do not include them as system
variables as this may create conflicts between product versions.
26
Copyright © 2015.
www.aveva.com
CHAPTER 5
5 Teams and Users
To start the AVEVA Administration Admin module select:
Start > All Programs > AVEVA > Manage > AVEVA Administration 1.4.0
Login to AVEVA Administration with the

following credentials:
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 User option list.
Starting in Admin
The Admin default screen layout will be displayed comprising of the main pull down menus, the Admin
Explorer and the Admin Elements form.
Most administrative elements will be created using the Admin Elements form. If the Admin Elements form
is closed for any reason it can be displayed by selecting Display > Admin Elements… from the main menu.
 The Access Control Assistant can also be used for creating Teams, Users and Data Access Control
(DAC) elements. It has limited functionality and is primarily used for Data Access Control (DAC).
27
Teams, Users and Database Names
Users are defined by Name and Password, which they input on entry to any of the AVEVA products. The
databases they can access will depend on the type of User they are defined as.
 Free Users – may enter all modules and modify all databases.
 General Users – may not enter restricted modules (i.e. Admin and Lexicon) and may only modify
databases for Teams of which they are a member.
Most Users in a project are defined as General Users and are assigned membership to Teams. Any User
belonging to a Team will have write access to the databases owned by the Team.
In Dabacon based AVEVA Products, each database belongs to one Team only. Ownership of a database is
reflected in the naming convention and has the format TeamName/DatabaseName.
For this training the following Teams and Users will be created:
Design
Team User/Password Owning the database Type
PPROJECT CATA/CATA PPROJECT/PIPE CATA
PPROJECT CATA/CATA PPROJECT/STEEL CATA
PPROJECT CATA/CATA PPROJECT/DICT DICT
PPROJECT CATA/CATA PPROJECT/PROP PROP
PIPEN PIPEN/PIPEN PIPEN/DESIGN DESI
PIPES PIPES/PIPES PIPES/DESIGN DESI
EQUIPN EQUIPN/EQUIPN EQUIPN/DESIGN DESI
EQUIPS EQUIPS/EQUIPS EQUIPS/DESIGN DESI
STEELN STEELN/STEELN STEELN/DESIGN DESI
STEELS STEELS/STEELS STEELS/DESIGN DESI
DRAWING DRAWING/DRAWING DRAWING/DRAW PADD
PIPEN PIPEN/PIPEN PIPEN/SCH SCHE
COMMENTN All North Area Users will be a member of this Team COMMENTN/COMMENT XPRD
COMMENTS All South Area Users will be a member of this Team COMMENTS/COMMENT XPRD
Engineering
Team User/Password Owning the database Type
PROCESS PROC/PROC PROCESS/ENG ENGI
INSTENG INST/INST INSTENG/ENG ENGI
ELECENG ELEC/ELEC ELEC/ENG ENGI
28
Copyright © 2015.
www.aveva.com
In addition, the following Teams are needed for the administrative functions:
Team
PARAGONADMIN
DESIGNADMIN
DRAWINGADMIN
ISOADMIN
CATADMIN
ASSOC - All Users must be a member of the Association team.
It is normal practice to create usernames based on their personal Name/Windows login name.
For the purpose of this training the following user is also created:
JIMMY.JAMES - to represent the Windows user jimmy.james.
Admin Elements Form
The Admin Elements form allows an administrator to create/modify various administrative elements such as
Teams, Users, Databases, and MDBs etc. The element to be created / modified can be selected from the
TYPE list as shown below.
Once selected, the main list gadget of the form is updated with their respective headings and the list is
populated with the appropriate data. If administrative elements are modified, the Refresh button can be
used to update the displayed data.
The left and right arrow buttons on the form allows users to move one place up or down the list respectively.
Selection can also be made by clicking directly on the item in the list.
The right click menu on the list option displays various query
options which will be discussed later in the training guide.
At the bottom of the form, buttons are shown activated and de-
activated based upon the selection and perform various tasks.
These will be discussed in detail at various stages of the training
course.
The following is displayed when creating a Database
29
Copyright © 2015.
www.aveva.com
Creating Teams and Users – A Worked Example
This section explains how to create the Teams and Users described previously, using the Admin elements
form.
On the Admin Elements form select Teams from

the TYPE options list.
Note that the four buttons at the bottom of the form

are active.
Click the Create button to display the Create

Team form.
The Create Team form contains two administrative fields; Name and Description. The Create/Modify option
allows user to switch between the two modes.
Enter the following information into the respective fields

in Create Mode.
Name: PPROJECT
Description: Team for Project Catalogues
The Team Membership area of the form allows an

administrator to assign any current users as members
of the team. The users can also be assigned to teams
when creating new users.
Click the Apply button and then Cancel the form.
30
Copyright © 2015.
www.aveva.com
On the Admin Elements form:
Select Users from the TYPE list.
Click the Create… button to display the Create

User form.
 The use of Creating Entry Scripts and

setting up of User Access Control Rights are
covered in TM-1861 AVEVA Administration
System Administration training guide.
Enter the following data in the appropriate textboxes:
Name CATA.
Click the Set Password button to display

the Change Password form.
Enter the following data:
New Password CATA
Confirm New Password CATA
Apply the changes by clicking the OK

button on the Change Password form.
On the Create User form take the following

steps:
In the Description textbox enter: Designer

for Project Catalogue.
Select General from the Security options list.
Select <TEAM> PPROJECT in the Project Teams list

and add it to the Team Membership list by clicking the
down arrow button.
Click the Apply button to create the User and then the
Cancel button.
31
Copyright © 2015.
www.aveva.com
5.4.1 Modifying Users
On the Admin elements form select Users from the TYPE list.
Select <USER> SYSTEM from the list and click

the Modify… button to display the Modify User
form.
Modify the Description to System Free User.
Click Reset Password button to display the

Change Password form.
Set the New Password to TAD.
Confirm the new password.
Click the OK button.
On the Modify User form click the Apply

button to modify the User and then the Cancel
button.
5.4.2 Reset Password
If the password has been set the form displays the Reset Password button.
Passwords must be set before the User can enter any of the AVEVA suite of products.
32
Copyright © 2015.
www.aveva.com
5.4.3 Copy User
The Copy User form allows users to copy an existing user with its team membership attributes. It requires
entry and confirmation of a password for the newly copied user.
33
Copyright © 2015.
www.aveva.com
Exercise 1 – Creating Teams and Users
1. Create the following Design Teams in the Training Project.
Team Team Description

PIPEN North Area Pipe Team
PIPES South Area Pipe Team
EQUIPN North Area Equipment Team
EQUIPS South Area Equipment Team
STEELN North Area Structural Team
STEELS South Area Structural Team
DRAWING Drawing Team
PARAGONADMIN Catalogue Administration
MODELADMIN Model Administration
DRAWINGADMIN Drawing Administration
ISOADMIN Isometric Administration
CATADMIN Supports Administration
ASSOC Association Team
COMMENTN North Area Comments
COMMENTS South Area Comments
2. A set of Engineering Teams would also be required for the Engineering Applications. Create the
following teams.
PROCESS Process Engineering Team

INSTENG Instrument Engineering Team
ELECENG Electrical Engineering Team
3. Modify the description of team MASTER to Master Team using the Admin elements form.
4. Create the following users and assign them to appropriate teams using the Admin Elements form.
User Password Description Team(s)
PIPEN PIPEN Piping Designer North Area PIPEN PIPES
PIPES PIPES Piping Designer South Area PIPES PIPEN
EQUIPN EQUIPN Equipment Designer North Area EQUIPN EQUIPS
EQUIPS EQUIPS Equipment Designer South Area EQUIPS EQUIPN
STEELN STEELN Structural Designer North Area STEELN STEELS
STEELS STEELS Structural Designer South Area STEELS STEELN
DRAW DRAW 2D Draughter DRAWING
PROC PROC Process Engineer PROCESS
34
Copyright © 2015.
www.aveva.com
User Password Description Team(s)
INST INST Instrument Engineer INSTENG
ELEC ELEC Electrical Engineer ELECENG
JIMMY.JAMES JIMMY Equipment Designer EQUIPN EQUIPS
5. Modify the ASSOC Team to add all Design users to be a member of the team.
6. Modify the COMMENTN Team to add all the North Area Design users to be a member ot the team.
7. Modify the COMMENTS Team to add all the South Area Design users to be a member of the team.
The Admin elements form with all the Teams and Users should look as below:
35
Copyright © 2015.
www.aveva.com
36
Copyright © 2015.
www.aveva.com
CHAPTER 6
6 Databases
Database types
An AVEVA Project can contain a variety of database types. The following sections describe the databases
available and there intended use.
6.1.1 Administration Databases
The SYSTEM database holds the access control data for the model data and modules (e.g. tadsys).
There is only one SYSTEM database in the Project directory. It holds administrative information about the
composition and use of the project, including the following:
 A list of all the databases which are available in the project.
 A list of all Users who can access the databases, and the Teams to which they belong.
 A list of modules available in the project.

 The SYSTEM database is a multiwrite database, which means that there may be more than one user in
ADMIN at any time but these users cannot modify the same part of the database at the same time.
In the COMMS database the information are stored about who is using which module and which model
databases are available (e.g. tadcom).
Each user has a separate area of the COMMS database, which can be accessed in write mode, and so can
record module changes etc. Each user has read access to the other user’s areas, and so can find out about
other users in the project.
 The COMMS database is a single-access database. Users queue for the COMMS database on entry into
the module.
The MISC database stores inter-user messages, and inter-database macros (e.g. tadmis).
This database can only be opened in write mode by one user at a time, but many users can read from it. All
users need to be able to write to this database, but only when they are sending messages or writing inter-
database macros, or deleting messages and macros. All users can read from the database at any time.
 The MISC database is a single-access queued database, that is, if a user wants to write to the MISC
database must wait until any other users writing to it have finished.
The TRANSACTION database enables the System Administrator to monitor the progress of Global commands,
AVEVA E3D Global stores details of issued commands in a Transaction database. These Transaction
messages are generated in the database each time the progress of the command changes.
 Transaction databases are only present when the installation incorporates the Global product.
37
6.1.2 Model Databases
The AVEVA suite of products contain the following types of model databases:
 Design (DESI) databases which contain all the design information for the project.
 Design Reference (DESI) databases 2D Reference Only can be updated by 2D and 3D products.
 Drawing (PADD) databases which contain data about drawings produced by DRAW.
 Catalogue (CATA) databases which contain the project catalogue and specifications.
 Properties (PROP) databases which can contain material properties, and can be referenced by the
catalogue.
 Dictionary (DICT) databases which contain the definitions of User Defined Attributes, User Defined
Element Types, Status Workflow and Database Views created in the Lexicon module.
 Isodraft (ISOD) databases which contain spool drawings produced by SPOOLER.
 Schematic (SCHE) databases are used by PID and 3D Integrator.
 Engineering (ENGI) databases are used by the TAGS module in the AVEVA Engineering product.
 Manufacturing (MANU) databases are predominantly used in AVEVA Marine.
 Namesequence (NSEQ) databases are predominantly used in AVEVA Marine.
 It is very useful when creating Projects to have at least one top level element created. This gives the
administrator the ability to navigate to the correct database when creating items in the Model session. For
the same reason it reduces the number of MDBs required.
6.1.3 Controlled Databases
If a database is created as a Controlled database, then all updates are controlled externally to the AVEVA
suite of products. Both Update and Multiwrite databases can be controlled.
The external system is accessed via an EDMS link program, which must be supplied by the user. Users must
claim elements in order to change them on Controlled databases. The EDMS link program is activated by
AVEVA products when a Claim (or release) is made. It is totally up to the user as to what the EDMS link does.
Normally it will link into a user's central control system. Only Primary elements can be claimed.
For controlled DBs claiming is based on element names; that is, until an element is named no restrictions exist.
However, when a Primary element is named, the external system checks whether the name exists and in
future the name is always used to claim out the element.
The claim is only made the first time an element is updated. The element remains claimed until it is explicitly
released.
Control is applied by checking the Controlled

checkbox on the Create Database form
38
Copyright © 2015.
www.aveva.com
6.1.4 Design Reference Databases
A Design Reference databases is a restricted Design (DESI) database. Their main use is for storing
information about Systems and Areas for use in Engineering and Schematics applications. They are useful for
users who are licensed only for 2D applications as access can be obtained without requiring a 3D license. 3D
users can write as normal to these databases with some restrictions.
Design Reference databases are created by

setting a flag on the database when it is created
via the Reference Only checkbox on the
Create Database form.
This is the only way to set the flag and it cannot be removed at a later date, i.e. the checkbox is disabled when
modifying a database.
Design Reference databases can only own a restricted number of top level elements. They cannot own a SITE
or any elements owned by a SITE.
Design Reference databases cannot be the default DB in an MDB.
6.1.5 Protected Databases
Strict IPR protection can be applied at database level, allowing a project administrator to restrict the ability to
extract data held within a database. Protected databases are marked as uniquely belonging to the project from
which it was protected such that the restricted users cannot copy data from that database into another project,
even by using a physical copy of the database file. Functionality that permits copying of data from a protected
database is not available to restricted users. This includes:
OUTPUT command (DATAL).
COPY command, when copying across databases.
EXPORT command.
Data Access Routines (DARs).
In addition, read access to certain attributes is restricted to obstruct an unauthorised user from writing their
own DATAL-like functionality in PML.
Protection is applied by checking the Protected

checkbox on the Create Database form
Database Access Mode
When databases area created the administrator must determine what access mode is required. The access
mode for a database can be:
Update – Allows one writer and multiple readers.
Multiwrite - Allows multiple writers and multiple readers.
Database access mode can be changed from update to multiwrite at any time. However it is only possible if
database extracts have not been created.
39
Copyright © 2015.
www.aveva.com
6.2.1 Claim Mode
The manner in which elements are claimed also impacts access to data. Claim modes for databases can be:
Explicit - Users must explicitly claim any element they wish to change before the modification can start.
Implicit - An element will automatically be claimed when it is activated.
Elements in databases with multiwrite access must be claimed when they are modified so that no other user
can change them at the same time.
Multiwrite Databases
Multiwrite databases allow a number of users to read and write data to the same database.
The SYSTEM database is always multiwrite. Any of the remaining databases can also be multiwrite
excluding NAMESEQUENCE which will default to Overwrite.
It is normal practice to use multiwrite databases with implicit claim mode (though an explicit claim mode is
permitted).
Further consideration of multiwrite databases is provided in a later chapter.
Area Number
The Area Number textbox will accept values in the range 1 to 9. If the value is set to System (using the button
next to the gadget) then the database area will be set to the system default (0).
 The environment variable for a database’s area must exist when the database is created or moved.
Database Number
If the database is to be shared across many projects as may be the case with the Piping Catalogue, it will be
necessary to specify the Project DB Number. Database numbers must be unique within AVEVA Projects.
The Catalogue supplied by AVEVA has the DB Number in the 7000 range. Also reserved for AVEVA are
database numbers 250,001 to 255,000.
The Administrator can allocate up to 250,000 databases to a single project.
A database number range can be used to reserve numbers for

projects; this will help prevent number conflicts for databases shared
between projects. A new Unique button has been added to allow the
creation of the unique range.
A range of database numbers can be allocated to a project by

selecting Settings > DB Number Range… from the main menu to
display the DB number Range form.
Modifying the From or To number will restrict the available database

number in the project.
40
Copyright © 2015.
www.aveva.com
File Number
This is the file number as used in the operating system. The database filename created in the above example
would be tad50500_0001.
Deleting Databases
Databases may be deleted by selecting the element from the Database & Extracts grid on the Admin
elements form and then clicking the Delete button.
 To avoid the risk of database corruption, all deletion of databases, i.e. the files inside the Project folder,
must be done from ADMIN and not by using operating system utilities or commands.
Copying Databases
Copied databases can be used for:
 Copying a template project.
 Merging projects.
 Copying included databases before archiving.
Databases can be copied by selecting Database from the Element option button on the Admin elements form,
selecting the element to be copied from the list and then clicking the Copy… button to display the Copy
Database form.
 The user cannot change the Database number of the copied database. This will be same as the original.
There cannot be more than one database with the same database number in the same MDB.
To avoid the risk of database corruption, all copying of databases (i.e. the files inside the Project folder)
must be done from the ADMIN module and not by using operating system utilities or commands.
Modifying Databases
The Modify button can be used to change the database names if required.
Database access is controlled by the Team so by changing the Team of a database, user access can be
changed.
41
Copyright © 2015.
www.aveva.com
Configuring the Admin Elements Form
The Admin elements form can be modified to include the Database File Name and the Database Access
mode. Select Settings > Display Mode > Setup Admin Elements form… from the main menu to display the
Level of Detail on the Admin Elements form.
This form enables the administrator

to control the detail displayed on the
Admin elements form.
Checking the Access and Filename

checkboxes will display Access and
Filename columns on the Admin
elements form.
This information can also be saved,

loaded, and deleted using a
configuration file. This functionality is
found in the main menu under
Settings > Display Mode > Manage
User Config file
42
Copyright © 2015.
www.aveva.com
Creating Databases - A Worked Example
In this worked example Design, Catalogue and Design Reference databases are created.
6.11.1 Design Databases
A Design database for PIPEN team is required. Select Databases & Extracts from the TYPE list.
Click the Create button to display the

Databases & Extracts form:
Click the Master DB radio button and

click the OK button to display the Create
Database form.
 The use and creation of Extract Databases is covered in TM-1861 AVEVA Administration System
Administration training guide
Select <Team> PIPEN from the Owning Team grid Name

column.
Enter or select the following data:
Name DESIGN
Description North Area Pipes
Database Type Design
 As a Design Database is being created the DB

Element Type created will be displayed as SITE. This will
change based on the Database Type.
Element Type SITE
Create SITE PIPEN/DESIGN
Access Mode Update
Do NOT check the Controlled, Reference Only or Protected

checkboxes.
Area Number and DB Number for this example should be left

at Set by System.
Click the Apply button to create the database.
43
Copyright © 2015.
www.aveva.com
6.11.2 Catalogue Databases
If the database is to be shared across many projects, as may be the case with the Piping component catalogue
or a Structural catalogue, it will be necessary to specify the DB Number. Database numbers must be unique
within the AVEVA suite of products.
Remember the databases numbers reserved for AVEVA use are in the range 7001 to 8000 and 250,001 to
255,000.
For the purpose of this training, Catalogue, Dictionary and Properties databases will be created in the 50500
range.
 If there is a conflict in DB numbers it would need to be resolved using Reconfigure.
On the Admin elements form select Databases & Extracts from the TYPE list. Select the Create button and
then click the Master DB radio button and the OK button on the subsequent Database & Extracts form to
display the Create Database form:
Select <Team PPROJECT> from the Owning Team Name

column.
Name PIPE
Description Project Piping Catalogue
Database Type Catalogue
Element Type Catalogue
Create CATA PPROJECT/PIPE
Access Mode Multiwrite
Leave Area Number for this example as Set by System.
Set the DB Number to 50500.
Click the Apply button to create the database.
44
Copyright © 2015.
www.aveva.com
Exercise 2 – Creating Databases
1. Create the following Design and Draft databases using the Admin elements form.
Database Access
Team Name Description DB Element Name
Type Mode
PIPES DESIGN South Area Pipes Design PIPES/DESIGN Update
EQUIPN DESIGN North Area Equipment Design EQUIPN/DESIGN Update
EQUIPS DESIGN South Area Equipment Design EQUIPS/DESIGN Update
STEELN DESIGN North Area Steelwork Design STEELN/DESIGN Multiwrite
STEELS DESIGN South Area Steelwork Design STEELS/DESIGN Multiwrite
DRAWING DRAW Drawing Draft DRAWING/DRAW Multiwrite
ASSOC ASSOC Association Database Design ASSOC/ASSOC Multiwrite
2. Create the following Catalogue, Dictionary and Properties databases with the appropriate DB number.
Database Access
Team Name Description DB Element Name DB No.
Type Mode
Project Steelwork
PPROJECT STEEL Catalogue PPROJECT/STEEL Multiwrite 50501
Catalogue
Project Dictionary
PPROJECT DICT Dictionary PPROJECT/DICT N/A 50502
DB
Project Properties
PPROJECT PROP Properties PPROJECT/PROP N/A 50503
DB
3. Engineering Databases are used by Tags Module in the Engineering application they are created in the
same way as other databases. Create the following Engineering databases.
Database DB Element
Team Name Description Access Mode
Type Name
PROCESS ENG Process Engineering Engineering PROCESS/ENG Multiwrite
INSTENG ENG Instrument Engineering Engineering INSTENG/ENG Multiwrite
ELECENG ENG Electrical Engineering Engineering ELECENG/ENG Multiwrite
4. Schematic Databases are used by Diagrams and Schematic Model Manager to store 2D line diagram
information for Piping, HVAC and CABLE. Create the following Schematic databases.
Database ScGroup
Team Name Description Access Mode
Type Name
PIPEN SCH Piping Schematic DB Schematic PIPEN/SCH Multiwrite
5. Cross Product Databases are used by Commenting to store Comments and Saved Model Views.
Create the following Cross Product databases.
Database Access
Team Name Description CMTWLD Name
Type Mode
COMMENTN COMMENT North Area Comments CrossProduct COMMENTN/COMMENT Multiwrite
COMMENTS COMMENT South Area Comments CrossProduct COMMENTS/COMMENT Multiwrite
45
Copyright © 2015.
www.aveva.com
The complete set of Databases should look similar to this in the Admin Elements form.
Foreign Databases
Databases can be copied from other projects and shared between projects, which saves disk space and
eliminates errors. Catalogue databases are often shared in this way.
Databases included from other project(s) are also known as Foreign databases. The project from which
Foreign databases are referenced must be available, i.e. it must be possible to read from the referenced
projects folder, and the environment variables for the second project must be set.
When a Project is shared with other Projects, there are two important considerations:
Teams must exist for all databases that are to be shared.
Databases in the source project that will be shared must NOT be given a database number that will clash with
a database number that already exists in the destination project.
 Foreign databases are marked with * in the Database list.
Including and Copying Foreign Databases
To complete the database additions on the Training project some of the databases from the AVEVA Catalogue
Project (ACP) will be included and two databases will be copied from the AVEVA Plant Sample (APS) project.
46
Copyright © 2015.
www.aveva.com
Including Foreign Databases - A Worked Example

To include databases from ACP select Databases & Extracts from the TYPE list on the Admin elements
form.
Click the Include… button
Select the ACP project from the Foreign Projects list.
Enter SYSTEM in the Username textbox.
Enter XXXXXX in the Password textbox.
 This can only be accessed by a Free user of

the project being included.
Select All the Databases with the following exceptions

by holding down the CTRL key and selecting individual
databases from the list.
MASTER/PIPEOLD
MASTER/UCATALOG
MASTER/UEQUICATA
MASTER/UEQUITMPL
MASTER/UNIT
 The databases starting with U are Imperial

example databases and the UNIT database sets
imperial Units.
47
Copyright © 2015.
www.aveva.com
Two Question forms are displayed for the MDS/CATA and the
MDU/CATA7360-OLD db, as the teams MDS and MDU do not exist, for
the MDS/CATA click the Yes button and for the MDU/CATA7360-OLD
click the No button.
Click the Apply button to include the databases and then Dismiss to close the form.
The included Foreign databases are now displayed in the Databases and Extracts list with their relative DB
Number and are marked with * as shown below.
48
Copyright © 2015.
www.aveva.com
Copying a Foreign Database – A Worked Example
Databases containing Draft Styles and Microsoft Visio templates and symbols are available in the AVEVA
Plant Sample (APS) project and will need to be copied.
Click the Copy Foreign… button on the Admin elements form.
Select the APS Project from the Foreign Projects list.
Enter SYSTEM in the Username textbox.
Enter XXXXXX in the Password textbox.
 These are the default Username and Password

settings which may have been changed.
Select ADMIN/PADD from the Foreign Databases grid.
Select <TEAM> PPROJECT from the Target Database

Name grid.
Enter DRAWING in the Database Name textbox.
Click the Apply button to copy the databases.
Database Sets
Database Sets are sets of databases that can be handled as a single unit. For example, a database set can
be added to or removed from an MDB.
49
Copyright © 2015.
www.aveva.com
Creating a DB Set - A Worked Example
In this worked example a DB Set is created for all the Engineering databases.
On the Admin Elements form select DB Sets from the TYPE list and click the Create… button to display the
Create DB Set form.
Name ENGDB
Description: Engineering Databases
From the Non Member DBs list select the following databases:
ELECENG/ENG
INSTENG/ENG
PROCESS/ENG
Add them to the Members (Ordered) list using the appropriate arrow.
Click Apply and then the Cancel button to close the form.
The Non Members DB Sets list shows all the DB Sets which have not already been added to the current set.
The Members (Ordered) list shows all the databases that are part of the current DB set.
50
Copyright © 2015.
www.aveva.com
Databases can be added dynamically using the Selection Rule, in the following example the North Area
Databases are added to DB Set.
Name NORTHDB
Description: North Area Databases
Selection Rule ( MATCHWILD ( ATTRIB NAME , '/*N/*' ) )
Click Apply and then the Cancel button to close the form.
51
Copyright © 2015.
www.aveva.com
Exercise 3 – Copying Foreign database & Database set creation
1. Copy the database called SAMPLE/CABLDIA from the APS project. Name the copied database
PPROJECT/SCHEMATIC.
2. Create a Schematic database set called SCHDB which includes the Engineering, Design and Catalogue
databases. Steelwork Design databases should not be included.
3. Create a Dynamic database set called SOUTHDB including all the South Area Databases using the
Selection Rule ( MATCHWILD ( ATTRIB NAME , '/*S/*' ) )
52
Copyright © 2015.
www.aveva.com
CHAPTER 7
7 Multiple Databases (MDBs)
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.
MDB Overview
An MDB must contain all the data that the user needs to access. For example, for a DESIGN user, the MDB
must contain a Catalogue database and the Design database which the user is going to work in. In addition,
the MDB should contain all other DESIGN databases with data in the same physical volume, which will ensure
the accuracy of clash checking, and all other DESIGN databases which will have connections to the user’s
design area.
Multiple users can access the same MDB at the same time. There are different ways of allowing access to
MDBs: some options are as described below:
One MDB per User. This method is now superseded but was common practice before the advent of Multiwrite
databases. The DB with write access must be the first DB of that type (DESIGN, DRAFT, etc.) in the MDBs
list of members. This option may be suitable for large projects with many Update DBs and Users.
One MDB per Department. This is a common method of working as it allows the System Administrator to Group
departmental sites towards the top of the Design Explorer. In this case, the System Administrator must create
the top level elements in the DB when creating DB’s.
One MDB per Area. This is a common method of working on larger projects with several areas. Adjacent Area
databases may be included in the MDB.
One MDB with many users (maybe just one MDB). In this case, the System Administrator must create the first-
level elements in the DB. This option is often suitable for small to medium projects with few DBs and Users.
MDBs for special purposes. For example, an MDB containing Piping data only for MTO production or perhaps
Drawing Production, etc.
An MDB may contain up to 1000 current databases, these databases can be accessed at any one time. The
other databases may be deferred.
Databases can be transferred between current and deferred status at any time, so that a user can replace a
current database by a non-current one to access a particular part of the design.
 An MDB can only contain one database with a given DB number. Two databases will have the same DB
number if one has been created as a copy.
Database Order in the MDB
The order in which the databases are included is very important, the users write access database should be
the first in the list and the rest should follow in the order that they will be accessed.
Frequently used databases should also be near the top of the list.
53
Creating MDBs – A Worked Example
On the Admin Elements form select MDBs from the TYPE list and click the Create… button to display the
Create Multiple Database form.
Name PIPEN
Description North Area Pipes MDB
Sort the Database Grid by DB Number.
Select <DB> PIPEN/DESIGN, EQUIPN/DESIGN and STEELN/DESIGN from the Project Databases list.
Select After from the Insert options list.
Click the down arrow button to move the databases to the Current Databases list.
54
Copyright © 2015.
www.aveva.com
Right click anywhere in the Project Databases list to display the pop-up menu.
Click the Select All DBs option
Right click in the Project Databases grid.
From the pop-up menu click the (DE) Select DB Set option.
The DB Set selection form will be displayed.
Select <DB Set> ENGDB Engineering Databases from the list.

Click the De-Select button on the DB Set selection form.
Select After from the Insert options list and click the down arrow button to place all databases after the
STEELN/DESIGN database in the Current Databases list.
The Error form is displayed, click the Ok button
 With selecting All Databases the ENGDB Selection

Set was included and excluded giving this Error.
55
Copyright © 2015.
www.aveva.com
Select <DB> PPROJECT/SCHEMATIC from the Current Databases list.
Click the up arrow button to move PPROJECT/SCHEMATIC to the Project Databases and Database Sets
grid.
Click the Apply button on the Create Multiple Database form
56
Copyright © 2015.
www.aveva.com
Exercise 4 – Creating MDBs
Create the following MDBs:
4. MDB PIPES should be created with PIPES/DESIGN as the first database with the other databases in the
South area close to the top. Set the Description of MDB to South Area Pipes MDB.
5. MDB EQUIP will be a department like MDB, so EQUIPN and EQUIPS should be towards the top. Set the
Description of the MDB to Equipment.
 Remember Copy MDB could be used.
6. Similarly MDB STEEL will also be a department like MDB, so STEELN and STEELS should be towards
the top. Set the Description of the MDB to Steelwork.
7. The ENGINEERING MDB will contain all the Engineering Databases and the Schematic Database. Set
the Description of the MDB to Engineering MDB.
8. Finally, MDB ALL contains all the databases with the local databases close to the top. Set the Description
of the MDB to All Databases.
The project should now have the following MDBs.
57
Copyright © 2015.
www.aveva.com
58
Copyright © 2015.
www.aveva.com
CHAPTER 8
8 Inter Databases References
Write access to databases is typically restricted to a few databases specific to the design discipline of each
user. Occasionally a designer may undertake a task that requires them to modify data in a database they do
not have write access to. For example, a user may try to connect a pipe to a nozzle that is held in another
database. Where such instances occur Inter-database connection macros are generated.
Design Connection References
When Branches are connected, AVEVA E3D sets the Head Reference (Href) attribute or the Tail Reference
(Tref) attribute to the item it is connected to, e.g. a nozzle or a tee name.
It also sets the Connection Reference (Cref) attribute of that item to point at the Branch that has been
connected.
If there is write access to the connected component the relevant connection references are set. However, if
write access is not available an Inter-database connection macro is created.
Inter-DB macros are created in the following situations:
 A user in MODEL attempts to make a connection to an element which is in a Design database to which
the user does not have write access.
 A user in MODEL attempts to make a connection to an element which is in a Multiwrite Design database
to which the user has write access, but the element is claimed by another user.
 A user in ISODRAFT updates REVISION and DETAIL attributes, which need to be stored in the Design
database, to which the user has no access.
The Administrator would normally check the project users before deleting Inter-DB Macros.
 Designers should run and delete their own macros so this option should not normally be used.
59
Inter-Database Macros – A Worked Example
Some of the databases created earlier were Update databases, allowing only one writer to each database.
These databases will be used to demonstrate the creation of an Inter-database macro. An attempt will be made
to connect a pipe to a nozzle held in a database where the user does not have write access privileges. The
process of checking for Inter-database macros and executing them will also be demonstrated.
8.2.1 Creating an Inter-Database Macro
Login to AVEVA Everything3D with the

Project: Training
Username: EQUIPN
Password: EQUIPN
MDB: EQUIP
Click the Model tile.
Navigate to Site EQUIPN/DESIGN. Create a Zone named ZONE-EQUIPN-EQUIP and two pieces of
equipment containing at least one nozzle each. Name the equipment VESSEL1 and VESSEL2 then Save
Work.
Enter another AVEVA Everything3D Model session as User PIPEN, Password PIPEN and using MDB PIPEN.
Navigate to Site PIPEN/DESIGN; create a Zone named ZONE-PIPEN-PIPE and a Pipe named PIPE-1 that
connects the two nozzles created previously.
60
Copyright © 2015.
www.aveva.com
Open the Command Window from the TOOLS tab, select the Commands button located in the Display group.
Save work from the Project tab and click the Save Work button.
An Inter database macro will have been created as the Pipe is in a different database to the equipment and
User PIPEN does not have write access to the EQUIPN database
Close the AVEVA Everything3D session for User PIPEN and return to the other AVEVA E3D session for
EQUIPN.
61
Copyright © 2015.
www.aveva.com
8.2.2 Checking and Processing Inter-Database Macros
From the AVEVA E3D session for EQUIPN select the PROJECT tab and then click the Get Work button.
Navigate to a NOZZ element under Equipment VESSEL1 created previously and select Attributes from the
Display section of the HOME Tab to display the Attributes form.
Note that the Cref (connection reference) of both nozzles is

currently Nulref, i.e. No Connection. The Inter-DB macros will
need to be run by the equipment user to validate these
connections.
Display the Inter DB Macros form by clicking the Inter DB Macros button from Modify Display Group of the
MANAGE tab.
Select Inter-DB Macro Number 1
Click the Run Macro button followed by Delete

Macro button.
Click Yes, and then click Cancel button to close the form
The Cref attribute of both nozzles has now been set.
62
Copyright © 2015.
www.aveva.com
Exercise 5 – Inter Database Macros
1. Using the above as an example create two Vessels and a Pipe connecting the Nozzles, Create the
Equipment in the Equipment database and the Pipe in the Piping Database. Run and delete the Inter-
Database macros created.
63
Copyright © 2015.
www.aveva.com
64
Copyright © 2015.
www.aveva.com
CHAPTER 9
9 Multiwrite Databases
Multiwrite databases allow multiple users to work on the same database at the same time.
DESIGN, CATALOGUE, DRAFT (PADD) and ISODRAFT databases are examples of databases that can be
of type Multiwrite. The SYSTEM database is always a Multiwrite database.
As with other databases, it is common to split the database content by each team’s responsibilities. This will
normally be determined by:
 The physical layout of the plant.
 The different engineering disciplines involved.
Use of Multiwrite Databases
To maximise the benefit of multiwrite databases it is recommended that the following guidelines are adhered
to:
 Keep interactive usage levels to 10 or fewer Designers per database.
 In AVEVA E3D Model, Draw and AVEVA Catalogue, keep data collected on a discipline basis where
possible. For example, a Piping database, a Structural database, a Draft Database etc.
 Create databases in Implicit Claim Mode.
 Maintain the concept of a graphical split where possible.
 Use one Team with Multiple Users.
 Do NOT enter AVEVA Plant suite of products more than once with the same name from different
workstations.
 For multiwrite databases, it may be more appropriate to add several databases to the same team, and
allow several users to belong to that team.
Working with Multiwrite Databases – A Worked Example
For this example the existing Equipment and Piping Design databases are modified and switched to Multiwrite
mode and the Team Membership is updated. As the Piping Designer is often responsible for creating
equipment, the Equipment Teams are added to the Piping Users.
Enter AVEVA Administration, Admin module as a SYSTEM user.
On the Admin Elements form select Databases & Extracts from the Elements pull-down.
Select <DB> PIPEN/DESIGN from the Name column.
Click the Modify… button to display the Modify Database form.
65
Select Multiwrite and Implicit Claim from the two Access Mode pull-downs.
66
Copyright © 2015.
www.aveva.com
Click the Apply button and then the Cancel button.
Repeat the process for the following databases:
PIPES/DESIGN
EQUIPN/DESIGN
EQUIPS/DESIGN
67
Copyright © 2015.
www.aveva.com
As the write access to a database is controlled by being a member of the Team. Modify Users PIPEN and
PIPES and give them membership of Team PIPEN, EQUIPN, PIPES and EQUIPS
Enter AVEVA Everything, Model module as User PIPES and MDB PIPES.
Modify the Pipe Description to Test Pipe for the pipe created in the
earlier session by User PIPEN.
Modification to the database PIPEN/DESIGN as User PIPEN and

PIPES can now be done at the same time.
 Claimed Items are shown in Bold in the Model Explorer.
68
Copyright © 2015.
www.aveva.com
Claim Lists
Select the Claimlists button from the MANAGE tab

located in the Access group to display the
Multiwrite Claim Lists form.
When working in Implicit Claim mode, each time an

item is modified in Model the significant item i.e.
Bran, Equip, etc. is added to the Claim List.
For standard Multiwrite databases, claims can be

released manually using Unclaim and are released
automatically when the Designer leaves AVEVA
E3D. If the designer leaves AVEVA E3D abnormally
(e.g. a system crash) the items will still remain
claimed.
69
Copyright © 2015.
www.aveva.com
70
Copyright © 2015.
www.aveva.com
CHAPTER 10
10 Database Stamps
It is often convenient to mark a set of databases at particular milestones in the project. The 'Stamp' functionality
allows this. It is then possible to find out what has changed since the stamp, or to view the data as it was at
that time.
Stamps are used to mark database sessions. The stamp sessions can be either by a specific time and date,
or by session number. Once there are stamped database sessions, the stamp name can be used in commands
where a date or session number can be used, such as BACKTRACK or REVERT. Stamping database sessions
makes it easier for the administrator to:
 Make comparisons and identify changes made from session to session. For example, drawings can
be issued on which all revisions that have been made since an earlier stamped session are highlighted.
 Merge database sessions.
 Back track a standard database to a previous session.
 Revert an extract database to a previous session.
Creating Date Stamps
The Create Data Stamp form can be displayed by selecting the Date Stamps option on the Admin Elements
form and clicking Create.
Name – A unique name can be entered

manually for the desired date stamp.
Description/Function – manual entry fields.
There are several ways to select sessions to be

stamped and the databases to be used and are
discussed as below.
Build Stamp – This option is used to specify

how databases to be stamped can be selected
from the option list. The options are as follows:
The Project - Selects all unique DBs in the

project. Any duplicate DBs that have the same
DB number are displayed automatically, so that
the user can choose which of the duplicates are
to be stamped. User can choose to skip them if
needed.
By Database Sets - Selects DBs in the selected

DB set.
By MDBs - Selects DBs from the selected

Project MDB.
By Teams - Selects DBs belonging from the

selected team(s).
By Databases & Extracts - Allows user to

individually add an existing DB or extract.
71
By Working Extracts - Allows user to individually add an existing working extract.
Users can also select to Stamp database sessions in the following ways using the radio button:
Choosing Date selects sessions by using the Set Date. The last session for the selected databases before the
Set Date will be stamped.
Choosing Session allows user to use the Session gadget below the Databases & Extracts frame to select
sessions directly.
 Users can only use this option when stamping by Databases & Extracts or by Working Extract. If the date
of a session selected is not the last session before the Set Date, users will be prompted to confirm their
selection.
Set Date – This option allows user to set the date and time for the selected sessions to be stamped. Clicking
Now sets the date and time field to current date and time. For the selected databases, the last sessions that
are dated before the Set Date will be stamped. The default method of selecting sessions to stamp is to use
a time and date, although sessions can be selected directly as discussed previously.
The databases that match the selected Stamp option are displayed in the selection list immediately below it.
The list's name changes depending on the selected Stamp option. Note the Sort and Filter gadgets at the base
of the selection list. If the ‘Stamp databases by Session’ option is selected, users can use the Session gadget
to display the available sessions for the selected DB.
The Stamped Databases frame shows the selected database sessions to be stamped.
Apply – Clicking this creates a new Date Stamp and stamps the selected database sessions.
Dismiss - Clicking this closes the form.
Creating Date Stamps – A Worked Example
Navigate to the Admin Elements form and select

Date Stamp from the Elements option list. Click
Create to display the Create Data Stamp form.
Enter the following information in the respective

fields.
Name APPROVAL
Description Approval
Build Stamp By MDBs
Click Now
Select <MDB> PIPEN
Pick the Down Icon to add databases within the

MDB to the Stamped Databases list.
Click Apply to create the Date Stamp. This date

stamp should now be visible in the Admin Elements
list.
Click Dismiss to close the form.
72
Copyright © 2015.
www.aveva.com
Login to AVEVA Everything3D with

the following credentials:
Project: Training
Username: SYSTEM
Password: TAD
MDB: PIPEN
As the stamp has already been

created, this can be selected from
the available list of Stamps from the
Stamp dropdown.
 Stamped Databases are

always opened in Read Only mode.
73
Copyright © 2015.
www.aveva.com
Exercise 6 – Date Stamps
1. Using the previous sections as an example, Stamp all the databases in the MDB PIPEN.
2. Enter AVEVA E3D Model and make some modifications to the Pipe created earlier.
3. Exit and Re-enter AVEVA E3D via Monitor using the created Stamp and note that the changes are
not visible, try to modify the pipe and note that it is Read only.
74
Copyright © 2015.
www.aveva.com
CHAPTER 11
11 Project Setup Excel Import/Export
Project Setup Excel Import and Export is designed to make the process of setting-up an AVEVA project easier
by allowing Administration data to be imported via spread sheets.
It is important that the Excel spread sheets used for both the Import and Export functions are in the correct
format. The required format is the same for both functions. Therefore the correct format can easily be obtained
by exporting data from the Administration module and examining the results.
Export to Excel – A Worked Example
Select Utilities > Export… 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
Click the icon and

navigate to C:\temp and
enter the file name
admin.xls.
Click Save to close the form

and OK to start the export
process.
An export summary screen is displayed. Task progress is

displayed in this form. In the event of an error occurring during
the export process, it will be noted in this form.
Click Dismiss to close the form.
Copyright ©2015. www.aveva.com

75
Admin Excel Spreadsheet
The Admin Excel spread-sheet has a specific format containing a keyword followed by the appropriate
headings.
The Excel Spread sheet is split into various tabs as shown below. This training course will focus on Project
Teams, Users, NT Authenticated Users, Databases, Included Foreign Databases, and MDB’s.
11.2.1 Admin Excel Spreadsheet – Teams
The required format for the Teams tab is as shown. Data

in some columns can be altered without restriction (e.g.
Description), while other items (e.g. the keyword TEAM)
should not be altered. Guidance on the values required
in each column is provided below.
#Keyword TEAM
Name Team Names
Description Team Description
11.2.2 Admin Excel Spreadsheet - Users
The required format for the Users tab is shown below. Data in some columns can be altered without restriction
(e.g. Description), while other columns reflect a value within an appropriate context (e.g. Team membership).
The keyword USER should not be altered. Guidance on the values required in each column is also provided.
76
Copyright © 2015.
www.aveva.com
#Keyword USER
Name Users Name
Description Users Full Name
Security Can be Free (System) User or in most case a General User
Password User Password is not exported
Access Rights Access Control Rights are covered in the Advanced Admin Training Guide
Teams All the Teams that the user is a member of, separated by spaces
11.2.3 Admin Excel Spreadsheet – NT Authenticated Users
The required format for the Authenticated Users tab is shown below. Data in some columns reflect values
within an appropriate context (e.g. Other users). The keyword AUTHUSER should not be altered. Guidance
on the values required in each column is also provided.
#Keyword AUTHUSER
Login Name Windows Login Name (must be lower case)
Default user AVEVA Plant Login Name
Other Users Any Extra Users, for example SYSTEM or DRAFT.
11.2.4 Admin Excel Spreadsheet – Databases
The required format for the Databases tab is shown below. Data in some columns can be altered without
restriction (e.g. Description), while other values, such as the keyword DATABASE, should not be altered.
Guidance on the values required in each column is also provided.
77
Copyright © 2015.
www.aveva.com
#Keyword DATABASE
Owning Team Team that own the Database
Name Database Name
Description Database Description
Type Database Type (DESI, CATA, PADD, DICT, PROP, etc.)
Claim Mode IMPLICIT, EXPLICIT for Multi-write Databases of UPDATE
Number Unique Database Number.
11.2.5 Admin Excel Spreadsheet – Included Foreign Databases
The required format for the Foreign Includes tab is shown below. The keyword FOREIGN should not be
altered. Guidance on the values required in each column is provided below.
#Keyword FOREIGN
Foreign Project Foreign Project Name for example SAM or MAS
Foreign Name Foreign Database name in the format TEAM/NAME e.g. MASTER/PIPECATA
Foreign User Free User Name in the Foreign Database
Foreign Password Free User Password in the Foreign Database.
 If the user name and password is not supplied the excel Input form will prompt for them.
78
Copyright © 2015.
www.aveva.com
11.2.6 Admin Excel Spreadsheet – Multiple Database
The required format for the MDBs tab is shown below. The keyword MDB should not be altered. Guidance on
the values required in each column is provided below.
#Keyword MDB
Name MBD Name
Description MDB Description
Databases List of Databases in order, separated by spaces.
Admin Import from Excel – A Worked Example
Create a new AVEVA Plant Project using the Project Creation Wizard 1.4.0 called TAM, the project can then
be accessed using Project TAM, User SYSTEM and password XXXXXX.
 Before attempting an Excel Import make sure that the Access Control Assistant is not displayed.
Select Utilities > Import… from the main 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.
Click the icon and navigate to:

C:\temp.
Select the file called admin.xls.
Click the Open button and then the

OK to initiate the import process.
79
Copyright © 2015.
www.aveva.com
Enter the User Name and password for any Foreign Projects as the form
is displayed.
User SYSTEM
Password XXXXXX
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.
For the purposes of the Training select

<None> and click the OK button.
Click Dismiss to dismiss the form.
 If any errors are displayed, it is

possible to roll back the System database,
to a state preceding the load operation.
80
Copyright © 2015.
www.aveva.com
11.3.1 Selecting an MDB for User Defined Data
Once the import operation has finished, the System Administrator is prompted to supply an MDB if one has
not previously been set.
If the imported data contains UDA’s or UDET’s then the MDB selected should contain a Lexicon Database.
 Data Access Controls may contain references to

UDA’s or UDET’s it is important that this is checked prior
to importing the data. Refer to TM-1861 AVEVA
Administration System Administration for further
information.
If DAC has not been specified, and neither UDA’s nor

UDET’s have been used, the System Administrator can
select <None>.
Admin Database Rollback – A Worked Example
The Admin Database can be rolled back following an Excel import in the event that errors were encountered.
The Rollback utility can be accessed by selecting Utilities > Rollback… from the main menu.
A Rollback form is displayed showing the items that

will be deleted.
Selecting the Rollback button in the middle of the

form instigates the process.
Due to the nature of this process, confirmation is

sought from the user.
Click Yes to complete Rollback.
81
Copyright © 2015.
www.aveva.com
The Performing Operations frame displays the

rollback actions as they are performed.
Exit AVEVA Administration and log back into the

Training Project (TAD) as the SYSTEM user.
82
Copyright © 2015.
www.aveva.com
Exercise 7 – Excel Expport and Import
1. Using the example above Export and Import the project from an existing project to new project.
83
Copyright © 2015.
www.aveva.com
84
Copyright © 2015.
www.aveva.com
CHAPTER 12
12 Miscellaneous Administration Functions
This chapter provides a brief overview of other administrative functions useful for querying data and trouble-
shooting AVEVA Projects.
Querying User Details
The Query menu contains a single Project option whose sub-menu has options for querying all aspects of
the project.
Within this sub menu are a number of options relating to Users, including User Status and NT Authentication.
Details of the User queries are provided below.
User Status… - this option displays the User Status form which
provides information about all the current users logged into the
project.
The List by options list enables the

users to be sorted by various criteria:
The list at the bottom of the form displays the status of each database for the selected user.
Users… - this option displays the

Users List form which gives
team membership, access rights,
and description information for all
users on the project.

85
NT Authenticated Users… - this option displays the Authenticated Users List form which gives information
about all NT Authenticated users and their respective roles.
 This option is only displayed if there

are NT Authenticated Users in the project.
Data Access Control… - this option displays the Data Access Control Audit form which displays Data
Access Control Report for the current project.
 Data Access Control is covered in TM-1861

AVEVA Administration System Administration
training guide.
Querying Database Details
The Query menu contains a single Project option whose sub-menu

has options for querying all aspects of the project.
Within this sub menu are a number of options relating to Databases

including Team ownership, database type, and MDB associations.
Details of the Database queries are provided.
86
Copyright © 2015.
www.aveva.com
Teams… - this option displays the Team List form which gives information about databases owned by the
selected team and lists the users in the team.
DBs… - this option displays the Database List form which gives information about the owning team,
database type, access and a list of MDBs which contain the selected database for all databases in the
project.
87
Copyright © 2015.
www.aveva.com
Database Sessions… - this option displays the Database Sessions form which gives information including
session numbers, author, time and date stamp, reason and session comment for all databases in the project.
The Display Previous Sessions options

list and counter enables the number of
sessions displayed to be specified.
The Search Date button enables session

on a particular date, specified by the date
gadgets, to be displayed.
MDBs… - this option displays the MDB List form which displays a list of all MDBs in the project. Selecting an
MDB from the list displays all the Current and Deferred databases for the selected MDB in separate lists.
Stamps… - this option displays the Stamp List form which provides a list of all database stamps in the project.
Selecting the date stamp displays detailed information about the stamp including name, date, time and
databases stamped.
88
Copyright © 2015.
www.aveva.com
Database Sets… - this option displays the Database Sets Report form which displays all DB sets in the
project and a list of all databases in each database set.
Project Information
Administrators can check project information by selecting

Project > Information… from the main menu. The Project
Information form will be displayed.
This form allows the administrator to view and edit project

attributes such as Name, Number, Description, Message and
the maximum number of users.
Changing Passwords
Selecting Settings > Change Password… from the main menu displays the
Change Password form.
Selecting the Enabled option allows users to change their password using the
Monitor module or by using the login form.
89
Copyright © 2015.
www.aveva.com
When enabled the login Window

displays the Change Password key
which can be selected to change
password.
Users can also change password after logging into Monitor module and
clicking Project > Change Password… from the Monitor Menu.
Locking Projects
In order to carry out some administrative tasks (e.g. update AVEVA software versions,
release approved data) it is necessary to Lock a project.
Selecting Project > Lock from the main menu allows locks the project. If a project has
been locked a tick mark will be placed at the right hand side of the Lock option in the
Project menu.
Locking has no effect on users already accessing a project; but it will prevent other
people from entering the project until the project is unlocked.
A project should always be locked before carrying out database modifications.
90
Copyright © 2015.
www.aveva.com
Expunging Users
If a User exits any of the AVEVA products in an unexpected

manner, they may still appear to be active in the Project and may
still have active claims to model elements.
In order to allow users to re-enter any of these products, or allow

items to be claimed by other users, it may be necessary to first
expunge them from the project.
Selecting Project > Expunge from the main menu provides the
administrator with three options to remove any phantom users
All Users – This removes all phantom users from the

system. A conformation prompt is displayed.
User Process… – Clicking this option displays the

Expunge User Process form. The Project Users list
displays various user processes with current
processes differentiated by an asterisk. Selecting a
user process and clicking the Expunge button
expunges the user process.
 ADMIN does not allow the Current User to

be expunged.
Claimlist… - Selecting this displays the Expunge Database Claimlists form. This allows the administrator
to select a database to expunge claimlists from.
91
Copyright © 2015.
www.aveva.com
Session Comments
AVEVA software allows users to save comments against the current

session database. Selecting Admin > Session Comment… from the
main menu displays the Savework/Session Comment form.
Comments on the current database session can be entered in the

Session Comment textbox.
Comments from previous sessions can be viewed by using the – or +

buttons on the form.
Clicking the Current button displays the current session comment
User Messages
Selecting Utilities > Send Message… from the main menu displays the Send Message form. The Send
Messages form enables messages to be sent to the teams or users of the project.
Administrators should be aware that messages are only displayed in a System Command Window and can be
missed by users.
Exiting the Admin Module
It is not possible to QUIT (i.e. exit without saving changes) from the Admin module. This is to ensure that there
are no inconsistencies between the actual database files and the record of the databases in the Project stored
in the System database.
Selecting Admin > Exit from the main menu saves changes to the System database and exits AVEVA
Administration.
If there is an abnormal exit from ADMIN (e.g. a power failure or system crash) the database files in the
operating system may include files with a .deleted extension.
When databases are deleted in ADMIN, the AVEVA software copies the file to be deleted to a new file with the
.deleted extension. Following a SAVEWORK, or normal exit from the AVEVA software which automatically
does a SAVEWORK, the .deleted files are removed.
However, if there is a problem which results in database files being deleted, and an exit occurs before the
System database can be updated with the changes; the AVEVA software will rename the .deleted files,
removing the extension so that the files will still be available.
The Global Explorer
A Global Explorer, similar in function to the Admin Explorer, is available within the Admin Module. It can be
added to the display by selecting Display > Global Explorer from the main menu.
 For further information on Global refer to TM-1863 AVEVA Global Administering Global Projects.
Module Definitions
The modules and module definitions are set up in the supplied product, and will not normally need to be
changed in order to run the AVEVA suite of products. The only part of the definition that may need to be
changed is the initialisation macro (imacro), which is run on entry to the module. The initialisation macro
typically contains module-specific commands to set up the screen display, including loading application
macros.
92
Copyright © 2015.
www.aveva.com
Each Module has an entry in the System database, which consists of the MODULE command followed by
commands to specify:
The security for the module.
 Unrestricted modules should have a security status set to Free. Free modules can be accessed by any
User. Restricted modules can only be accessed by Free User.
The Runfile, the program that is executed, e.g. %AVEVA_DESIGN_EXE%/des for Model.
The initialisation macro (imacro), which is run on entry to the specified module.
The Read/Write access to database types. For example, Model needs Write access to a DESIGN database,
but Read access to Catalogue databases.
12.11.1 The Module Definition Form
The Module Definition form is displayed by selecting Project >

Module Definitions… from the main menu. This form allows
the modification of module definitions for the current Project.
The Modules grid lists the AVEVA Product Modules.
The Sort by option list controls the order of modules displayed

in the list.
The Settings window pane displays the settings for the Module
selected in the modules List. With the Number and Name these
can be changed.
Security can be set to Restricted, General or Free. A User

must be a Free User (like SYSTEM) to use a Restricted Module.
Setting the Module security to free would allow General Users to
use the Module. This feature may be useful in allowing General
Users to access the Lexicon Module.
Runfile sets the file used to start up the Module. The defaults
are supplied in the %AVEVA_DESIGN_EXE% folder.
Imacro sets the file used to start up the GUI for the Module. A
typical value as used in the Model Module would be %PMLUI%/DES/ADMIN/START.
The Advanced Settings button displays the Advanced Module Settings form. This form allows administrator
to modify settings such as the setting of the buffer size (see below), the default database type and access for
the Module.
 Care must be taken when changing options on this form, as they may cause serious problems when using
AVEVA suite of Products.
93
Copyright © 2015.
www.aveva.com
Each module definition in the System DB may include a BUFFER command.

This command specifies how much space is to be reserved for the DABACON
Buffer in each module, and allows the database constructor to trade off CPU
usage against disc I/O to some extent and thereby optimise computer efficiency
in some of the more heavily used modules.
It may be useful for some system users to be able to change items in the
catalogue database whist remaining in Model. This can be done by changing
the access to the catalogue from Read Only to Read/Write.
 The user must be a member of the TEAM that owns the database to
have write access.
Backtrack Changes
AVEVA Administration allows administrators to revert a database to a

previous saved session. Selecting Data > Change Management >
Backtrack Changes… from the main menu displays the Backtrack
Changes form.
The database can be Backtracked to any session above Session Number

2.
 Session Number 2 is required as this is the Database Creation

Session.
94
Copyright © 2015.
www.aveva.com
Clicking the More… button displays the

Database Sessions form which contains
the session detail.
The Session Number button can be

used to move back through the sessions until the required session is reached. Clicking the Apply button will
make the changes.
 The Appware does not actually do a true Backtrack but actually performs a Revert. The latest session is
a copy of the specified previous session. True Backtracking can only be performed from the Command
Line, as demonstrated previously.
Merge Changes
AVEVA product sessions enable a history of changes to the database to be recorded. When a new session is
made, the changed data is appended to the end of the database file. Appending updated data to files will
increase the disk space required. If the history information is not required, and to save disk space the database
can be compacted by merging sessions.
It is possible to specify that the changes before or after a given date or session number are to be merged. For
example it is possible to merge all sessions before a given date or within a given week.
There may be a session that corresponds to a project milestone, which should be kept. These sessions can
be protected from deletion with the use of Stamps as described previously. Stamped sessions are not deleted
by the Merge command.
Merging the database sessions has no effect on any database references from other databases.
95
Copyright © 2015.
www.aveva.com
To merge sessions select Data > Change

Management > Merge Changes… from the
main menu to display the Merge Changes
form.
The pull-down at the top of the form has the

following options:
Selecting All Project databases will merge

all changes or changes before or after a
given time, date or session number.
Selecting System databases will merge

changes before or after a given time, date or
session number for the System Databases
only.
Selecting Single database allows the

administrator to choose a database from the
Available databases list.
Font Families
The System database stores details of four AVEVA product font families, numbered 1-4. These families may
be defined using ADMIN itself, or the commands can be included in the makemac.mac macro used to create
the project. All four families are used by DRAFT, but only the first is used by the other graphical modules.
 All AVEVA product font files have the suffix .gfb and are normally held in the AVEVA Everything3D
executable folder.
A font family combines a character set with a character style.
12.14.1 Character Sets
A character set is specified by name or by a CADC code number derived from its International Registration
(ISO-IR) number or from its ISO 8859 part number. The available character sets are:
Name Code Description

Latin 1 885901 ISO 8859-1 Latin alphabet No. 1
Latin 2 885902 ISO 8859-2 Latin alphabet No. 2
Latin Cyrillic 885905 ISO 8859-5 Latin/Cyrillic alphabet
UK 4 Standard UK ASCII (ISO 646 Reg 4)
US 6 Standard US ASCII (ISO 646 Reg 6)
Greek 18 ISO 2375 Registration 18

Cyrillic 37 ISO 2375 Registration 37
The ISO 8859 sets contain all the characters of the standard US ASCII set plus ranges of extra punctuation
marks, symbols, accents, accented characters, and combined characters.
96
Copyright © 2015.
www.aveva.com
Latin-1 provides additional characters for the following languages:
Danish Dutch Faroese Finnish
French Icelandic Irish Spanish
German Norwegian Portuguese Swedish.
Italian
Latin-2 provides additional characters for the following languages:
Albanian Czech German Hungarian Polish
Romanian Serbo-Croat Slovak Slovene
Latin/Cyrillic provides additional characters for the following languages:
Bulgarian Byelorussian Macedonian
Serbo-Croatian Ukrainian Russian
12.14.2 Character Styles
The character styles are also specified by name or code number. The available styles are:
Name Code
Line 1
Block 2
Serif 3
Italic 4
Script 5
Typewriter 6
UWLine 7 (Uniform Width Line)
Styles 1 to 5 are proportionally spaced, that is the spacing of the characters varies depending on the
characters.
Styles 6 and 7 have fixed spacing and so are better for the construction of lists or tables where items must line
up vertically.
Not all styles are available for every character set. An error will be output if a specified combination is not
available.
12.14.3 User-defined Fonts
A font family may also be defined by two user-supplied font files. One file is used to define the standard
character set and the second (optional) file to define a bold version of it. These user-supplied files must be in
AVEVA product font-file format and have the suffix .gfb. AutoCAD character shape files (.shp format) can be
converted to .gfb format using the Font Converter supplied as part of the AVEVA Software Developer's Kit.
For details contact the local AVEVA Support office.
12.14.4 Sloping Fonts
For each font family, the angle of slope between -85 and +85 degrees inclusive can be defined. This will cause
the text to be sloped forwards (positive angles) or backwards (negative angles).
97
Copyright © 2015.
www.aveva.com
12.14.5 Configuring Font Families
Selecting Project > Font Families… from the main menu

displays the Font Family Definitions form.
The Font Directory sets the folder where the font files are
stored.
The Current Font Settings show the four fonts that are
available. It shows whether they are System-defined or
User-defined, the character set (Type) and style.
The definition of the selected font in the list can be changed

using the settings on the form.
True Type Fonts
TrueType Fonts can be used on DRAW and Isodraft drawings. The permitted fonts must be defined in the
System Database by the Administrator.
Selecting Project > True Type fonts… from the main menu
displays the True Type fonts configuration form.
Clicking the Add button displays the Font form.
The required font, font style and size can be selected from
Font form.
Clicking OK button displays the True Type font details

form.
98
Copyright © 2015.
www.aveva.com
This form allows administrator to assign a Description and

Font ID to the selected font.
This can be modified at any time by clicking the Modify button

on the True Type fonts configuration form.
Clicking OK adds the entry to the True Types fonts list on the True
Type fonts configuration form.
The Font ID is automatically allocated by system.
Selecting a font in the grid and clicking the Make default button
makes the selected font the default, indicated by the square
brackets [5] around the font ID. Clicking the Dismiss button closes
the form.
Draw and True Type Fonts
True Type Fonts added to the System Database can be used in the AVEVA E3D Draw module. In Draw, when
creating or modifying text primitives, selecting the Text Editor button form the ANNOTATE tab allows the user
to select the Font style pull-down to displays the available True Type fonts.
Selecting the required font, then keying in the required text and then clicking the OK button sets the appropriate
font to the text.
 The Text Style can be utilised by a Draw visual style i.e. set as a default for particular styles
99
Copyright © 2015.
www.aveva.com
Isodraft and True Type Fonts
In Isodraft the Isodraft Option Files can now include True Type Fonts. As shown in the example below, the
Isodraft Option file has been updated to include True Type Fonts and the output type changed to PDF.
100
Copyright © 2015.
www.aveva.com
Draft Line Widths
System line styles can also be configured in the Administration Module.
The System defined line styles have a precise value based on the European & American ISO 128 standard.
The default values used in the AVEVA products are:
ISO128 Thin Medium Thick
Default Value 0.25mm 0.35mm 0.70mm
The hierarchy for System line styles can be seen in the Admin
Explorer.
A Line Style World (LSWL) owns a Line Style Width (LSWIDD)

element, which contains definition and attributes for Thin,
Medium, Thick line styles.
As these are defined by the system, no extra system line style

widths can be created. User Line Styles and widths can be
created in Draft.
 There is no GUI to configure System Line Widths in the

Admin Module. Any changes must be made using the
command window.
12.18.1 Draft Line Widths – A Worked Example
Using the Admin Explorer, navigate to the Line Style World (LSWL)
LSWL1 and expand the hierarchy.
Navigate to the Line Style Width Definition (LSWIDD)

LSWL/LSWIDD_THIN. Select Display > Attributes from the main
menu.
Note that the Line width LSWidth is initially displayed as 0.25mm
Click the text in the Attributes form and key in 0.3mm then enter.
Alternatively open a Command Window and key-in LSWidth 0.3mm.

The line width for the Thin style has now been set to 0.3mm. The
width can also be checked by typing PRECI 2 DP in the Command
Window to set the decimal places shown, then type Q LSWidth in the
Command Window.
101
Copyright © 2015.
www.aveva.com
Replicating Project
AVEVA Administration contains functionality that allows

administrators to replicate an entire project, or replicate the
structure of another project.
Two Replicate options are contained in the Project menu; Project

Data and Project Structure
12.19.1 Replicate Project Data – A Worked Example
The Project data option copies the current Project to a new Project. Before this option can be used the project
folders must exist and the environment variables for the copied project must be set. The new project code is
entered on the Replicate Project form. It is essential that the folder structure for the new project is identical
to that of the original project. This may require additional variables to be set when the project creation wizard
is used.
 A project must not be replicated outside AVEVA product suite by copying the whole of the Project folder
to another Project folder. This is because information about the project name is stored inside the DBs
themselves.
Use the Project Creation Wizard as described earlier to create a project called TCP (TCP), navigate to the
project folder TCP000 and delete ALL the folder with the exception of the Projectevars.bat file
Select Project > Replicate > Project data… from the main menu to display the Replicate Project form.
Select the Project Code TCP.
Click the OK button to replicate the project data
12.19.2 Replicate Project Structure – A Worked Example
The Project structure option creates a macro which can be run into AVEVA Administration to replicate only
the structure of the current project i.e. users, teams etc. No data is copied. When selecting this option, a file
browser is displayed so that the path name for the macro can be supplied.
ADMIN scans the System database and outputs to the file all the commands necessary to recreate the project
structure, in the following order: Create users, Create teams, Add users to teams, Create DBs, Make Copy
DBs, Create MDBs, Add DBs to MDBs and make them current if appropriate
Select Project > Replicate > Project structure… from the main menu to display the Replicate Project
Structure form.
Browse to the required location for the file and enter the required file name, the default file name is
ReplicateProj.mac. Click the Save button to create the macro in the specified location.
 This macro is often used as the basis for creating all new projects and is customised by each company
to suit their requirements.
102
Copyright © 2015.
www.aveva.com
The following is an example of a Replicate Project Structure macro:
It may be necessary to edit this file to modify User Names and Passwords to suit project requirements.
Passwords are never exported to the Project Replicate Macro.
103
Copyright © 2015.
www.aveva.com
104
Copyright © 2015.
www.aveva.com
CHAPTER 13
13 Overview of the Lexicon Module
The Lexicon module allows the system administrator to create and manage a number of User- Defined
attributes and element types. System attributes can also be managed allowing administrators to set valid
values and limits.
The Lexicon module allows the creation and management of status workflows, via User- Defined status values
and status change events. Database views can also be constructed within Lexicon, enhancing project
reporting methods and allowing for the use of distributed attributes in projects.
Entering Lexicon
As Lexicon is an Administrative module and

access is restricted to free users only.
Lexicon can be enetered in a similar manner

to the Admin module, however an MDB must
be specified.
The trainer will provide details for enetering

Lexicon but typically they will be as shown
below:
Project Training
Username SYSTEM
Password XXXXXX
MDB A-PIPING
Clicking the Lexicon tile will instigate the login process.

105
Data Hierarchy and Element Types
Elements created in Lexicon are stored in Dictionary (DICT) databases. To make elements created in Lexicon
appear in a project, the DICT database must be included in a project Multiple Database (MDB) using the Admin
module.
As with other AVEVA E3D modules, Lexicon elements are owned by other elements and must adhere to a
specific data hierarchy. Some minor variations exist in the Lexicon hierarchy; however the general hierarchy
is of the form shown. An Explorer is available within Lexicon and the hierarchy for a specific element can be
viewed within it.
Dictionary
Element
Element
Element
All elements created in Lexicon are owned by the top level element, the Dictionary World. Beneath the
Dictionary World a number of element specific Worlds can be created. In turn, the element worlds may own
element Groups. Worlds and Groups are administrative elements, providing a means of organising Lexicon
elements to meet project requirements.
A range of elements can be created within Lexicon which includes:
 User- Defined Attributes.
 User System Defined Attributes.
 User- Defined Element Types.
 Status Definitions and Values.
 Database Views.
Hierarchy details specific to each element will be considered later in the training guide. A brief description of
each element type is provided in the sections that follow.
106
Copyright © 2015.
www.aveva.com
User-Defined Attributes
A User-Defined Attribute (UDA) enables the Administrator to add new attributes to any element in the
databases of a project. A UDA can be used to add engineering data to elements for example “Designed”,
“Checked”, etc.
UDAs are created as elements in Dictionary databases inside a project. Because LEXICON databases are
project specific, it is possible to define attributes to suit individual project requirements.
Once defined, UDAs may be accessed in much the same way as normal attributes, including setting values,
querying and reporting upon these values. Utilities such as the Data Output and Project Reconfiguration
functions treat UDAs as they would any other attributes. UDAs can also be used in expressions.
13.3.1 User System Defined Attributes
A User System Defined Attribute (USDA) allows the administrator to place behaviour on a standard AVEVA
E3D element. For example, limits may be applied to the attributes of top level elements within AVEVA E3D.
A USDA allows the administrator to add the following behaviour to system attributes:
 Set valid values.
 Define limits.
 Hide attributes on forms.
 Category.
13.3.2 User- Defined Element Types
Within AVEVA E3D the standard set of elements are often used for a variety of purposes. A User- Defined
Element Type (UDET) allows an element to be created with a more meaningful name. UDETs allow Designers
to create real engineering items e.g. “Pumps”, “Towers” or Areas. UDETs are based on existing AVEVA E3D
Item Types.
13.3.3 Status Definitions and Values
Status Control provides Administrators with a means to control and report on the status of individual model
objects as they progress through their lifecycles. Status control can be applied to any AVEVA E3D element
used in the constructor modules e.g. Model, Paragon, Spooler, Diagrams, Draft, Tags.
The desired project workflow is created by the administrator as a Status Definition, or number of Status
Definitions, in the Lexicon module. Status Definitions own Status Values, which describe the stage of
development for the AVEVA E3D element concerned.
107
Copyright © 2015.
www.aveva.com
13.3.4 Database Views
Database views provide a way to consolidate data from elements and attributes distributed across databases
in an MDB.
These views are set up by an Administrator using the Database Views Editor and stored in the Lexicon
(DICT) database in a Database View World (DBVWWL). User database views may also be saved in a local
settings file. As well as the user definable views, each AVEVA E3D element type has its own Element View.
A Database View uses a table to define a view of the data, which may be derived from a single or multiple
elements. There is a row in the Database View table for each element of a particular type that meets the criteria
defined by filters. These filters use the same concept as the search grid. If the criteria cannot be expressed
using attribute filters, it is also possible to define an expression for evaluation. A row is present in the table
only if all the filter criteria are met.
Database Views provide a method to derive data structures for a variety of purposes, in particular List
definitions in the Engineering Tags module, as well as for the Report Designer.
Features of the Lexicon User Interface
When the UI is first accessed the left hand side of the UI is populated with the Dictionary Explorer and
Current Element Editor. The Search toolbar is also displayed beneath the main menus.
Space to the right hand side of the UI is gradually populated as other options, such as displaying Graphical
Views and Search Results, are selected from the Lexicon menus.
A number of functions are available from the main menu. An overview of the menu options is provided in the
sections that follow.
108
Copyright © 2015.
www.aveva.com
The Lexicon Menu
The Project tab options available

include getting and saving database
changes, switching to other modules,
and exiting the application.
The HOME tab
The HOME tab allows the user to select the forms that will display in the UI from the Display section.
The options available under the HOME tab are outlined below.
13.6.1 Create
The Create menu can be used to create Lexicon Elements. It is context sensitive depending on the CE
selected in the AVEVA E3D Hierarchy. This is illustrated in the examples below.
These options are available at World Level
109
Copyright © 2015.
www.aveva.com
The creation of a UDA and USDA are only available

when at UGRO Level
13.6.2 Modify
The Cut, Copy and Paste options on the Modify section on

the HOME tab are common AVEVA E3D functions and are
self-explanatory.
Modify menu lists a number of options relating to the

Lock/Unlock attribute of Lexicon elements.
 Subject to the type of element selected, some of the options may not be available.
Clicking the Database Views button form the

Modify Section of the HOME tab, displayed the
Database View Editor form, this is used to create
views on the AVEVA E3D database.
 This option is discussed in the TM-3652

Engineering Administration training guide.
13.6.3 Check
Validate is used to check the Lexicon Database for errors which must be corrected prior to using the Lexicon
data.
If validation is passed the following window will be displayed.
110
Copyright © 2015.
www.aveva.com
13.6.4 Search
Clicking the Search button from the Search section of the HOME tab will display or
hide the Search form. The form options are common across a number of AVEVA E3D
modules, allowing the searching, collection, display and editing of data.
The Search results are displayed in the Collections form.

This can also be opened by selecting the Collections button.
 This option is discussed in TM-1801 AVEVA

Everything3D™ (2.1) Foundations training guide.
13.6.5 Comment
The Comments button in the Configure section of the HOME tab displays the
CommentConfigurationForm. This form allows the Administrator to configure the relationship
between comment databases. Typically a Master and slave relationship is used.
 This option is discussed in Chapter 18 of this training guide –“Configure Comment

Databases”.
The TOOLS tab
The options available under the TOOLS tab are outlined below.
111
Copyright © 2015.
www.aveva.com
13.7.1 Display
Clicking the Command Window button from the Display section of the TOOLS tab
will display or hide the Command Window form. This option allows use of the
Command Window in Lexicon.
Clicking the Graphical View button from the Display section of the TOOLS tab will
display or hide the Graphical View form. To populate the form, the user should select the required element
from the Dictionary Explorer and then select Graphical View.
This example shows a Status Definition

workflow.
The example below shows User Defined Element Types

based on Equipment.
13.7.2 Explorers
Clicking the Dictionary button from the Explorer section of the TOOLS tab will
display or hide the Dictionary Explorer.
A list of elements held in the Lexicon Database is populated in the Dictionary

Explorer. Any element can be selected, copied, or deleted, by clicking the right
mouse button on the element.
112
Copyright © 2015.
www.aveva.com
The Context Sensitive menu is displayed when

using the right click. The options displayed will
vary depending on the element selected. For
example, if the Current Element (CE) is the
Dictionary World, the context menu is shown:
Example of the options when the CE is a UGRO Example of the options when the CE is a UGRO
(UDA Group). (UDA Group).
The MANAGE Tab
The options accessible under the MANAGE tab are explained below.
113
Copyright © 2015.
www.aveva.com
13.8.1 History
Clicking the DB Listing button form the History section of the

MANAGE tab will displays the DB Listing form, these are used to
capture the state of the database in the form of AVEVA E3D™
commands. All element data including all attributes, UDAs and
rules will be captured. They are similar in concept to XML output.
These files can then be read back in via the Command Window.
13.8.2 Access
Clicking the Claimlists button from the Access section of the

MANAGE tab will display or hide the Multiwrite Claim List form.
 This option is discussed in TM-1801 AVEVA Everything3D™

(2.1) Foundations training guide.
13.8.3 Pipe Stress Interface
Clicking the Update PSI Attributes button form the Pipe Stress Interface section of the MANAGE tab will
displays the Update PSI Attributes option. The update option enables users to upgrade the PSI UDAs.
114
Copyright © 2015.
www.aveva.com
13.8.4 Schematic Model Manager
This section consists of the UDA Catalogue and Attribute Mapping… buttons.
 The Schematic Model Manager section is discussed in TM-3542

AVEVA Diagrams (14.1) Schematic Model Manager (Administration) training
guide.
The UDA Catalogue is used to specify with User Defined

Attributes (UDAs) are available in each schematic database with
which Schematic Model Manager operates.
The Attribute Mappings system is used to

map system/project specific attributes, from
the source files (P&ID data) to schematic or
user-defined database attributes.
The Attribute Mapping window can be used

to view existing mappings and organise
mappings into attribute mapping groups.
The ENGINEERING tab
The ENGINEERING tab hosts a range of functions specific to administering projects that utilise AVEVA
Engineering. Consideration of these functions is outside the scope of this training course.
 Functions relating to the Engineering Tab are explained in TM-3652 AVEVA Engineering (14.1)
Engineering Administration training guide.
115
Copyright © 2015.
www.aveva.com
Current Element Editor
To display or hide the Current Element Editor form, right click on a specific element within the Dictionary
Explorer and select Current Element Editor. This form is used to edit the CE and dynamically tracks the
Dictionary Explorer. The displayed information changes depending of the type of element selected.
Example of a UWRL Example of a UDA
116
Copyright © 2015.
www.aveva.com
Exercise 8 – Exploring the Lexicon UI
1. Enter the AVEVA E3D Training project as described and explore the Lexicon menu options.
117
Copyright © 2015.
www.aveva.com
118
Copyright © 2015.
www.aveva.com
CHAPTER 14
14 User Defined Attributes
User Defined Attributes enable the AVEVA E3D system administrator to add new attributes to any element
in the databases of a project.
UDAs can contain Limits e.g. Temperature 1 – 200, or have Valid Values e.g. AREA01, AREA02, etc. applied
to them.
UDA Hierarchy
In order to create a User Definable Attribute (UDA) the user must first navigate to the correct place in the
Lexicon hierarchy. A UDA can only be created from a UDA World (UWRL) or UDA Group (UGRO).
With the Dictionary World selected as the CE, the user can create a new
UWRLD: User Defined attribute world using either the Create Button from the
Create section of the HOME tab or via the right click context menu in the Dictionary
Explorer.
A UGROUP: User defined attribute group and a UDA: User defined attribute are created in a similar way.

119
UDA Fields (Current Element Editor)
Once the UDA is created, the Current Element Editor form displays a number of fields associated with the
UDA. The fields are grouped into a number of categories. The fields relevant to each category are considered
in the sections that follow.
14.2.1 General
Fields grouped into the General category include some system generated values that cannot be directly
changed by the user (e.g. Owner). These fields appear in a lighter colour than fields that can be edited directly.
Fields that can be edited directly include:
Name The user can enter a valid name for the UDA in the Lexicon database. Special characters are
not allowed. Although the system will accept numeric values it is good practice to avoid using
them.
Lock This field determines whether or not the fields defining a UDA are locked. The field can be set
to True (locked) or False.
Description A brief description of the UDA can be provided to assist users.
Preditor Editor for property.
Convertor Convertor for property.
120
Copyright © 2015.
www.aveva.com
14.2.2 Basic Definition
Several fields relating to the Basic definition category are dynamic. The selections made in one field dictate
the values and other fields displayed in the Current Element form.
Abbreviation length This field defines the minimum number of characters that the attribute name can be
shortened to for use in commands and attribute entry fields. For example, if the UDA
Name is DIAGRAM, and the Abbreviation Length is 5, the user must type 5 characters
to define the UDA (e.g. DIAGR). The abbreviation name must be less than or equal
to the number of characters used in the User - Defined Name and must be unique in
its own right.
Uda type Subject to the type chosen, other relevant fields will be displayed accordingly. This is
demonstrated in the examples that follow.
Consider first a Uda type set to logical.
The Uda default value can then only be set as either ‘True’ or ‘False’.
If the user selects the Uda type of reference, then the Referred types field is displayed (and the UDA Default
field is not).
121
Copyright © 2015.
www.aveva.com
The Referred types field can be populated from the Select element types form. This form allows users to
select the required elements from a pre-populated list.
A filter is available to assist users in making an appropriate selection.
If the Uda type is set to real the Uda units can be set.
122
Copyright © 2015.
www.aveva.com
Element types
This is the AVEVA E3D element that the UDA will be applied to e.g. Pipe, Equipment, Drawing, etc.
As with Referred elements, there is a filter option to help users select the required Element Types.
Pseudo attribute Setting this logical attribute to True will indicate the UDA is pseudo attribute. Pseudo
attributes allow for dynamic values to be returned as needed, rather than having static
values stored in the database.
The code required to return a pseudo attribute value must be plugged in through the
use of the C# API and is out of the scope of this guide.
Indexed uda The indexing of UDA’s is controlled by the UTABLE attribute on the UDA definition
in the dictionary DB. If this is set to True then the UDA will be indexed. Indexing is
allowed for text, reference and integer UDAs only.
User- defined name This allows the user to enter a name that will be given to the UDA of the element it
will be created for. It should be set to a similar name as the UDA.
Special characters are not allowed for UDA names. Although the system will accept numeric values it is good
practise to avoid using them.
14.2.3 Presentation
The fields within the Presentation category remain the same irrespective of the type of UDA created. A brief
description of each field is provided below.
Reporter text A text attribute used to define the default column heading used in reports. This field
can be up to 20 characters in length.
Uda category This can be used to Group UDAs together within the Modify Attributes form.
Hidden If this field is set to True the data will be hidden from the user.
Hyperlink If this field is set to True the text value of a UDA will be allowed to contain a path to
an external file.
Connection If this field is set to True it indicates that the UDA is a connection in the reference list.
123
Copyright © 2015.
www.aveva.com
14.2.4 Protection
The Protection category only contains one field relating to the UDA.
Protected If this field is set to True, and the UDA is to be stored in a protected database, it will
not be viewed.
14.2.5 Design
The Design category only contains one field relating to the UDA.
Valid values Depending on the type of UDA created, numeric values, a range of values, or text
strings can be set in this field. Items must be separated by a suitable delimiter specific
to the type of value being entered. To assist this process, the Edit Valid values form
can be opened from the valid value entry cell.
14.2.6 Miscellaneous
The Miscellaneous category only contains one field relating to the UDA.
Limits or valid values optional flag If this field is set to True the limits or valid values set in the
form are optional.
List of value usage Defines the use of the list of values for a UDA, as Single or
Multiple select
124
Copyright © 2015.
www.aveva.com
Creating User- Defined Attributes – A Worked Example
The following example creates three UDAs: Designed, Checked, and Approved. The UDAs will be assigned
to PIPE, EQUIP, SHEET, and SPLDRG AVEVA E3D elements.
14.3.1 Setting up the Training Environment
Before creating the elements in this worked example the training environment in Lexicon needs to be updated.
Select the Setup button from the Training section of the TOOL tab to display the Training Setup form, then
navigate to the Lexicon tab.
Check the Setup Training Course checkbox, click the Apply button and close the form.
14.3.2 Creating a UDA World (UWRL)
Setting the training environment has created a Lexicon Dictionary database world called UWRL-
PROJECT/DICT. This database will be used in the exercices and examples that follow.
However, if a new UDA World is required it can be created by following the steps outlined here.
From the Dictionary Explorer, navigate to the

Dictionary WORL * then click the right hand button
of the mouse.
From the resulting context menu select:
Create > UWRLD: user defined attribute world
Using the Current Element Editor to set the Name

and the Description as follows.
Name: UWRL-TRAINING
Description: UWRL Training
125
Copyright © 2015.
www.aveva.com
14.3.3 Creating a UDA Group (UGRO)
Navigate to the UDA World /UWRL-PROJECT/DICT.
From the right-click context menu select:
Create > UGROUP: User defined attribute

group
Using the Current Element Editor set the following:
Name UGRO-TRAINING
Description UDA Group Training
14.3.4 Creating a User Defined Attribute
Navigate to the UDA Group UGRO-TRAINING.
From the right click context menu

select:
Create > UDA: User defined

attribute
126
Copyright © 2015.
www.aveva.com
Enter the following values into the appropriate fields:
Name DESIGNED
Description Designed
Abbreviation length 8
UDA type text
UDA length 15
User-define name DESIGNED
Reporter text Designed
Select the Element types icon
This will display all available types. Reduce the selection displayed using the Filter Option.
Filter EQUIP
Select EQUIPMENT and then click the Add to list button.
127
Copyright © 2015.
www.aveva.com
Repeat the process for the PIPE, SHEET and SPLDRG

element types.
Click the OK button
On the new UDA DESIGNED select:
Create > UVALID: User defined valid

value
Enter the following information:
Description JOE BLOGS
Uda value JB
The process should be repeated for: JJ - JIMMY JAMES, and FS - FRED SMITH.
Also set the Limits or Valid values Optional flag of the UDA to True.
128
Copyright © 2015.
www.aveva.com
The UDA should now be set as follows.
In a similar way UDAs Checked and Approved can be

created.
Save work.
129
Copyright © 2015.
www.aveva.com
Exercise 9 - Creating and Using UDAs
1. Create the UDAs Checked and Approved and assign them to “PIPE”, “EQUIP”, “SHEET” and
“SPLDRG”.
2. Check that you can add information in AVEVA E3D Model, Draft or Spooler. Set the Limits or Valid
values Optional flag to TRUE on Designed and Checked but to False on APPROVED.
3. In the Model Explorer of AVEVA E3D Model module navigate to a Pipe, click the right mouse button
and from the context sensitive menu select Attributes…
From the Attributes form try setting :DESIGNED, :CHECKED and :APPROVED to valid and invalid values
130
Copyright © 2015.
www.aveva.com
CHAPTER 15
15 User System Defined Attributes
A User System Defined Attribute (USDA) allows the administrator to place behaviour on a standard AVEVA
E3D element. For example limits may be applied to attributes of top level elements within AVEVA E3D.
A USDA allows the administrator to add the following behaviour to system attributes:
 Set valid values
 Define limits
 Hide attributes on forms
 Category
The valid values and limits may be varied with element type. These values are defined by creating a USDA
element in the dictionary database.
USDA Hierarchy
In order to create a User System Definable Attribute (USDA) the user

must navigate to a UDA Group (UGRO).
USDA Definition
A number of fields are associated with the definition of a User System Defined Attribute. A brief description of
each field is provided below.

131
Name The name by which the USDA will be referred to in the AVEVA E3D modules.
Description A Text attribute which may be used to give a description of the USDA.
System attribute Underlying system attribute to which the USDA is to be applied.
Element types A logical attribute, if set to true the USDA will be applied to all AVEVA E3D elements
with the attribute defined in USYSTY ELEL – an Array containing a list of AVEVA E3D
elements to apply the USDA to.
Uda category This field allows the administrator to group USDAs on the Attributes form within
AVEVA E3D modules, e.g. UCAT ‘MYCATAGORY’. If UCAT is left unset then it has
no effect.
Hidden On setting this logical attribute to True will indicate that the USDA will be hidden from
the ‘Q ATT’ command and from the attribute form within AVEVA E3D. Querying of the
individual UDA will not be affected by this setting.
Teams If the UHIDE (Hidden) attribute has been set then the UTEAMS (Teams) attribute can
be used to indicate which teams the USDA will be available too. UTEAMS can hold
an array of values.
15.2.1 USDA Limits and Valid Values
A USDA may own ULIMIT and UVALID elements to denote the limits and valid values.
These are described in Valid Values and Creating a USDA.
Creating a USDA – A Worked Example
The following example will restrict the FUNC attribute

on EQUIPMENT to be 'Heatx' or 'Pump'. Create a
USDA as follows.
A new UDA World is required, navigate to the

Dictionary WORL *.
Using the right click context menu select: Create >

UWRLD: User- Defined attribute world.
Use the Current Element Editor to set the Name and the Description as follows.
Name USWRL-TRAINING
Description System Attribute World
132
Copyright © 2015.
www.aveva.com
Navigate to the UDA World USWRL-TRAINING
Using the right click context menu select:
Create > UGROUP: User Defined attribute

group
Set the following:
UDA Name USDA-GROUP
Description Training System Attribute Group
Navigate to the UDA Group USDA-GROUP
Using the right click context menu select:
Create > USDA: User system defined attribute
In a similar way to the creation of a UDA the following should be set:
Name UFUNC
Description Set restriction on FUNC attribute

on EQUI
System attribute FUNC
Element types EQUIPMENT
133
Copyright © 2015.
www.aveva.com
With the New USDA UFUNC selected as the

Current Element:
right click and from the context sensitive

menu select Create > UVALID: User defined
valid value
Description Pump
UDA VALUE PUMP
Repeat for “Heat Exchanger”, HEATX
UFUNC is set as shown
The following is an example of limiting the Temperature

range on a Pipe and Pipe Branch.
Name ULIMITTEMP
Description Set Temp Limits on a Pipe & Branch
System Attribute TEMP
Element Types BRANCH PIPE
134
Copyright © 2015.
www.aveva.com
With the New USDA ULIMITTEMP

selected as the Current Element, right
click and from the context sensitive menu
select Create > ULIMIT: User defined
limit
Description Temperature Range
Minimum Value -50
Maximum Value 500
The ULIMITTEMP should now be set as shown.
135
Copyright © 2015.
www.aveva.com
Exercise 10 - Creating and Using USDAs
1. Using the described Worked Example create the USDA “UFUNC” and “ULIMITTAEMP” and test
them in AVEVA E3D Model.
Within AVEVA E3D Model explorer, Navigate to Equipment and Select Attributes located in the Display
section of the HOME tab.
Valid Values are available in a Pull down.
In AVEVA E3D Model module navigate to a Pipe, click the right mouse button and from the context sensitive
menu select Attributes…
Try setting Temperature to 50 and -200.
136
Copyright © 2015.
www.aveva.com
CHAPTER 16
16 User Defined Element Type
Within AVEVA E3D the standard set of elements are often used for a variety of purposes. A User Defined
Element Type (UDET) allows an element to be created with a more meaningful name. UDETs allow Designers
to create real engineering items e.g. “Pumps”, “Towers” or Areas. UDETs are based on existing AVEVA E3D
Item Types.
UDET Hierarchy
In order to create a User Defined Element Type (UDET) the user must navigate to the correct place in the
Hierarchy, i.e. a UDET World (UDETWL) or UDET Group (UDETGR).
UDET Definition.
A number of fields are associated with the definition of a User Defined

Element Type.
A brief description of each field is provided in the sections that follow.
General:
The fields available in the General section are described below.
Name This allows the user to enter a valid name for the UDET in the Lexicon database. Special
characters are not allowed and only alphabetic characters are allowed.
Description This allows the user to add a descriptive phrase to the UDET.

137
16.1.1 Basic Definition
The fields available in the Basic Definition section are described below.
User-defined name This allows the user to enter a name that will be given to the element for which
the UDET is created. It should be set to the Name of the UDET. But the user
is allowed to change the UDET Name if required.
Special characters are not allowed for the UDET name and only alphabetic
characters are allowed.
Base Type This allows the user to select the System Type that the UDET will be based
on.
There is a filter option to assist with element selection.
16.1.2 UDET Hierarchy
The fields available in the UDET Hierarchy section are described below.
Owner Types The UDET Owners list is automatically populated with the list of valid owners
based on the Base Type selected.
The User can remove valid owners from the list using the
tick box.
There must be at least one owner.
138
Copyright © 2015.
www.aveva.com
Member Types The UDET Members list is automatically populated with the list of valid
members based on the Base Type selected.
The user can remove valid members from the list using the
tick Box.
Creating a User- Defined Element Type (UDET) – A Worked Example
In the following example a Tank and Tower are created based on a AVEVA E3D base type of Equipment.
16.2.1 Creating a UDET Element World (UDETWL)
Using the Dictionary Explorer, navigate

to the Dictionary worl *.
From the the right-click context sensitive

menu select:
Create > UDETWL: User defined

element world
In the Current Element Editor enter the following:
Name TRAINING/UDETWL
Description Training Detail World
139
Copyright © 2015.
www.aveva.com
16.2.2 Creating a UDET Group (UDETGR)
Using the Dictionary Explorer,

navigate to the UDETWL
TRAINING/UDETWL, then using
the right click context sensitive
menu select:
Create > UDETGR: User defined

element group
Use the Current Element Editor to set the following:
Name EQUIP/UDET/GROUP
Description Equipment UDET Group
16.2.3 Creating a User Defined Element Type (UDET)
Now navigate to the UDETGR EQUIP/UDET/GROUP
From the right click context sensitive menu

select:
Create > UDET: User defined element
Use the Current Element Editor to set the following:
Name TANK
Description Tank
User-defined name TANK
Base Type Select Browse Icon
140
Copyright © 2015.
www.aveva.com
This will display all available types. The selection can be reduced
using the Filter option.
Filter EQUI
Select EQUIPMENT
The Owner types, Member types and Hidden attributes can be left set to default.
The operation can be repeated for TOWER.
141
Copyright © 2015.
www.aveva.com
Exercise 11 - Creating and Using UDET’s
1. Using the above example, create a Tank and Tower element based on Equipment and test its use in
AVEVA E3D Model.
2. In AVEVA E3D Model, change to the EQUIPMENT application, now using the Model Explorer
navigate to the ZONE ZONE-EQUIPMENT-AREA01 and then from the Create section on the
EQUIPMENT tab, select the Equipment options button select the Standard option. The Create
Equipment form is displayed, select TANK from the User Define Type Pull down list.
 The Command Line Syntax in AVEVA E3D Model would be NEW :TANK.
142
Copyright © 2015.
www.aveva.com
CHAPTER 17
17 Configure Comment Databases
Comment databases are linked together so that Designers are able to view Comments created and updated
by others. They can then add posts to Comment Thread even if the Thread was created in another database.
For the purposes of the Training two Comment databases have been created one to be used by the North
Area Designers and one for the South Area Designers.
Storing comments is separate databases gives added security and is very useful for Global working using the
AVEVA Global system.
There is also no need to use extract databases when working with Global.
 See TM-1861 AVEVA Administration - System Administration for Information on Extract Databases.
 See TM-1863 AVEVA Global - Administering Global Projects for information on AVEVA Global.
Creating Model View Worlds (Lexicon) – Worked Example
Model View Worlds (MVIWLD) are used to store Screen shots and Pictures associated with the Comments.
They can be created in Lexicon.
 Currently there is no user interface for the operation and it is necessary to create them using the
Command Window.
Login to AVEVA Everything3D with the

Project: Training
Username: SYSTEM
Password: TAD
MDB: ALL
Click the Lexicon tile.

143
Select Command Window from the Display Group on the TOOLS Tab.
In the Command window Navigate to the Comment Worlds and create the Model View Worlds.
OLD CMTWLD /COMMENTN/COMMENT
NEW MVIWLD /COMMENTN/MVIWLD
OLD CMTWLD /COMMENTS/COMMENT
NEW MVIWLD /COMMENTS/MVIWLD
Configure Comment Databases
From the Configure Group on the HOME Tab select Comments.
The Comment Worlds created earlier are

displayed.
Comment databases are linked together

using a Master and several slaves.
For the Purposes of the Training

COMMENTN/COMMENT will be the
master and COMMENTS/COMMENT will
be the Slave
144
Copyright © 2015.
www.aveva.com
Select COMMENTN/COMMENT using the Right Hand Mouse Button and Select Open
Select COMMENTS/COMMENT to be the Slave of COMMENTN/COMMENT, then Click the OK button to

close the form.
Click the Close button to close the Comment Configuration Form.
Exit Lexicon, Select the Project tab and then click the Exit button. A Question form appears “Save changes,
before leaving Lexicon and Exiting?” click the Yes button.
145
Copyright © 2015.
www.aveva.com
UDA’s on Comment Threads
UDA’s on Comment Threads are limited to Text and Valid values, the UDA’s can be single or Multi-select.
17.3.1 Adding a User Defined Attributes to a Comment Thread – A Worked Example
From the Dictionary Explorer, navigate

to the Dictionary WORL * then click the
right hand button of the mouse.
From the resulting context sensitive

menu select:
Create > UWRLD: user defined

attribute world
Using the Current Element Editor to set the Name and

the Description as follows.
Name: CommentWorld
Description: Comment UDA World
From the Dictionary Explorer, navigate

to the UWRL CommentWorld then click
the right hand button of the mouse.
from the resulting context sensitive

menu select:
Create > UGROUP: User defined

attribute group
146
Copyright © 2015.
www.aveva.com
Using the Current Element Editor to set the Name and

the Description as follows.
Name: CommentThreadGroup
Description: Comment Thread Group
From the Dictionary Explorer,

navigate to the UGRO
CommentThreadGroup then click the
right hand button of the mouse.
from the resulting context sensitive

menu select:
Create > UDA: User defined

attribute
Using the Current Element Editor to set the following.
Name: CommentThreadEstimate
Description: Estimate
Abbreviation Length: 8
Uda type: text
Uda length: 4
Element type: CMTTHR
User-defined name: Estimate
Reporter text: Estimate
Uda category: Comment
Valid values: 1 2 3 4 5 6 7 8 9 10
List of value usage: SingleSelect
 The list of value usage can be Single or Multi-select.
 For the Valid values area to appear on the Curent

Element Editor form, click away from the UDA in the
Dictionary Explorer and then select the UDA again once
the Uda type has been changed to text
Save Work
147
Copyright © 2015.
www.aveva.com
17.3.2 Testing Comment UDA’s in Model
Navigate back into AVEVA E3D 2.1 Model and select the Comments button from the Display section of the
HOME tab.
The Comments form is displayed, now from the Model Explorer
select EQUI D1201 and then click the button on the Comments
form.
Select the Current Element.
Click the More button.
148
Copyright © 2015.
www.aveva.com
The Estimate Valid values that were created previously are now
available.
149
Copyright © 2015.
www.aveva.com
150
Copyright © 2015.
www.aveva.com
CHAPTER 18
18 Adding Comments In Model
Comments can be added to elements in the design Model. These Comments can be used in conjunction with
AVEVA Insight2.1 the AVEVA mobile application.
Elements with comments can be highlighted and reported using the AVEVA Report Application.
Adding Comments – A Worked Example
Display the Piping and Equipment created in the previous example login to AVEVA Everything3D with the
following credentials: Project: Training, Username: EQUIPN, Password: EQUIPN, MDB: EQUIP.
Navigate to VESSEL1 and display the Comments Form from the Display Group of the HOME Tab.
Currently there are no Comments in the Model.
Comments can be shown for Current Element, Current Selection

or Drawlist.
There is also an option to display Comments that have been

orphaned perhaps by the Design Element that they were
attached to being deleted.

151
With VESSEL1 as the Current Element Pick the Plus

Button and Select Current Element
Clicking the OK button will create a comment on VESSEL1
Add a Subject Painting
Please Paint Red
Priority High
Pick More
Action MechanicalEng & Equipment
Department MechanicalEng
152
Copyright © 2015.
www.aveva.com
18.1.1 Adding Captured Images and Attachements
The Designer can add Captured Images or external files to the comment. Select Capture
A new Graphical Window

is Displayed Annotation
can be added to the
Captured image.
Add Some Annotation and
Pick to save the

Capture.
Files can be attached using the option and the Comment
is saved by Selecting.
153
Copyright © 2015.
www.aveva.com
Filtering Comments
Comment can be filtered from a pre-defined list created in
Lexicon by the System Administrator by Picking .
Comment Highlighting
Comment Thread can be Highlighted on the Graphical Screen

by Selecting the Thread Display for example Drawlist and
Picking
 It is possible to add comments to element that are

not in the Graphical Drawlist, these element will not be
highlighted.
154
Copyright © 2015.
www.aveva.com
 If the background colour makes the translucent elements differcult to see, there is a Option in the Current
View settings to Outline Translucent elements.
155
Copyright © 2015.
www.aveva.com
Exercise 12 - Comments
1. Using the above as an example create Comments on database elements, confirm that Comment
Threads can be updated by different users and that Comment Captures can be stored.
2. Use the Filter option to Identify Comments and Highlight to display them on the Graphical Display.
156
Copyright © 2015.
www.aveva.com

TM-1860 AVEVA Administration (1.4) Fundamentals Rev 2.0

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TM-1860 AVEVA Administration (1.4) Fundamentals Rev 2.0

Uploaded by

Copyright:

Available Formats

Training TM-1860

This page is intentionally left blank.

Date Rev Description Author Reviewed Approved

19/10/15 0.1 Issued for Review WR

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

@AVEVA Solutions Limited 2015

Copying Databases ......................................................................................................................... 41

User Messages ............................................................................................................................ 92

14.3.3 Creating a UDA Group (UGRO)............................................................................................... 126

 Set up new AVEVA Plant Projects, including databases access control.

 Control User access to various AVEVA Plant product modules.

Using this guide

Information the user has to key-in will be in bold red text.

Annotation for trainees benefit

 Refer to other documentation

This page is intentionally blank.

This chapter explains how to create a new AVEVA Project.

Project Creation Wizard – A Worked Example

This displays the Project Creation Wizard form .

Set the address to C:\Users\Public\Documents\AVEVA\Projects\E3D2.1\Training.

Right clicking on a list entry displays a

Click the Cancel button to dismiss the form.

Click the Details… button to display the

This form enables additional data to be

The Number textbox is automatically

Enter the following data in the appropriate textboxes:

Name Administration Training Project

AVEVA Environment Variables

2.3.1 The Evars Batch File

2.3.2 Environment Variable ‘AVEVA_DESIGN_WORK’

2.3.3 Environment Variable ‘AVEVA_DESIGN_USER’

The default path is as shown C:\Users\Public\Documents\AVEVA\USERDATA\

 There should be no spaces at the equal (=) sign.

2.3.4 Environment Variable ‘PMLUI’

For the purposes of training, this is currently also set to C:\AVEVA\Plant\PlantTraining2.1\Training\pmlui.

2.3.5 Environment Variable ‘PMLLIB’

For the purposes of training, this is currently set to C:\AVEVA\Plant\PlantTraining2.1\Training\pmllib.

This folder structure contains forms, objects, and functions.

2.3.6 Serialisation Files

C:\Users\<user name>\AppData\Local\Aveva on Windows 7 systems, where <user name> is the users

This page is intentionally left blank

AVEVA Product Structure

Admin Project and User administration.

New Project Project creation wizard

Draw 2D drawing Production.

Isodraft Isometric drawing production.

Spool Pipe spooling.

Paragon Catalogue and Specification construction.

Propcon Element and component properties.

Typical AVEVA Project Design Teams

Discipline North Area Pipe Bridge South Area

Piping PIPEN PIPEPB PIPES

Equipment EQUIPN EQUIPPB EQUIPS

Structural STEELN STEELPB STEELS

Civil CIVN CIVPB CIVS

Heating and Ventilation HVACN HVACPB HVACS

Electrical ELECN ELECPB ELECS

Instrumentation INSTN INSTPB INSTS

Typical Project Databases

Isodraft (ISOD) Databases which contain spool drawings produced by SPOOLER.

Schematic (SCHE) Databases used by PID 3D Integrator.

CrossProduct (XPRD) Database is currently used to store comments.

3.4.1 Typical 3D Design Databases