AVEVA Diagrams

(14.1.SP3)

11 A
2

TRAINING GUIDE
- 2 NIC
/2
22 TEC

Diagrams
8/
/1 SIN

Administration
23 er:
1/
te: m
Da sto
Cu

TM-3534

www.aveva.com
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 2 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Revision Log
Date Revision Description of Revision Author Reviewed Approved
27/09/2013 1.0 Issued for Training 12.1.SP4.1 SR KA GC
20/07/2015 2.0 Issued for Training 14.1.0 KI,HU JB GC
08/02/2017 3.0 Issued for Training 14.1.SP1 DA, NH, VT VT GC
Issued for Training 14.1.SP2 & MB,KI,CS,
02/08/2019 4.0 RD GC
14.1.SP3 TA,BV

Updates
All headings containing updated or new material will be highlighted.

Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers please report it to the AVEVA
Training and Product Support at [email protected]

11 A
2
This manual provides documentation relating to products to which you may not have access or which may

- 2 NIC
not be licensed to you. For further information on which products are licensed to you please refer to your

/2
licence conditions.
22 TEC
Visit our website at http://www.aveva.com
8/
/1 SIN

Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
23 er:

from viruses.
1/
te: m

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
Da sto

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
Cu

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.

Copyright © 2013. 3 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

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.

11 A
2
@AVEVA Solutions Limited 2015

- 2 NIC
/2
Trademark Notice
22 TEC
8/
AVEVA™, AVEVA Everything3D™, AVEVA E3D™, AVEVA Engineering™, AVEVA Diagrams™, Tribon and
all AVEVA product and service names are trademarks of AVEVA Group plc or its subsidiaries.
/1 SIN

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
23 er:

unauthorised use may result in a legal claim being made against you.
1/

Fluent is a trade mark of Microsoft Corporation. The Fluent user interface is licensed from Microsoft
te: m

Corporation by AVEVA and use of the Fluent trade mark is strictly forbidden.
Da sto

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

Copyright © 2013. 4 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Contents

1 Introduction .............................................................................................................................................. 9
1.1 Aim..................................................................................................................................................... 9
1.2 Objectives ......................................................................................................................................... 9
1.3 Prerequisites .................................................................................................................................... 9
1.4 Course Structure .............................................................................................................................. 9
1.5 Using this guide ............................................................................................................................... 9
2 Introducing AVEVA Diagrams Administration .................................................................................... 11
2.1 AVEVA Diagrams Administration Overview ................................................................................ 11
2.2 Creating a New Project – A Worked Example ............................................................................. 11
2.3 Setting up Project Databases. ...................................................................................................... 14
2.3.1 Create Teams – A Worked Example........................................................................................ 14
2.3.2 Create Users – A Worked Example ......................................................................................... 16
2.3.3 Create Diagrams Databases- A Worked Example................................................................... 17
2.3.4 Multiple Database (MDB) Setup- A Worked Example ............................................................. 20
Exercise 2– Database Creation .................................................................................................................... 22
3 AVEVA Diagrams Project Data Configurations .................................................................................. 23
3.1 System Definitions ......................................................................................................................... 23

11 A
2
3.2 Units Configuration........................................................................................................................ 26

- 2 NIC
/2
3.3 Defining Naming Rules .................................................................................................................. 27
3.3.1 Inserting a Rule (A Worked Example) ...................................................................................... 27
3.3.2 Modifying a Rule....................................................................................................................... 30
22 TEC
3.3.3 Removing a Rule ...................................................................................................................... 31
8/
Exercise 3– AVEVA Diagrams Project Data Configuration ....................................................................... 32
4 Project Drawing Configuration ............................................................................................................. 33
/1 SIN

4.1 Drawing Documents Configurations............................................................................................ 33

4.2 Diagram Templates ........................................................................................................................ 33
4.2.1 Creating a New Template – A Worked Example ..................................................................... 34
4.2.2 Drawing Template Settings ...................................................................................................... 37
23 er:

4.2.3 Background Template Setup .................................................................................................... 40

1/

4.3 Drawing Stencil .............................................................................................................................. 42

te: m

4.3.1 Create a new Stencil – A Worked Example ............................................................................. 42

4.4 Importing Stencils and Drawings ................................................................................................. 43
Da sto

Exercise 4– Project Drawing Configuration ................................................................................................ 44

5 Creating Symbols .................................................................................................................................. 45
Cu

5.1 Creating Microsoft Visio Shapes - Overview .............................................................................. 45

5.1.1 Create a Branch Symbol - A Worked Example ........................................................................ 46
5.2 Create a Flow Direction Symbol ................................................................................................... 50
5.2.1 Create a Flow Direction Symbol - A Worked Example ............................................................ 51
5.3 Create an Inline Fitting Symbol for Piping – A Worked Example ............................................. 55
5.3.1 Create a Multiport Valve ........................................................................................................... 56
5.4 Create an Inline Fitting Symbol for HVAC ................................................................................... 60
5.5 Create an Elconn Symbol for Cables – A Worked Example ...................................................... 61
5.6 Create Equipment Symbol ............................................................................................................ 64
5.7 Create a Nozzle Symbol ................................................................................................................ 66
5.7.1 Create a Nozzle Symbol - A Worked Example ........................................................................ 66
5.8 Creating Grouped Shapes ............................................................................................................. 69
5.9 Instrument Relationship Shapes .................................................................................................. 70
5.9.1 Instrument Relationship Symbol - A Worked Example ............................................................ 70
5.10 Create an Area Shape .................................................................................................................... 73
5.10.1 Create an Area Shape - A Worked Example ........................................................................... 73
5.11 Create a Title Block Shape ............................................................................................................ 77
5.11.1 Create a Title Block Shape - A Worked Example .................................................................... 77
5.12 Create a Revision Block Shape .................................................................................................... 80
5.12.1 Create a Revision Block Shape - A Worked Example ............................................................. 80
5.13 Create a Revision Mark Shape ...................................................................................................... 83
5.13.1 Create a Revision Mark Shape - A Worked Example .............................................................. 84

Copyright © 2013. 5 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.14 Shape Protection............................................................................................................................ 89

5.14.1 Shape Protection – A Worked Example ................................................................................... 89
Exercise 5 – Defining Shapes Configuration .............................................................................................. 94
6 Create Shapes with Special Features in Microsoft Visio ® ................................................................. 95
6.1 Create Double Sided Connector Line - A Worked Example ...................................................... 96
6.2 Creating a Label with an Attachment Line – A Worked Example ........................................... 102
6.3 Creating a KKS Flag Annotation – A Worked Example............................................................ 107
7 Diagrams Rules .................................................................................................................................... 111
7.1 Consistency Check Rules ........................................................................................................... 111
7.2 Auto Formatting Rules – A Worked Example ........................................................................... 115
8 Link Documents ................................................................................................................................... 119
8.1 Configuring the Links Hierarchy – A Worked Example ........................................................... 120
8.2 Adding Document Links – A Worked Example ......................................................................... 121
8.3 Assigning a Class – A Worked Example ................................................................................... 123
8.4 Displaying Links – A Worked Example ...................................................................................... 123
Exercise 6 – Linked Document ................................................................................................................... 124
9 Reporting Schematic Data .................................................................................................................. 125
9.1 Visio Report .................................................................................................................................. 125
9.1.1 How to Create Visio Report – A Worked Example................................................................. 126
9.2 Report Designer ........................................................................................................................... 128
9.2.1 How to Create Report Template via Report Designer – A Worked Example ........................ 128

11 A
2
Exercise 7 – Report ..................................................................................................................................... 137

- 2 NIC
/2
10 Status Control Configuration.......................................................................................................... 139
10.1 Overview ....................................................................................................................................... 139
10.2 Creating a Status World - A Worked Example .......................................................................... 140
22 TEC
10.3 Creating a New Status Definition - A Worked Example ........................................................... 141
8/
10.4 Creating a New Status Value ...................................................................................................... 142
10.5 Setting the Transitions - A Worked Example ............................................................................ 143
Exercise 8 – Status Control Configurations ............................................................................................. 145
/1 SIN

11 Revision Control Configuration ..................................................................................................... 147

11.1 Revision Number Definition – A Worked Example ................................................................... 148
11.2 Revision Block Definition – A Worked Example ....................................................................... 153
23 er:

11.3 Revision Configuration Definition – A Worked Example ......................................................... 155

1/

Exercise 9 – Revision Configurations ....................................................................................................... 158

te: m

12 Project Explorer ............................................................................................................................... 161

12.1 Flexible Explorer node configuration structure ........................................................................ 162
Da sto

12.2 Configure Project Explorer ......................................................................................................... 163

12.2.1 Creating a PBS World (PBSWLD) – A Worked Example ...................................................... 163
12.2.2 Creating a PBS Template (PBSTPL) – A Worked Example .................................................. 163
Cu

12.2.3 Creating a PBS Object (PBSOBN) – A Worked Example ..................................................... 165

12.2.4 Creating a PBS Object (PBSOBN) – A Worked Example ..................................................... 166
12.2.5 Configure nodes for Element Members – A Worked Example .............................................. 171
12.2.6 Configure nodes for Secondary Classes – A Worked Example ............................................ 173
12.2.7 Creating a PBS Criteria Node (PBSCRT) – A Worked Example ........................................... 176
12.3 Configure Project Explorer (Unassigned items) ....................................................................... 177
12.3.1 Creating an Unassigned node – A Worked Example............................................................. 177
13 Appendix A - Optimising Project Performance and Storage Space ........................................... 183
13.1 Recommendations to Improve Performance of Save Work .................................................... 183
13.2 Refresh Performance ................................................................................................................... 183
13.3 Project Storage with Respect to Visio and SVG Files .............................................................. 184
14 Appendix B - Annotation and PML1 Expressions ........................................................................ 185
14.1 Attribute Presentation Notation .................................................................................................. 185
14.2 PML1 Expressions ....................................................................................................................... 185
15 Appendix C – Diagrams Customisation ........................................................................................ 187
15.1 Shape Context Menu (Shape Sheet Action Section) ................................................................ 187
15.1.1 PML Function ......................................................................................................................... 188
15.1.2 Command Execute ................................................................................................................. 188
16 Appendix D – Schematic Model Viewer Icon Configuration ........................................................ 191
16.1 Icons .............................................................................................................................................. 191

Copyright © 2013. 6 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

17 Appendix E – Project Upgrade ....................................................................................................... 195

17.1 Upgrade Drawing ......................................................................................................................... 195
17.2 Upgrade Database........................................................................................................................ 195
17.3 Upgrade Diagrams Options ........................................................................................................ 195
18 Appendix F – Batch Update ............................................................................................................ 197
19 Appendix G – Copy Data Between Database ................................................................................ 203
19.1 Include or Copy Foreign Database............................................................................................. 204
19.2 Document Files and Sessions .................................................................................................... 205
19.3 Cleaning Old Session Files ......................................................................................................... 205
20 Appendix H - Diagrams Options ..................................................................................................... 207
20.1 Snap and Glue Settings ............................................................................................................... 213
20.1.1 Common Snap and Glue Settings – A Worked Example....................................................... 213

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 7 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 8 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 1

1 Introduction

The AVEVA Diagrams application supports the creation of Piping, HVAC and Cabling Diagrams. The
application is based on the AVEVA Design Platform GUI and diagram layouts are created using an
embedded Microsoft Office Visio drawing control. All relevant data entered through the application is stored
into the Schematic Database. The training course will be taken by schematic administrator, and will provide
the necessary skill to create and maintain AVEVA projects that include schematic information and design.

1.1 Aim

Over the duration of this training the participants will learn to administer the AVEVA Diagrams application,
be familiar with the creation and maintenance processes.

1.2 Objectives

11 A
2
- 2 NIC
/2
▪ To be able to prepare and maintain the settings related to AVEVA Diagrams in Admin module,
▪ To be able to create symbols and stencils,
▪ To be able to create systems,
22 TEC
▪ To be able to understand and maintain autonaming,
8/
▪ To be able to understand and maintain reports and report templates.
/1 SIN

1.3 Prerequisites

It is necessary to have a good understanding of the AVEVA Plant Design or AVEVA Marine Outfitting
23 er:

systems and it would be beneficial to complete one of the AVEVA Plant or AVEVA Marine Diagrams courses
1/

(P&ID, Cable or HVAC) and have some experience on Windows file system handling beforehand.
te: m
Da sto

1.4 Course Structure

Cu

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

1.5 Using this guide

Certain text styles are used to indicate special situations throughout this document, here is a summary;

Menu pull downs and button click actions are indicated by bold turquoise text.
Information the user has to key-in red bold.

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.

Copyright © 2013. 9 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 10 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 2

2 Introducing AVEVA Diagrams Administration

2.1 AVEVA Diagrams Administration Overview

On a large design project the System Administrator plays an important role by managing the privileges of the
general users and the Data Access Controls (DAC) rights as well as the breakdown of the project into
sections which are relevant to the needs of project reporting and control such as:

▪ Access Control (Teams and Users)

▪ Databases (DB’s) Multiple Databases (MDBs)
▪ Database management functionality

The Administration of project data setups are done in three modules, these are:

▪ AVEVA Administration - For Project and User administration

11 A
2
▪ AVEVA Catalogue – For Catalogue and Specification.

- 2 NIC
/2
▪ AVEVA Diagrams – For project configuration to suit project requirements (e.g. drawing dimensions
and layout, label types, manage symbols etc.)
22 TEC
8/
2.2 Creating a New Project – A Worked Example
/1 SIN

Depending on the design requirements, it may be necessary to create a new project. This could be done via:
All Programs > AVEVA > Manage > Project Creation Wizard 1.5.0 or All Programs > AVEVA Marine >
Engineer > Diagrams > Project Creation Wizard command from the Start menu.
23 er:

For use with AVEVA Diagrams 14.1.SP3 For use with AVEVA Marine Suit
1/

12.1.SP4
te: m
Da sto
Cu

Copyright © 2013. 11 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Click the ‘Project Creation Wizard’ option, the ‘AVEVA Administration Project Creation Wizard’ form is
then displayed.

Before a new project is created, the

project should be named and the project
variables should be checked as described
below:

11 A
2
- 2 NIC
/2
%<Project Code>DIA%
%<Project Code>STE%
%<Project Code>TPL%
22 TEC
8/
Three project variables are needed in
/1 SIN

AVEVA Plant and AVEVA Marine to

support the AVEVA Diagrams application.
23 er:
1/
te: m
Da sto

Clicking on the ‘Create’ button in the ‘AVEVA Administration Project Creation Wizard’ form will create a
new project and the required project variable folders in preferred location as shown:
Cu

The three folders (DIA, STE and TPL) are necessary within the xxx project to store the Diagrams, Stencils,
and Templates files.

Copyright © 2013. 12 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Login to the Admin module (AVEVA Administration) using

the details provided by the trainer to view the newly created
project.

Project : ADMIN

Username : SYSTEM

Password : XXXXXX

Click the Admin tile

 It is not necessary to specify an MDB to enter Admin.

Free Users, like SYSTEM, are not displayed on the
Username pull down.

The Admin default screen layout will be displayed.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Exit the AVEVA Administration to close the application as shown.

Copyright © 2013. 13 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

2.3 Setting up Project Databases.

Setting up project databases for AVEVA Diagrams application involves series of steps such as; creation of
Teams, Users, Diagrams Databases (schematic (SCHE), project MDB (Multiple Database) etc.

This is explained in subsequent sections using existing ‘Train-DIAG’ project.

 Detail of the ‘Train-DIAG’ project will be provided by the trainer.

2.3.1 Create Teams – A Worked Example

Using team access control, each discipline will have full control of their own data whilst working with data
issued from all the other team /disciplines.

Enter AVEVA Administration by selecting:

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

11 A
2
Project : Train-DIAG

- 2 NIC
/2
Username : SYSTEM
22 TEC
Password : XXXXXX 8/
Click the Admin tile.
/1 SIN

▪ Create a ‘Team’ as shown:

23 er:

Teams
1/
te: m

- SCHEMATIC TEAM
Da sto
Cu

Copyright © 2013. 14 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 15 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

2.3.2 Create Users – A Worked Example

To control who can create or update diagram data, users are created and assigned to respectively teams.

▪ Create a ‘User’ as shown:

11 A
2
- 2 NIC
/2
22 TEC
8/
USER : SCHEMATIC
/1 SIN

PASSWORD : SCH
23 er:
1/
te: m
Da sto
Cu

Make the user member of the preferred team in the case ‘SCHEMATIC’.

Copyright © 2013. 16 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

For further details, on creation of

Teams and Users, please refer to AVEVA
Plant System Administration User Guide
(TM1300)

11 A
2
- 2 NIC
/2
22 TEC
2.3.3 Create Diagrams Databases- A Worked Example
8/
A schematic (SCHE) database (writable SCHE DB), Dictionary database (DICT) and a Reference Only DESI
/1 SIN

DB must exist within the project MDB (Multiple Database) to store the diagrams data. The following
examples shows how these databases are created.
23 er:

Create Schematic Database – To store diagrams data.

1/
te: m

Create Schematic database, by selecting Databases & Extracts from the Elements options list. Click the
Create button to display the Databases & Extracts form.
Da sto

Click the Master DB radio button and the OK button to display the Create Database form.
Cu

Select <Team> SCHEMATIC from the Owning Team grid Name column. Enter or select the following data:

Enter or select the following data:

Name DIAGRAMS

Description Schematic Arrangements- Pipes, HVAC, Cables

Database Type Schematic

Click the Apply button to create the database.

Copyright © 2013. 17 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

 When a SCHE database has been created, this will automatically create the Schematic world element,
te: m

(Schematic WORL*). From the Schematic world the user can add any number of Schematic Group
Da sto

elements, (SCGROU), to hold their schematic elements, such as Diagrams, Stencils, Templates,
Equipment, Pipelines, Cables and HVAC lines.
Cu

Copyright © 2013. 18 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Create Dictionary Database – To store User Defined Attributes (UDAs), User Defined Element Types
(UDETs), Status Definitions, Revision Definition, Flexible Explorer Definition etc.

Select <Team> SCHEMATIC from the Owning Team

grid Name column.

Enter or select the following data:

Name: DIAGRAMS-DICTIONARY.

Description: Schematic Diagrams Dictionary

Database Type: Dictionary

Click the Apply button to create the database.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Create Reference Only DESI DB: To Store the elements that represent information that can be updated
from both 2D and 3D applications, for example piping or cabling systems.
Cu

By selecting the Reference Only checkbox the created database is limited to only contain elements that
represent information that can be updated from both 2D and 3D applications.

Once a Reference Only DESI DB is created as shown above, it will not be possible to switch it to an ordinary
DESI DB or create certain top-level element types.

Copyright © 2013. 19 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Similarly it is not possible to alter a DESI DB to be a Reference Only DESI DB once it is created as an
ordinary DESI DB. The only top-level types that will be available are listed below.

Element type Description

SYGPWL System Group world
CYMWL AVEVA Schematic 3D Integrator world
AREAWL Area world
STLNKW Status link world
GPWL Group world
LINKWL Linked Documents world
RLWL Rule world
DOWL Document world
GRIDWL Grids world

2.3.4 Multiple Database (MDB) Setup- A Worked Example

In controlling what data a user can see, 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.

11 A
An MDB must contain all the data that the user needs to access. For example, for a DIAGRAM user,

2
the MDB must contain a Schematic, Dictionary and Catalogue database on which the user is going to

- 2 NIC
/2
work.

On the Admin elements form select MDB from the Elements option list and click the Create….. button to
22 TEC
display the Create Multiple Database form.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 20 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 For more information on MDB creation please see the TM-1300 AVEVA Plant (12.1) System
Administration (Basic) or TM-2120 AVEVA Marine (12.1) System Administration (Basic) Training
Guides

Select the relevant databases e.g. (SCHE & DICT DBs) in the top pane Project Databases then click the
down arrow icon above the Current Databases list. This will add the database to the list of Current
Databases then click Apply button and then Cancel button to exit the form.

 The user will need at least one SCHE DB to work on, one CATA DB to be able to use specifications
and one DICT DB if UDA:s and UDET: s are desired to be used. These could be copied from existing
projects.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 21 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 2– Database Creation

1. Create a new project.

2. Create a team, a user and an MDB for each discipline. Make sure relevant teams can write only to
their databases but they should be able to read from the other databases as well.
3. Prepare CATA, DICT and any other required data with the help of foreign projects in your system.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 22 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 3

3 AVEVA Diagrams Project Data Configurations

Basic project data settings and defaults configurations to suit project requirements listed below are done in
AVEVA Diagrams module via the Admin Tab and AVEVA Administration (Lexicon) module.

▪ System & Rule Definitions

▪ Units, Naming, List Configurations
▪ Drawing & Database Upgrades
▪ Project Explorer Configurations

11 A
2
- 2 NIC
/2
22 TEC
The Admin tab is only displayed if the user is a member of the ADMIN team and FREE USER (e.g.
8/
SYSTEM).
/1 SIN

3.1 System Definitions

23 er:

A system is basically used to define the Pipe Spec, Insulation Spec, Tracing Spec, Paint and Fluid of a pipe.
User can choose to omit or set a default system. A system can be used with or without any default values
1/

included, in this case the item belonging to this system will only have a system reference stored in scsysf
te: m

attribute.
Da sto

 To create a new system for AVEVA Diagrams application the user must have the appropriate login, i.e.
must be a user with the right privileges
Cu

 The administrator should ensure there is at least one (which could be a Reference Only) DESI DB in
the MDB with read/write access to be able to create new systems using the AVEVA Diagrams
application.
 In this section, enter AVEVA Diagrams using the following details: Project – ‘Train-DIAG’,
Username – ‘SYSTEM’ Password – XXXXXX, MDB- A-PIPING

Select Systems from the Admin tab.

Copyright © 2013. 23 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The System Hierarchy form is then displayed.

11 A
2
- 2 NIC
/2
The new SYGPWL (System Group World) is shown for SYSTEMS by default if a Reference Only DB is used
and this System Group World is indicated to be created previously. Now navigate to the SYGPWL
22 TEC
SYSTEMS, right click and from select Create System Group Area from right click context menu.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The Create System Group Area form appears, key in the Name /SYSTEMS_GR_AR, the Function
Systems, Description All System Group Area and Purpose ALL and then click the OK button.

Copyright © 2013. 24 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 The Purpose of the group area needs to be set to PIPE, ELEC, or HVAC to allow the modelling
application’s related form(s) to filter the systems, i.e. Create Cable, Create HVAC and Create Pipe
forms in AVEVA Plant Design or Marine Outfitting modules

Now select the SYGPAR SYSTEMS_GR_AR, right click and select Create System from right click context
menu. The Create System form appears, key in the Name TRA, the Function Training, and the Description
System for Training, and then click the OK button.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

For each system, there is also a subordinate SYSCDA (System Schematic Data) element which contains
23 er:

default values per system for the AVEVA Diagrams application and SYSMDA (System Model Data) element
1/

which contains default values per system for the Outfitting application.
te: m

Navigate to the SYSGRP TRA and right click, select Create System Schematic Data. Enter name
Da sto

TRA_Default, Description Training, and Pipe Spec SP/DR07C and click OK button.
Cu

Once the training system and defaults have been created, create systems and their schematic data
respectively for HVAC and Electrical elements. The user can then set these systems as default or in
particular against design elements without needing an administrative login.

Copyright © 2013. 25 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 The Track New Elements checkbox can be used to automatically navigate to the newly created items

3.2 Units Configuration

When the user enters dimensional data in any window in AVEVA Diagrams, the units applied will be taken

11 A
2
from the default settings. The default units are specified independently for each unit type. To change the

- 2 NIC
/2
default units, the user will have to select Units from the Admin tab to display the Current Session Units form.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

A system default file is supplied for both metric and imperial units as %pdmsdflts%/system-current-units-
Met.pmldat and %pdmsdflts%/system-current-units-Imp.pmldat.

To set the default units for a specific project the administrator must select the required units using the
Current Session Units window and click the Save button. A file, %pdmsuser%/xxx-save- current-units-
Met.pmldat or %pdmsuser%/xxx-save-current-units- Imp.pmldat will then be created. The created file must
be copied to the project defaults folder and renamed to %xxxdflts%/project-current-units-Met.pmldat or
%xxxdflts%/project-current-units-Imp.pmldat to be able to permit the use the Project Defaults or use a saved
file created by them.

On Global projects, it is necessary to propagate the units settings file to all project satellites. If the Other
Data Transfer mechanism has been implemented, then the project units settings files could be propagated in

Copyright © 2013. 26 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

this way. Otherwise, the most practical method of propagating a project units file is simply to distribute the
file to all satellites and have the file copied to the appropriate project folder. In practice, project units files will
be configured at the beginning of a project, and are unlikely to be changed frequently during the life of a
project.

The Save and Restore buttons can be disabled by the administrator which forces the user to use the project
default settings. To disable the buttons, the administrator must open the file saved in the project defaults
folder and change the !!comFormats.allowUserSaveFile = true to !!comFormats.allowUserSaveFile =
false

3.3 Defining Naming Rules

AVEVA Plant and AVEVA Marine Auto naming allows the AVEVA Plant or AVEVA Marine administrator to
define rules to be used when creating elements, i.e. pipes and valves. Rules are created based on element
types and attributes.

Select Naming from the Admin tab, the Naming Settings form appears. Make sure that Auto Naming On/Off
checkbox is checked to be able to see the rules working.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

Infill Allows user to use any available index number for elements.
te: m

Append Allows user to name elements with increasing index numbers only.
Da sto

Save Allows user to save the naming rules to the rules file.
Cu

Load Allows user to load the naming rules from the rules file.

3.3.1 Inserting a Rule (A Worked Example)

On the Naming Settings form, click the Define Naming Rules button. The user has two options to create a
rule. The user can type all data required in Data Input section or copy a rule then insert it as a new rule with
the modifications.

Copyright © 2013. 27 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Replace button can be used if any rule is

required to be modified, as well as
Remove button to delete the rules from
the list

11 A
2
The user firstly must indicate the type of element which is going to be named with a rule. To define an

- 2 NIC
/2
element rule click the Element Rules button on Naming Rules form.
22 TEC
8/
/1 SIN
23 er:
1/
te: m

In Define Rules form in Definition section key in the Name field All Diagrams and Types SCDIAG. Then
click Include button. The Defined list of rules will be populated with the new rule in User Defined Rules
Da sto

group.
Cu

Select Save to save the changes. Then click OK

button to turn back to Naming Rules form.

 This file is stored with a name diagrams-

element-rules.pmldat in %PDMSUI%\dflts

Location: Determines where the Element Rules is

stored. If User is selected the file is stored in
the%pdmsuser% folder.

If Project is selected the file is stored in

the%project%\<PROJECTNAME>\<PROJECTCODE>df
lts folder.

If the PDMS is selected the file is stored in

%PDMSUI%\dflts folder.

Copyright © 2013. 28 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

On the Naming Rules form key in DIAGRAM and click the selection icon next to Rule Name field and select
previously created All Diagrams. Data input section will be updated automatically. Complete the Data Input
section as shown and click Insert button.

 The user can select Before or After to insert a rule into the list of rules

The newly created naming rule is added to list of rules. Navigate to an appropriate element in Design

11 A
Explorer and having checked the Use Rule checkbox click Test button to see the result of autonaming.

2
- 2 NIC
/2
 The Scan Level is used to scan the available index number with respect to given element. i.e.,
WORL, OWNER, SCPLIN etc.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Click OK button and on Naming Rules

Cu

form and select Save button to save the

naming rules on the Naming Settings
form.

 This file is stored with a name diagrams-nam.pmldat. The

default folder is %PDMSUI%\dflts, if the user select Save
then the file will be stored in %pdmsuser% folder

Copyright © 2013. 29 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

3.3.2 Modifying a Rule

Display the Naming Rules form as described previously, then select a rule. The user then can click Copy
button to copy the Data contents seen on the form to Data Input section and modify as shown:

Format: !!ce.owner.namn & 'SCDIAG-' &

!INDEX

Click Replace button after the alteration.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

 The Test button can be used to

Da sto

show the naming result so long as

the relevant element is CE.
Cu

 It is recommended that the user

should test any alteration on these
rules as this may cause unexpected
actions on element creation.

Copyright © 2013. 30 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Then select Save button on Naming Settings form.

3.3.3 Removing a Rule

11 A
2
To remove a rule, select the rule desired to be removed in the rule list on Naming Rules form and then click

- 2 NIC
/2
Cut button. This will move the Data shown on the form to the Data Input area and remove the rule from the
Key scrollable rule list.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Then select Save button on Naming Settings form Click OK button. Remember to select Save on Naming
Settings menu.

 For more detailed information on naming please see the TM-1300 AVEVA Plant (12.1) System
Administration (Basic) or TM-2120 AVEVA Marine (12.1) System Administration (Basic) Training Guides

Copyright © 2013. 31 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 3– AVEVA Diagrams Project Data Configuration

1. Create a system for HVAC using the system code HVA, set up the SYSCDA element as shown.

2. Log in to the AVEVA Diagrams application as SCHEMATIC user with password SCH and test if the

11 A
2
newly created system is working.

- 2 NIC
/2
22 TEC
3. Create a naming rule to get a result as <BORESIZE>-<NUMBER>-<PIPING SPEC> for a pipeline
8/
element, i.e., 100-2-SP/DR07C.
/1 SIN

4. Use your company standards to create a naming rule for Multi Cable, Cable and Core elements.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 32 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 4

4 Project Drawing Configuration

4.1 Drawing Documents Configurations

The diagram documents such as diagram, stencil and template created through the AVEVA Diagrams
application are stored in a file system or an external document management system as shown:

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:

All diagrams, stencils and templates are handled through proxy (index) elements in the database,
1/

even if the actual files are stored in the file system.

te: m
Da sto

 No SVG format files are created when templates and stencils are saved by the application.
Cu

4.2 Diagram Templates

Diagram templates are used as guides for drawing symbols on drawings. Each diagrams elements are
created from templates. Templates are usually used when creating multiple diagrams files that need a
consistent appearance.

AVEVA Diagrams provides the capability to create a template from a drawing file, or import existing Visio
drawings which are not created through the Diagrams application and are therefore not represented by
index elements in the database. Likewise, to export an existing drawing or to save a newly created Visio
drawing to a file without creating an index element in the database, the export function can be used.

Creating a diagram template enables user(s) to customize drawing settings such as:

▪ Print Setup
▪ Page size
▪ Drawing Scale
▪ Page Properties
▪ Layout and Routing
▪ Shadows
▪ Window size or position
▪ Shape or text styles

Copyright © 2013. 33 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

▪ Colour palette
▪ Snap and glue

If the drawings often use a standard background or set of layers, such as company logo, the diagram
template is created with the background or layers.

4.2.1 Creating a New Template – A Worked Example

This worked example illustrates how to create a new template from a drawing file in AVEVA Diagrams
application.

Select New > New Diagram from the Project tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Select preferred Schematic

group for templates e.g.
Cu

‘SCGROU Project_Templates’

In the Template name text field

enter desired name e.g.
‘Training Template’

 A predefined template for

a new diagram can be chosen
from the database if required.

Click the No template button.

Copyright © 2013. 34 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The ‘Save Diagram As’ form is then displayed. Select desired SCGROU (SCGROU Project_ Templates)
where the new template is to be saved, then key the name TRA_A2_Template and select from the Save as
type pull down Template (SCTEMP) then click the Save button.

11 A
2
- 2 NIC
/2
22 TEC
The newly created ‘TRA_A2_Template’ is created and saved in the specified location.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 35 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

If the drawings require a standard background or set of layers, such as company logo, the diagram template
is created with the background or layers as shown:

▪ Right click on the Page-1 tab and select Insert option to add new page

▪ The Page Setup form is then displayed. Select the Background radio button and click the OK
button to insert the Background page.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 36 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

4.2.2 Drawing Template Settings

If required, drawing templates can be customized by the Administrator to meet project specific needs such
as:

▪ Print Setup
▪ Page size
▪ Drawing Scale
▪ Page Properties

This worked example illustrates how to customize the above drawing settings.

4.2.2.1 Drawing Template Settings - A Worked Example

a) Print Setup

The Print Setup option allows Administrator / user to set the Printer Paper Size, Print Zoom and Print
Gridlines to meet project specific needs.

11 A
Right click on the preferred template Page-1 tab. Select Page Setup option to display the Page

2
Setup form

- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

▪ The Page Setup form is then displayed

Cu

In the example, set the Printer paper to Letter: 8.5 in x 11 in. The remaining fields should remain as
default.

Copyright © 2013. 37 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

b) Page size Setup

The Page size option allows user to set

a Pre-defined page size, Custom page
size and Page orientation if required.

In this example,

Select the Pre-defined size radio button

and set the page size to Metric (ISO)
A2; 420 mm x 594 mm.

The Custom size field will automatically

set size to 420mm x 594mm.

Page orientation, select Landscape radio button.

11 A
2
- 2 NIC
/2
c) Drawing Scale
22 TEC
The Drawing Scale option allows user to set a Pre-defined Drawing scale, Custom Drawing scale and Page
8/
size if required.
/1 SIN

In this example,

Select the Custom size radio button and set the page size (in measurement units) to 594 mm x 420 mm, if
the field is unset.
23 er:
1/
te: m
Da sto
Cu

d) Page Properties

The Page Properties option allows user to set the page properties if required.

If the drawings needs to use a standard background or set of layers, such as company logo.

Copyright © 2013. 38 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

From the Background field, select the appropriate background page from available pull-down list in this
case ‘Background -1’.

Click on the OK button to save the settings and close the Page Setup form.

11 A
2
- 2 NIC
/2
Repeat the same procedure to setup the Background page as shown.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 39 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

4.2.3 Background Template Setup

The drawing template background allows the user to add project specific details to the drawing template
such as standard company logo, Drawing grids/ borders/frame etc.

4.2.3.1 Background Template Setup - A Worked Example

This worked example illustrates how to add company logo, Drawing grids / borders to drawing template
background.

▪ Select the Background-1 tab at the base of the sheet to display the Background page

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

▪
Da sto

Use the Line tool from the main AVEVA Diagrams toolbar, add the preferred drawing borders to the
drawing template background
Cu

Copyright © 2013. 40 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
▪ Add the company logo and the desired texts using the Text tool from the main toolbar.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

 The grid reference numbers/letters can be added to the drawing template background if required.

Copyright © 2013. 41 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

4.3 Drawing Stencil

Stencil hold shapes that are regularly used. Newly created stencil must be saved to the database before
shapes can be added.

4.3.1 Create a new Stencil – A Worked Example

To create a new stencil select New > New Stencil from the Project tab, the new stencil is then displayed.

11 A
2
- 2 NIC
/2
From the Project tab on the main pull down menu select Save Stencil As.
22 TEC
8/
/1 SIN
23 er:
1/
te: m

Browse in the tree to where the

Da sto

new stencil is to be saved, key-

in the name TRA_Stencil and
Cu

then click the Save button.

Information form is then displayed. Click the Yes button.

The newly created stencil ‘TRA_Stencil’ is created and saved in the specified location.

Copyright © 2013. 42 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
4.4 Importing Stencils and Drawings 8/
Stencils, templates and diagrams that do not have any SCDIAG, SCSTEN or SCTEMP elements in the
/1 SIN

database, can be imported by using the Import command in the Project tab.

▪ Diagrams and templates can be imported using the Import > Drawing option
23 er:

▪ Stencils can be import using the File > Import > Stencil option
1/
te: m
Da sto
Cu

It is also possible to export these items to be used in another project in a similar way using the Export
command in the same tab.

After import, database items can be saved using the Save Diagram As and Save Stencil As commands via
the Save As group in Project tab which will create the index elements in the database and save the files in
the location pointed to by the %<Project code>DIA%, %<project code>STE% and %<project
code>TPL% variables.

Copyright © 2013. 43 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 4– Project Drawing Configuration

1. Create a new template and background page.

2. Customize the template and background page options listed below to meet project specific needs

▪ Print Setup
▪ Page size
▪ Drawing Scale
▪ Page Properties

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 44 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 5

5 Creating Symbols

A major part of the AVEVA Diagrams functionality is based on a set of specialised AVEVA Diagrams
shapes. Many of these shapes contain information about what kind of database element the shape should
be related to, while others do not have any database equivalent at all such as annotation labels etc. This
mechanism enables the application to automatically create related database elements, as well as provide
automatic annotation and general intelligence.

Shapes that should be recognized by AVEVA Diagrams and handled by the application logic must be
created through the Import Shape accessible through the Admin tab. These include shapes corresponding
to DB elements, (for instance branches, valves, instruments and fittings), off-page connector shapes and
label shapes presenting attribute information.

The shapes processed by the Import Shape Wizard will be stored in a user-selected stencil and will contain
data specific to the AVEVA Diagrams application. Other Visio shapes that have not been processed through

11 A
2
the Import Shape Wizard can still be used for annotation etc. on drawings, but these will not be handled

- 2 NIC
/2
'intelligently' by the application.

AVEVA Diagrams shapes can also contain default attribute values, which can enable users to create
22 TEC
specialised shapes and will reduce the amount of information that is necessary to enter when diagrams are
8/
created.
/1 SIN

5.1 Creating Microsoft Visio Shapes - Overview

Before shapes can be imported to a stencil using the Import Shape Wizard, they will have to be created
23 er:

using Microsoft Visio tools. It is highly recommended that the user creating the shapes has a good
knowledge of Microsoft Visio and is familiar with how Visio shapes works before proceeding to create
1/

AVEVA Diagrams shapes.

te: m

When drawing the shape, it is recommended to use the same grid setting that will be applied when the
Da sto

shape will be used in the drawing, thereby avoiding alignment and snapping problems. To minimize the risk
of mistakes when different zoom settings are used, the grid can be set to Fixed. A suitable grid size is
Cu

suggested to be 1mm. To set the Ruler and Grid select Ruler and Grid from the View tab.

To set the Ruler and Grid select Ruler and Grid from the
View tab.

Copyright © 2013. 45 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.1.1 Create a Branch Symbol - A Worked Example

From the Home tab select the Connector Tool; draw the shape of the line to become the branch symbol.

Once the line is drawn, select the line and the vertexes are automatically highlighted. Right click on the line
to display the context menu.

Select Line option form the Format submenu.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

 The Line option can also be accessed via the Shape Tools context sensitive tab.
23 er:
1/

The Line form is the displayed. This will allow the user to change the representation of the line i.e. Pattern,
te: m

Weight, etc.
Da sto

In this example select the following field:

Cu

Weight: enter ¼ pt.using Custom Line Weight form.

End: Select 13 from the available pulldown list.

When finished click the Apply button follow by OK button to close the form.

Copyright © 2013. 46 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Or select the line and Right Click, then line form will be displayed:

In this example select the following field:

Weight: enter ¼ pt.using Custom Line Weight

form.

11 A
2
- 2 NIC
/2
Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window. The four steps Import Shape Wizard allows the user to set up the
key information for the imported shapes.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto


Cu

Prior to starting the Import Shape Wizard, one or more shapes must have been selected on the current
drawing. In case more than one shape has been selected, they will all receive a common type, common
presentation settings etc.

Step 1: Selecting Type and Assigning a Name

▪ First select the appropriate category that corresponds to the previously drawn shape e.g. Pipeline
elements> Branch in the explorer pane to the left

▪ Then select the type in this Branch in the right hand pane

▪ Last enter the name for the shape. In this case Branch

Copyright © 2013. 47 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
 The checkbox Keep Custom Menu Actions is available for each shape. If checked the cells in Actions
8/
section of the shape sheet will be preserved. For piping and HVAC branches, a Denote to dropdown
box will appear. This can be used to select the tube/duct type that a branch should be denoted to when
/1 SIN

dropped on to the drawing.

Click the Next button to continue to the next step.

23 er:
1/

Step 2: Selecting the Stencil

te: m

In this step, select the stencil to which the shape should be added. The Import Shape Wizard step 2 of 4:
Da sto

Destination Stencil will display the currently open stencils, so the stencil must have been opened before
starting the Import Shape Wizard.
Cu

Select the destination stencil

and click Next button to
continue.

Copyright © 2013. 48 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Step 3: Annotation Style Settings

In this step the default annotation can be set up. The default annotation is represented by the shape text as
well as a number of default labels that can be automatically placed on the drawing when the shape is
dropped.

11 A
2
- 2 NIC
/2
22 TEC
8/
 The number of default annotations varies depending on the type of item and can be controlled by
/1 SIN

changing the settings under General Options > Annotation Settings in Diagrams Options.

Click the Next button to continue to the next step.

23 er:
1/
te: m

Step 4: Attribute Presentation

Da sto

In this step the attribute presentation can be set up. If the Use default attribute presentation settings
checkbox is checked, all presentation settings will be taken from the default that has been set up using the
Cu

Attribute Presentation tab of the Diagrams Options dialogue.

Copyright © 2013. 49 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

When the attribute presentation

settings are completed click
Finish, the shape will be added
to the selected stencil. The user
will also be prompted to Save
Work or not.

 In this step also possible to

set up a default value (the
Value column) for each
attribute. This can still be
provided even if the
presentation settings are
taken from the default.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

The reason for the prompt of Save Work is that if the application subsequently closed without any Save
te: m

Work command being issued, the imported shapes will be lost. So if the user clicks No, then they will have
Da sto

to remember to perform a SaveWork at a later time.


Cu

This procedure for creating a branch is the same for Pipe, HVAC and Cable Lines

5.2 Create a Flow Direction Symbol

The Flow Direction symbol can be used for a graphical indication of the flow of a branch on a drawing.
When dropped on top of a tube or duct shape, the flow direction symbol automatically aligns with the current
flow and it reacts on the connectors’ moving or re-sizing. It is also automatically adjusted on the reversing of
the flow direction.

Copyright © 2013. 50 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.2.1 Create a Flow Direction Symbol - A Worked Example

A flow direction symbol can be created using Import Shape Wizard and then dropped from the stencil as any
other shape.

First draw the desired shape, using the available standard Drawing tool in AVEVA Diagrams from the
Home tab. Alternatively user can also draw desired shapes using Microsoft Visio tools and then copy the
shape back to AVEVA Diagrams.

The triangle shape below was drawn using available standard Drawing tool in AVEVA Diagrams.

To achieve proper behaviour it is important that before the symbol is

imported via the Import Shape Wizard and its orientation corresponds with
default flow direction going horizontally form left to right.

11 A
2
- 2 NIC
/2
The Flow Direction Symbol also requires a single outward connection point which will be used to attach to
the connector. Connection points can be added to shapes by using the Connection Point Tool icon
available on the dropdown in the Standard toolbar.
22 TEC
8/
To add connection points, select the shape to make it active and then select the Connection Point Tool
from the Standard toolbar. Holding down the Ctrl key on the keyboard click with the cursor where the
/1 SIN

connections are to be placed.

23 er:
1/

The direction of the connection points can be changed by right clicking on

te: m

a connection point and selecting Inward, Outward or Inward & Outward

Da sto
Cu

In this example change the connection points to Outward connection point as shown above.

 These directions are NOT related to flow directions of the component. This only relates to Visio’s
mechanisms for connecting shapes to each other. Connection points for 2D shapes (such as
equipment, valves, fittings etc.) should normally be Inward. Outward connection points are only
required if the user intends the shape to be directly connected to other 2D shapes. The normal
approach is to always use Inward when shapes are created. The connection can then be changed to
Outward if required after the shape has been added to the diagram

Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window.

Copyright © 2013. 51 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Step 1: Selecting Type and Assigning

a Name

▪ Select the appropriate category

that corresponds to the
previously drawn shape e.g.
Flow direction symbol > Flow
direction symbol in the explorer
pane to the left.

11 A
2
▪ Then select the type in this Flow

- 2 NIC
/2
direction in the right hand pane.

▪ Last enter the name for the

22 TEC
shape. In this case Flow 8/
Direction.
/1 SIN

Click the Next button to continue.

23 er:
1/
te: m

Step 2: Selecting the Stencil

Da sto

Select the destination stencil e.g. TRA_Stencil and click Next button to continue.
Cu

Copyright © 2013. 52 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Step 3: Annotation Style Settings

Select the click Next button to continue to the next step. No default annotation settings available for this item
type.

11 A
2
- 2 NIC
/2
22 TEC
Click the Next button to continue.
8/
/1 SIN

Step 4: Attribute Presentation

Select the click Finish button to add the shape to the selected stencil. The user will also be prompted to
23 er:

Save Work or not.

1/
te: m
Da sto
Cu

Click on the Yes button to save the imported shape.

Copyright © 2013. 53 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

In addition, user can define a flow

direction symbol that is automatically
attached to a dropped piping or HVAC
connector.

This can be achieved using the default settings in Diagram Options or

in the Import Shape Wizard by specifying a stencil and a name of the
flow direction symbol to be automatically dropped.

11 A
2
- 2 NIC
/2
22 TEC
8/
Specify preferred Flow direction symbol’s Stencil and Flow direction symbol name. In the example
/1 SIN

enter the following details.

23 er:
1/

Flow direction symbol’s Stencil: TRA_Stencil

te: m

Flow direction symbol: Flow Direction

Da sto
Cu

Click on the OK button to save

the settings

Copyright © 2013. 54 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.3 Create an Inline Fitting Symbol for Piping – A Worked Example

Using the available standard Drawing tool in AVEVA Diagrams from the Home tab create a valve symbol,
once complete make sure that all the lines, circles, etc. are grouped together using the right click context
menu Group > Group.

Now select the shape so it is active and then select the Connection Point Tool from the Standard toolbar.
Holding down the Ctrl key on the keyboard click with the cursor where the connections are to be placed.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

 Remember that the first added point will correspond to Ppoint 1 on the catalogue item. When an
23 er:

inline fitting is connected, arrive and leave are resolved depending on the connections. i.e., if conn 1
1/

is connected to the leave of another fitting during define, conn 1 will arrive and vice versa. If it is not
te: m

connected when defined arrive and leave will default to 1 and 2

Da sto

From the Standard toolbar, click the Pointer Tool icon, and select the element so the vertexes are
highlighted. Select Import Shape from the Admin tab.
Cu

The Import Shape Wizard Type and Name of Shape form appears, using the Import selected shape as
tree, navigate to the correct element type that corresponds to the previously drawn shape. Key in the shape
name Valve_Type1 and then click the Next button.

Copyright © 2013. 55 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
The symbol can be defined as a directional component using the Directional component checkbox or its

- 2 NIC
/2
GTYPE can be set as an instrument using the Classify as Instrument checkbox. Repeat the same process
as shown in the previous example until the shape is saved to the required stencil.
22 TEC
8/
/1 SIN

The shape is saved and appears inside the stencil.

23 er:
1/
te: m
Da sto
Cu

5.3.1 Create a Multiport Valve

Create a Multiport Valve symbol in Diagarms with the procedure explained in the above example.

Import the shape as a Port valve and Edit the Connection Points. Add a total of 6 to 8 connections with
Connection type as Pipe connection.Click OK to exit the form.

Copyright © 2013. 56 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Click Next to proceed

Copyright © 2013. 57 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Step 2: Selecting the Stencil

Select the destination stencil e.g. Sample_Valve_Symbols and click Next button to continue

11 A
2
- 2 NIC
/2
Step 3: Annotation Style Settings

In this step the default annotation can be set up. The default annotation is represented by the shape text as
22 TEC
well as a number of default labels that can be automatically placed on the drawing when the shape is
8/
dropped.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Step 4: Attribute Presentation

In this step the attribute presentation can be set up. If the Use default attribute presentation settings
checkbox is checked, all presentation settings will be taken from the default that has been set up using the
Attribute Presentation tab of the Diagrams Options dialogue.

When the attribute presentation settings are completed click Finish, the shape will be added to the selected
stencil. The user will also be prompted to Save Work or not.

Copyright © 2013. 58 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

 When using the port valve in Diagrams,Set the Use Specification option to False in Diagrams Options
of the Pipe dimensioning. By setting the Use Specification option to False then the specification will not
be used. Dimensioning will be stored locally in each inline part using the BOREARRAY attribute.
Borearray in the attributes window of the valve shows the size of all pipes connected to the valve and
Crfarray shows the connected references . In the Spref part the User can mention the catalogue
reference for the valve.

Copyright © 2013. 59 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.4 Create an Inline Fitting Symbol for HVAC

Using the available standard Drawing tool in AVEVA Diagrams from the Home tab create a Damper
symbol, once complete make sure that all the lines, circles, etc. are grouped together using the right click
context menu Group > Group.

Select the shape so it is active and then select the Connection Point Tool from the Standard toolbar. Holding
down the Ctrl key on the keyboard click with the cursor where the connections are to be placed.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

From the Standard toolbar, click the Pointer Tool icon, and select the element so the vertexes are highlighted.
Select Import Shape from the Admin tab.
23 er:
1/
te: m
Da sto
Cu

The Import Shape Wizard Type and Name

of Shape form appears, using the Import
selected shape as tree, navigate to the
correct element type (e.g. Damper) that
corresponds to the previously drawn
shape. Key in the Shape name HVAC
Damper and then click the Next button.

Repeat the same process as shown in the

previous example until the shape is saved
to the required stencil.

 Remember that the first added point will correspond to Ppoint 1 on the catalogue item. When an
inline fitting is connected, arrive and leave are resolved depending on the connections. i.e. if conn 1
is connected to the leave of another fitting during define, conn 1 will arrive and vice versa. If it is not
connected when defined arrive and leave will default to 1 and 2.

Copyright © 2013. 60 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The shape is saved and appears inside the stencil.

5.5 Create an Elconn Symbol for Cables – A Worked Example

11 A
2
Equipment elements can contain electrical component elements that represent electrical components within

- 2 NIC
/2
an equipment. Cables are connected to ELCONN elements (Electrical Connection Element).

To create an ELCONN symbol:

22 TEC
8/
From the Home tab, select the Line Tool from the Tools group, draw a line and then select the Ellipse
Tool, and draw a circle as shown.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Once both the line and circle have been drawn select both of them so their vertices are highlighted and then
right click.

From the right click context menu select Group > Group, this will group the two elements together. Now
from the Home tab, Tools section; select the Connection Point Tool

Copyright © 2013. 61 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

With the grouped element selected, hold down the Ctrl key and indicate the two positions for the
connections, now select each connection in turns and right click, then select from the right click context
menu making sure that one connection is Outward (this is the one that will attach to the equipment) and the
other Inward (this is the one that the cable will connect to).

11 A
2
- 2 NIC
/2
22 TEC
Now from the Standard toolbar, click the Pointer Tool icon, and select the element so the vertexes are
8/
highlighted. From the Admin tab, select Import Shape and repeat the same process as shown in the
previous example until the shape is saved to the required stencil.
/1 SIN
23 er:
1/
te: m

From the Admin tab, select Import Shape. The Import Shape Wizard Type and Name of Shape form is
Da sto

then displayed.

Select the appropriate category Equipment items and navigate to the correct element type (e.g. Electrical
Cu

connection) that corresponds to the previously drawn shape in the explorer pane to the left.

Enter the Shape name Electrical Connection and then click the Next button.

Copyright © 2013. 62 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Repeat the same process as shown in the

previous example until the shape is saved
to the required stencil.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

The shape is saved and appears inside the stencil.

Da sto
Cu

Copyright © 2013. 63 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.6 Create Equipment Symbol

Using the available standard Drawing tool in AVEVA Diagrams from the Home tab create an Equipment
symbol. Once complete make sure that all the lines, circles, etc. are grouped together using the right click
context menu Group > Group.

Add connection points as described previously. In this example add to 2 connection points by selecting the

11 A
2
Connection Point Tool from the Standard toolbar. Holding down the Ctrl key on the keyboard click with the

- 2 NIC
/2
cursor where the connections are to be placed.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Set the Connection point type to Inward by right clicking on a connection point.
Cu

 The Connection Point type can also be edited via the Edit
Connection Points in the Import Shape Wizard.

From the main pull down menu select Import Shape from the Admin tab. The Import Shape Wizard Type
and Name of Shape form is then displayed.

Select the appropriate category Equipment items and navigate to the correct element type (e.g.
Equipment) that corresponds to the previously drawn shape in the explorer pane to the left.

Enter the Shape name Pump and then click the Next button.

Copyright © 2013. 64 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 The ‘Accept dropped

shape’ checkbox allows
user to set if the equipment
shape is to accept dropped
elements, i.e. sub-
equipment, electrical
connections etc.

11 A
2
- 2 NIC
/2
For equipment symbol creation there is an additional step which is ‘Step 5’ in the Import Shape Wizard.
In this step, it is possible to specify a default catalogue search filter for the shape. If this is done, the filter will
be applied in subsequent catalogue search operations using the Manual Catalogue Selection.
22 TEC
8/
Default filters can be specified in Diagrams Options by using the Catalogue search settings, Default filters
/1 SIN

for non-pipeline elements settings. If these should be used, the Use filter defined in Diagrams Options
checkbox should be checked. Otherwise a specific filter for the particular shape can be specified in the
Default catalogue search filter textbox.
23 er:
1/
te: m
Da sto

 This default catalogue search filter

Cu

for the shape can also be apply to cable

or HVAC line shape as well. If a filter is
referred that includes searching in the
correct category for cables. Selecting
the cable shape in the drawing and go to
the catalogue search window, it will
automatically apply the pre-defined filter
so only the relevant cable catalogue
items will be shown.

Select the click Finish button to add the shape to the selected stencil. The user will also be prompted to
Save Work. Click on the Yes button to save the imported shape.

Copyright © 2013. 65 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.7 Create a Nozzle Symbol

Nozzle shapes can be added to equipment items by dragging and dropping onto an equipment item. They
can be attached to a connection point on the equipment item or just to the geometry. Nozzle items will then
be created under the equipment item in the DB. In case a nozzle shape is not connected to an equipment
item on drop, it can be connected later, and will not be defined in the database until it is connected to an

11 A
2
equipment item.

- 2 NIC
/2
5.7.1 Create a Nozzle Symbol - A Worked Example
22 TEC
8/
Using the available standard Drawing tool in AVEVA Diagrams from the Home tab create a shape that
represents the nozzle symbol. Once complete make sure that all the lines are grouped together using the
/1 SIN

right click context menu Group > Group.

23 er:
1/
te: m
Da sto
Cu

Add connection points as described previously. In this example add to 2 connection points by selecting the
Connection Point Tool from the Standard toolbar. Holding down the Ctrl key on the keyboard click with the
cursor where the connections are to be placed.

Set the Connection point type to Outward and Inward by right clicking on a connection point.

Copyright © 2013. 66 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Nozzle has two connection points the one that attaches to the equipment has an Outward
connection and the one that connects to the pipeline has an Inward connection point.

Before shapes can be imported to a stencil using the Import Shape Wizard, if required the user can add
special features such as setting the nozzle to orientate itself towards the outside of the equipment when user
drags the nozzle near to the connection point of the equipment. This can be done using Standard Microsoft
Office Visio application as illustrated below.

Copy the shape to the Standard Microsoft Office Visio application and with the shape grouped and the
vertexes highlighted right click and from the right click context menu select Show ShapeSheet.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

The Shape sheet appears and user will have to scroll down to the Connection Points section.
te: m
Da sto
Cu

At the connection point 1, change the DirX / A to -1 mm and leave the others as 0 mm. Now the nozzle will
orientate itself towards the outside of the equipment when user drags the nozzle near to the connection
point of the equipment.

Copy the shape to AVEVA Diagrams and import the shape using the Import Shape Wizard.

Select Import Shape from the Admin tab. The Import Shape Wizard Type and Name of Shape form is
then displayed.

Select the appropriate category Equipment items and navigate to the correct element type (e.g. Nozzle)
that corresponds to the previously drawn shape in the explorer pane to the left.

Copyright © 2013. 67 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Enter the Shape name Equipment Nozzle and then click the Next button.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

Repeat the same process as shown in the previous example until the shape is saved to the required stencil.
Da sto
Cu

Copyright © 2013. 68 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.8 Creating Grouped Shapes

It is possible to group together several shapes into a unit that can be added to a stencil. This is achieved by
building up the arrangement in the drawing canvas and saving it to the database for further use. Select the
shapes that will form the assembly, and then use Ctrl+drag to copy them to an empty space within the
drawing.

The shapes will be undefined and they could be grouped manually. The administrator will need to save this
shape into a stencil by dragging and dropping the shape to the appropriate stencil.

11 A
2
This assembly of shapes can then be dragged and dropped onto a drawing, thereby adding an arrangement

- 2 NIC
/2
of branches and inline fittings in a single operation. If a pipe is connected, the assembly of shapes will then
be defined automatically.
22 TEC
 If grouped prior to adding to a stencil when an assembly of shapes is added to the drawing, it is
8/
recommended to ungroup it using the Right click > Shape > Ungroup before proceeding to connect or
modify. If this is not done, it can result in unexpected behaviour.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

In case the arrangement contains more than one branch, the user will have to select a part in each branch
and define them by right clicking on the branch in the drawing and selecting Define Branch or using the
Define icon from the toolbar.

Copyright © 2013. 69 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.9 Instrument Relationship Shapes

An instrument relationship shape is created as a connector tool, the same as for pipelines and a style can be
applied to the line to represent the type of signal line, if required. Import the shape as an Instrumentation,
Instrument Relationship Shape item from the list.

Instrument relationship shape symbol

A connection between the offline instrument and actuator is achieved by instrument relationship line which is
using an electrical interface.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

5.9.1 Instrument Relationship Symbol - A Worked Example

23 er:

Use the available standard Drawing tool in AVEVA Diagrams from the Home tab create a shape that
1/

represents the Instrument relationship shape symbol.

te: m
Da sto
Cu

Once the line is draw select the line and the vertexes are automatically highlighted. Right click on the line to
display the context menu.

Select Line option form the Format submenu.

The Line form is the displayed. This will allow the user to change the representation of the line i.e. Pattern,
Width, etc.

In this example modify the following field:

Dash type: Select “04” from the available pulldown list.

Weight: enter 1/4 pt. using Custom Line Weight form.
End: Select “43” from the available pulldown list.

Copyright © 2013. 70 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

When

finished click the Apply button follow by the OK button to close the form.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window.
23 er:
1/
te: m

Select the appropriate category Instrumentation and navigate to the correct element type (e.g. Instrument
relationship shape) that corresponds to the previously drawn shape in the explorer pane to the left.
Da sto
Cu

Copyright © 2013. 71 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
Enter the Shape name Instrument Relationship Shape and then click the Next button.

Repeat the same process as shown in the previous example until the shape is saved to the required stencil.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Instrument Relationship Shape does not represent any database element but it can display information from
a database element that is associated with its start.

When Instrument Relationship Shape connects two valid items, it changes colour to ‘defined’. The colour
can be determined in Diagrams Options:

Copyright © 2013. 72 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Please refer AVEVA

Diagrams User guide for more
details on Instrumentation
Relationship shape.

11 A
2
- 2 NIC
/2
5.10 Create an Area Shape
22 TEC
8/
Area shapes provide the possibility to define an area on the diagram which may correspond to a Room.
However it doesn’t represent any database element but gives general mechanism for assigning attribute
/1 SIN

values based on the location of the shape within the frame provided by the Area Shape unless it is defined
in the database. Area Shape can control sets of attributes and their values are automatically applied to
shapes it contains.
23 er:
1/

5.10.1 Create an Area Shape - A Worked Example

te: m

An area can be represented by any 2-dimensional shape which is imported on a stencil as an Area Shape
Da sto

using the Import Shape Wizard.

Cu

Before the area shape can be imported to a stencil using the Import Shape Wizard, a shape that represents
Area shape symbol is drawn using the available standard Drawing tool in AVEVA Diagrams from the Home
tab.

Once complete make sure that all the lines are grouped together using the right click context menu Group >
Group.

Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window.

Copyright © 2013. 73 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Select the appropriate category Area Shape and navigate to the correct element type (e.g. Area shape) that
corresponds to the previously drawn shape in the explorer pane to the left.

Enter the Shape name Area Shape and then

click the Next button.

The same process as previously shown is

11 A
2
repeated until the user get to ‘Import Shape

- 2 NIC
/2
Wizard step 4 of 4: Attribute Presentation
Settings’ page.
22 TEC
In this Step, user can define attributes that can 8/
be propagated to shapes contained by the Area
and those who should only be displayed in
/1 SIN

Area's Shape Data.

23 er:
1/
te: m
Da sto
Cu

To modify the default attribute presentation settings for Area Shape during Import Shape, uncheck the Use
default attribute presentation settings checkbox.

In the Propagate column check the preferred attributes (e.g. DESC, FUNC & PURP) checkbox.

Copyright © 2013. 74 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
All attributes with the Propagate field checked will be controlled by Area and propagated to contained
shapes.
22 TEC
Select the click Finish button to add the shape to the selected stencil. The user will also be prompted to
8/
Save Work. Click on the Yes button to save the imported shape.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

After the Area shape is saved to the selected stencil, it can be used by dragging and dropping onto any
drawing. An Area shape can be located on foreground or background of a diagram page.

In Diagrams Options, there is a setting to control how the application should behave when a user tries to
change an attribute controlled by the Area Shape - ‘Allow to modify attributes of contained shapes’

Copyright © 2013. 75 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:

All attributes with Propagate checkbox checked will be controlled by Area and propagated to contained
1/

shapes. In addition it is possible to specify prefixes which would be set for both propagated and not
te: m

propagated attributes in Shape Data. The prefixes can be set in Diagrams Options for Area Shape.
Da sto
Cu

Default set of attributes controlled by Area Shape can be modified in Diagrams Options in Attribute
Presentation tab. Additional attribute could be added by clicking Referenced attributes button.

Copyright © 2013. 76 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 It is possible to override these attributes during the Import Shape Wizard, provided that Allow individual
shape settings to override default settings checkbox is checked in Diagrams Options.

11 A
2
- 2 NIC
/2
 Please refer AVEVA Diagrams User guide for more details on Defining Area Shape.
22 TEC
8/
5.11 Create a Title Block Shape
/1 SIN

Title Block shape can be used to annotate a diagram or template. Its behaviour is similar to Multi-label, but it
cannot be connected to any shape as it displays the attributes of the diagram or template. A shape for Title
23 er:

Block can be created using the Import Shape Wizard and then be dropped on a drawing as any other shape.
1/
te: m

5.11.1 Create a Title Block Shape - A Worked Example

Da sto

Typically the Title Block consists of several fields (grouped shapes) - each of them representing an attribute.
A shape that represents Title Block can be drawn using the available standard Drawing tool in AVEVA
Cu

Diagrams from the Home tab.

Once complete make sure that all the lines are grouped together using the right click context
menu Group > Group.

Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window.

Copyright © 2013. 77 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Select the appropriate category Annotation and navigate to the correct element type (e.g. Title block) that
corresponds to the previously drawn shape in the explorer pane to the left.

Enter the Shape name Title Block and

then click the Next button.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

The same process as previously shown is repeated until the user get to ‘Import Shape Wizard step 3 of 4:
Annotation Style Settings’ page.
23 er:
1/

In this Step, user can define

te: m

texts for particular fields can be

formatted according to the
Da sto

Attribute Presentation Notation

and line breaks are supported
in the same way as for Shape
Cu

Text. During importing Title

Block, font and colour of text
can be defined separately for
each field.

 To enhance the title block labels the user can combine native attribute presentation with PML1
expressions, for more information on annotation please see Appendix A

 The user can use PML1 expressions in the Shape Text attribute when creating a new symbol or editing
a master. For more information on PML1 Expressions please see Appendix A

Copyright © 2013. 78 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Click the Next button, until the shape is saved to the selected stencil.

Once the shape is saved to the selected stencil, the Title Block, can be drag and dropped on to a
diagram/template the annotation strings defined for particular fields are evaluated according to the existing
database attributes.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Those strings can be re-defined using the Shape

Cu

Data option from the right-click menu

of a single text field.

Copyright © 2013. 79 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.12 Create a Revision Block Shape

The Revision Block Shape is a table displaying revision-related information. Layout and content of this table
is configurable in AVEVA Lexicon, through the Revision Block (REVBLD) element referenced in the current
Revision Configuration (REVCON).

 For more information on Revision Configuration (REVCON), please see Section 9.

To use the Revision Block Shape in AVEVA Diagrams, it has to be imported beforehand using Import
Shape Wizard. In the Import Shape Wizard the Revision Block Shape type is available under Annotation
shapes.

5.12.1 Create a Revision Block Shape - A Worked Example

Use the available standard Drawing tool in AVEVA Diagrams from the Home tab draw a shape that
represents the Revision Block shape. Any two dimensional shape can be imported as a Revision Block.

11 A
2
- 2 NIC
/2
22 TEC
8/
Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
display the Import Shape Wizard window.
/1 SIN

Select the appropriate category Annotation and navigate to the correct element type (e.g. Title Revision
Block) that corresponds to the previously drawn shape in the explorer pane to the left.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 80 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Enter the Shape name Revision

Block and then click the Next
button.

11 A
2
The same process as previously shown is repeated until the user get to ‘Import Shape Wizard step 5 of 5:

- 2 NIC
/2
Revision Block Configuration’ page.

Step 5 of the Import Shape Wizard allows the user to select the Revision Block Configuration (REVBLD)
22 TEC
element, which will determine the Revision Block layout.
8/
/1 SIN
23 er:
1/

 All Revision Block

te: m

Configuration (REVBLD)
Da sto

element referenced in the

current used Revision
Configuration are displayed.
Cu

Select the click Finish button to add the shape to the selected stencil. The user will also be prompted to
Save Work. Click on the Yes button to save the imported shape.

Copyright © 2013. 81 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
 During the import process the shapes will be changed to a table with width and height dimensions of
8/
the original, source shape.
/1 SIN

In Diagrams Options, there are settings to enable and control how the Revision control mechanism should
behave when a user drag and drop the Revision block onto any drawing.
23 er:

Select the Revision Handling Options as highlighted. This option allows user to choose Revision
1/

Configuration Element to be used in Diagrams.

te: m
Da sto
Cu

Copyright © 2013. 82 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Choose Revision Configuration Element to be used in Diagrams by selecting the browse button as shown:

Then Click the OK button to save the

settings.

11 A
2
- 2 NIC
Then Click the OK button in the Diagrams Option dialog to save the settings.

/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

5.13 Create a Revision Mark Shape

The Revision Mark Shape is a specific “Label” shape. It displays number of a revision at which the
connected shape was modified for the last time. Revision Mark Shape can be sensitive to changes of
Database Attributes of the connected shape, graphical changes of this shape, or both.

Copyright © 2013. 83 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.13.1 Create a Revision Mark Shape - A Worked Example

Use the available standard Drawing tool in AVEVA Diagrams from the Home tab draw a shape that
represents the Revision Mark shape.

Once complete make sure that all the lines are grouped together using the right click context menu Group >
Group.

11 A
2
- 2 NIC
/2
Select the newly drawn shape to be imported and click on the Import Shape option from the Admin tab to
22 TEC
display the Import Shape Wizard window. 8/
Select the appropriate category Annotation and navigate to the correct element type (e.g. Revision Mark)
/1 SIN

that corresponds to the previously drawn shape in the explorer pane to the left.
23 er:
1/
te: m
Da sto
Cu

Enter the Shape name Revision

Mark and then click the Next button.

Copyright © 2013. 84 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Repeat the same process as shown in the previous example until the shape is saved to the required stencil.

11 A
2
Revision Mark Shapes can be setup in “Diagrams Options” via “Revision handling options” to detect

- 2 NIC
/2
changes of Database attributes of connected shape, graphical changes of this shape, or both.
22 TEC
To do this, the following Revision Mark fields in Revision handling options must be completed.
8/
Revision Marks on drawing changes: set to “True”.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Revision Marks Elements: Select preferred Element Types in this example SCEQUIP and SCVALV from
Select Element Types dialog.

Copyright © 2013. 85 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Revision Marks Attributes: Select preferred Element Types database attributes in this example
Cu

“Description” and “Name” from Select Attribute dialog.

Copyright © 2013. 86 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Stencil field: Select the Stencil that contains the appropriate Revision Mark Shapes. In this example select
‘/TRA_Stencil’ from the Select database element dialog.

Copyright © 2013. 87 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 All Revision Mark Shapes are created on separate layer named “Revision Marks”, allowing easy
visibility toggle.

11 A
2
- 2 NIC
/2
Revision mark shape field: Enter the Name of the shape representing the Revision Mark, in this case
‘Revision Mark’.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Finally click the OK button in the Diagrams Option dialog to save the settings. Select Yes button to save
changes of Diagrams Defaults.

Copyright © 2013. 88 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

5.14 Shape Protection

Preventing changes to shape attributes (like width or height) and locking shapes from being selected are
handy ways to prevent changes to drawings.

 Protection tab is only enabled for Admin User.For General Users the Protection tab is disabled.This is
to prevent the changes to the shapes attributes by general user.

5.14.1 Shape Protection – A Worked Example

Login with Admin User.Open SCDIAG in this case select SCDIAG A0-01-2012-0001. Select any shape or

11 A
shapes.

2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Shape Tab will be activated and is visible in the Main Ribbon menu

Copyright © 2013. 89 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Clicking on the Protection button displays the Protection window

11 A
2
- 2 NIC
/2
Width:
22 TEC
Locks the selected shape's width to prevent resizing. To lock a 1-D shape against rotation, you must lock its
width.
8/
Height:
/1 SIN

Locks the selected shape's height to prevent resizing.

Aspect ratio:
23 er:

Locks the ratio between a shape's height and width so that its proportions won't change when you resize it.
1/
te: m

X position:
Locks the x (horizontal) position of a shape so that it cannot be moved.
Da sto

Y position:
Locks the y (vertical) position of a shape so that it cannot be moved.
Cu

Rotation:
Locks a shape so that you cannot rotate it by using the Rotation tool. You can still rotate a 1-D shape by
dragging its endpoints. To lock a 1-D shape against rotation, you must lock its width.

Begin point :
Locks the begin point of a 1-D shape to a specific location so that it cannot be moved.

End point :
Locks the end point of a 1-D shape to a specific location so that it cannot be moved.

Text :
Locks the text in the shape so that it cannot be edited.

Format :
Locks the formatting (line, fill, text, shadow, corner rounding, transparency) in the shape so that it cannot be
edited.

Copyright © 2013. 90 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

From selection :
Locks the shape so it cannot be selected. For this setting to take effect, you must also select Shapes in the
Protect Document dialog box.
 To display the Protect Document dialog box, on the View menu, click Drawing Explorer Window. Right-
click the icon for the drawing file, and then click Protect Document.

From deletion:
Locks the shape so it cannot be deleted.

From group formatting :

Locks the formatting (color, fill, line, and shadow) in sub-shapes so that they do not change if the grouped
shape is formatted. You can still format a sub-shape by selecting it.

From theme colors :

Locks the shape so that it does not change if a color theme is applied.

From theme effects :

Locks the shape so that it does not change if an effects theme is applied.

From theme connectors :

11 A
Locks the shape so that it does not change if theme connectors are applied.

2
- 2 NIC
/2
From theme fonts :
Locks the shape so that it does not change if theme fonts are applied.
22 TEC
From theme index :
8/
Locks the shape so that it does not change if a theme index is applied.
/1 SIN

All :
Locks all options under Protect.
23 er:

 The Protection section in the ShapeSheet spreadsheet includes protection options not available in the
1/

Protection dialog box, such as locking against cropping, editing with any drawing tool, text editing and
te: m

formatting, group editing, and recalculation of height and width when you size the shape.
Da sto

None :
Unlocks all options under Protect.
Cu

Copyright © 2013. 91 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Check the required attributes to be locked. In this example, check All and then click OK. The attributes
which are left unchecked will be available for user to change.

11 A
2
- 2 NIC
/2
22 TEC
The shape is locked and no changes can be made in its attributes(width,length,postion). It can only be
unlocked by Admin User.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 92 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Login to Diagrams as General User and select the previously locked shape and go to Protection tab of
Shape properties. Protection button is disabled and no changes are allowed on this shape.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

 The Protection button is always disabled for General User,but if the Shapes are not locked for
Protection then these Shapes can be edited by the General User.

Copyright © 2013. 93 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 5 – Defining Shapes Configuration

1. Create the following symbols, Gate Valve, Nozzle, Elconn, Damper, Silencer, Reducer, Radius
Bend, Mitred Offset, Square Bend, Three Way, Oval Branch Connector and the Circular Branch
Connector and use the Import Shape Wizard to add them to the stencil.

2. Create the following line patterns, Pneumatic, Capillary and Electrical Line.

11 A
2
- 2 NIC
/2
22 TEC
3. Create an offline instrument with attachment line and an actuator.
8/
/1 SIN
23 er:
1/
te: m

4. If you have any other stencils in your system, import these stencils into your current project.
Da sto

5. Create a new template with your company title. You can insert an AutoCAD file to assist you with
this.
6. If you have any other template in your system, import these templates into your current project.
Cu

Copyright © 2013. 94 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 6

6 Create Shapes with Special Features in Microsoft Visio®

Creating shapes with special features, the Microsoft Visio® Shape Sheet has to be used. For technical
reasons, this is not available in the AVEVA Diagrams application. If the user needs to access the Shape
Sheet for making special settings in the shapes, the user will have to copy the shape to the Standard
Microsoft Visio® application, access the Shape Sheet, and then copy the shape back to AVEVA Diagrams.

Before the user starts to create the shape in Microsoft Visio®, set the grid size to fixed and 1mm spacing
and also make sure that the Run in developer mode is activated. This is done by selecting Tools >
Options and selecting the Advanced tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 95 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

6.1 Create Double Sided Connector Line - A Worked Example

Open Microsoft Visio®, and create a new blank diagram (Metric) by double click on the Blank drawing
icon. Alternatively single click on the Create icon to create a blank diagram.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 96 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

A blank diagram is then displayed.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Select the Developer tab and check the Drawing Explorer checkbox. The Drawing Explorer is then
Cu

displayed.

Select Line Patterns, right click and select New Pattern from the right click context menu.

Copyright © 2013. 97 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Name the new pattern line as HVAC Duct, pick the line pattern Radio button, select the third behaviour ,
check the Scaled check box and click OK.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

The HVAC Duct pattern appears in the Drawing Explorer Menu.

23 er:

Right Click the HVAC Duct Patterns and select Edit Pattern Shape option from the displayed context
menu. A new blank diagram is displayed.
1/
te: m
Da sto
Cu

Right click on any blank space of the diagram and select Show Shapesheet from the right click context
menu .On the Page Properties section of the ShapeSheet, change the PageWidth to 2mm and the
PageHeight to 4mm

Copyright © 2013. 98 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Draw the required lines. In this case, a horizontal line has been drawn 1 mm from
above and 1 mm from below; to create a branch connector of width 2 mm.
Cu

Close the diagram. The dialogue box below appears. Click Yes, after which the application switches to the
original diagram.

Copyright © 2013. 99 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Select the Connector Tool and draw a 4x6 line and right click the line and select weight > More Line from
the right click context menu. The newly created HVAC Duct appears under the Line Pattern. Select it, click
Apply then OK

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The connector line is now double sided and can be used in AVEVA Diagrams. Copy the connector line with
the HVAC Duct pattern.

Copyright © 2013. 100 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Paste the copied connector line with the HVAC Duct pattern into AVEVA Diagrams and import the shape.

11 A
2
- 2 NIC
/2
22 TEC
8/
Select the shape (HVAC Duct) to be imported and click on the Import Shape option from the Admin tab to
/1 SIN

display the Import Shape Wizard window.

Select the appropriate category HVAC Line elements and navigate to the correct element type (e.g. Line)
23 er:

that corresponds to the previously drawn shape in the explorer pane to the left.
1/
te: m
Da sto
Cu

Enter the Shape name HVAC Line and then click the Next button.

Copyright © 2013. 101 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Repeat the same process as shown in the previous example until the shape is saved to the required stencil.

 The same procedure can be used for

creating line patterns for the instrumentation

6.2 Creating a Label with an Attachment Line – A Worked Example

11 A
2
- 2 NIC
/2
For shapes that can be attached to other shapes using a control handle, such as labels and off-line
instruments, it can be preferred to have an attach line showing where the item is connected. This can be
achieved by going through the following steps:
22 TEC
Using the Line tool in Microsoft Visio®, Visio, create the shape as shown to represent the label and then
8/
group the shape together, this is done so the attachment line can appear behind the label.
/1 SIN
23 er:

 The same procedure can be used

1/

for creating line patterns for the

te: m

instrumentation
Da sto
Cu

Now with the shape grouped and the vertexes highlighted right click and from the right click context menu
select Show ShapeSheet.

Copyright © 2013. 102 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The user is required to insert two sections one for the Geometry and one for the controls, to do this right
click on the shape sheet and select Insert Section.

The Insert Section form appears, tick the two required sections and then click the OK button.

The two new sections are now visible inside the shape sheet window.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

In the Geometry section change the RelMoveTo for the X and Y to Width*0.5 and Height*0.5 and change
the RelLineTo for the X and Y to Controls.Row_1 and Controls.Row_1.Y
Da sto
Cu

This draws a line from the centre to the corner.

In the Control section, move the control point by dragging or use the control section to move the geometry
away from the corner, in the Controls.Row_1 for the X change to Width*1.9167

Copyright © 2013. 103 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

To ensure that the text of the created shape will be displayed in behind. Select the shape and click on the
Behaviour button from the Developer Tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Make sure that Group data field is set to "Behind

member shapes" in the Behaviour window.
Cu

Then click the OK button.

The text of the created shape will be displayed in behind member shapes.

 Please refer AVEVA Diagrams User guide for

more details on creating a label with an Attachment Line.

Copyright © 2013. 104 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The shape prepared can now be imported using the Import Shape Wizard as Offline Instrument or Label and
used in the drawing. This can be achieved by going through the following steps:

Copy the shape from Microsoft Visio®, into the AVEVA Diagrams application, by selecting the shape so
the vertexes are highlighted and right click, from the right click context menu select Copy.

Return to the AVEVA Diagrams application, right click and select Paste.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

To define the shape data for the shape, right click on the shape and select Data > Define Shape Data from
te: m

context menu to display the Define Shape Data form.

Da sto

In the Label field enter Text and then click the OK button.
Cu

Copyright © 2013. 105 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

To get the shape into the stencil, select the shape so the vertexes are highlighted and drag the shape into
the required stencil.

A message dialogue box appears, telling the user “This stencil is open read-only. Would you like to edit the
stencil, so that the operation can be complete?” click the Yes button.

The new shape is now added to the stencil, right click on the shape and from the right click context menu
select Rename Master. Key in the new name Label_Type1.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

 Remember to Save Work and save the stencil

Cu

 The above example will allow for creating a shape with desired behaviour only before Import Shape is
executed on the shape. It is because of the need to group shapes to achieve attachment line
functionality.

Copyright © 2013. 106 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

6.3 Creating a KKS Flag Annotation – A Worked Example

It is possible to create a flow sensitive annotation which reflects the true direction of the flow on a branch.
Any non-symmetrical shape created in Microsoft Visio® could be modified using the shape sheet and
imported into AVEVA Diagrams to be flow sensitive.

This can be achieved by going through the following steps:

Open Microsoft Visio®, and create a non-symmetrical shape that initially shows a flow direction horizontally
from left to right by default as shown. Making sure the shape is grouped

 The shape must be grouped.

Use the Shape Sheet and modify the text position and the rotation point as shown.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Right click on the shape sheet and select Insert Section option. The Insert Section form is displayed, check
Cu

the Text transform checkbox to insert the section and then click the OK button.

Copyright © 2013. 107 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

In the Text Transform section, modify the TxtPinX and TxtPinY where necessary to show the text in the
flag. In this example change the TxtPinY value to 30 mm

In the Shape Transform section, change the LocPinX and LocPinY value where necessary to move the
centre of rotation to the bottom-centre of the shape. In this example modify the following fields as shown:

Width 17.5mm
Height 21 mm
PinX 54 mm
PinY 89 mm
LocPinX Width*0.5

11 A
LocPinY Height*0

2
- 2 NIC
/2
22 TEC
8/
/1 SIN

The shape is transform in accordance with the data.

23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 108 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

This shape could be copied to AVEVA Diagrams and imported as a label using the Import Shape Wizard.
The Flow sensitive and Move with 2D shapes options could be set during the Import Shape Wizard or
after the shape is on the canvas using its right click context menu.

The shape text also could be set during the Import Shape Wizard, using Tools > Edit Master option from
the main menu or Shape Data Window afterwards.

11 A
2
- 2 NIC
/2
Enter the Shape name KKS Flag
and then click the Next button.
22 TEC
8/
/1 SIN

The same process as previously shown is repeated until the user get to ‘Import Shape Wizard step 3 of 4:
Annotation Style Settings’ page.
23 er:
1/

Step 3 of the Import

te: m

Shape Wizard allows user

to set the Flow sensitive
Da sto

and Move with 2D shapes

options could be set during
the Import Shape Wizard or
Cu

after the shape is on the

canvas using its right click
context menu.

Click the Next button, until

the shape is saved to the
selected stencil.

Copyright © 2013. 109 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
To use the flag annotation; drag and drop the shape on the canvas and connect it to a line using the yellow
22 TEC
diamond handle. If the connection is successful, the handle should turn red, the direction of the flag should
be adjusted according to the flow and the flag should display the attribute value of the connected element.
8/
The size and the position of the flag could be adjusted manually.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 110 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 7

7 Diagrams Rules

7.1 Consistency Check Rules

In AVEVA Diagrams the user can define rules to be applied during consistency checks. The Consistency
Rules and the Formatting Rules both reside in the Diagrams Rules form which can be reached via the Rules
command from the Admin tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
The Consistency Rules provide functionality to
configure actions depending on user defined conditions
/1 SIN

and create fully configurable definitions when a

consistency check is made.
23 er:

In the Diagrams Rules form, the main nodes will be displayed under the Diagrams Rules node. It is not
possible to remove or reorder these nodes, but they could be checked, partially checked or unchecked to
1/

determine whether the rules beneath are active or not. The same could be applied to rule sets or individual
te: m

rules as well. When a rule or rule set is not active it will be skipped by the consistency check, but could be
either executed manually or automatically on certain events.
Da sto

Using the right click context menus, the user can execute a number of commands.
Cu

Save This will save the changes made to the current rule set.
Export This will export the current rule set to an xml file.
Import This will import a rule set from an xml file.
Restore This will discard any unsaved changes, and will restore the current rule set
from the latest saved point.
Apply This will apply the current rule.
Create Rule Set This will create a new rule set.

Copyright © 2013. 111 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Create Rule This will create a new rule.

Rename This will rename a rule set.
Delete This will delete a rule set.
Cut This will cut a rule set or a rule.
Copy This will copy a rule set or a rule.
Paste This will paste a cut or copied rule set or a rule.
Rule Details This will open the Diagrams Rule Details form for the current rule.

 Copying and re-ordering is only possible in the scope of one kind of rules. As well as using the right
click context menu, drag and drop can be used to re-order the rules
 Depending on the hierarchy, it is possible to execute the commands on the right hand side of the form
as well

11 A
2
- 2 NIC
/2
22 TEC
8/
Consistency rules can be specified by modifying their rule name and description, selection criteria, check to
be performed on pre-selected shapes and the action to be taken on non-satisfying shapes. The details of
/1 SIN

each rule can be viewed and modified using the Diagrams Rule Details form.

The name and the description of the rules can be changed any time using the appropriate fields at the top of
the form.
23 er:
1/

In the Shape Selection Criteria, the user can determine which elements should be taken into account while
te: m

performing consistency check, e.g. bore size should be checked for inline components only. From the drop
down list, Type & attribute value, PML Expression or Shapes without DB element can be selected. Each
Da sto

of these options will enable the form to display attributes; a textbox to define the PML expression or further
options to specify the condition for the shapes without database element.
Cu

Copyright © 2013. 112 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The administrator can also determine which shapes are selected

using a Visio formula to filter the shapes on the page. i.e., formula
(BeginX- EndX)*(BeginX-EndX)+(BeginY-EndY)*(BeginY-
EndY)>10mm could be used if the rule should be applied to shapes
matching the given database criteria and in addition only if the
length of the connector is greater than 10 mm.

Once the selection criteria are given, it is possible to highlight the matching shapes on the currently open
drawing using the Highlight link label. The highlight could be reset using the Reset highlight link label.

The shapes selected according to the shape selection

criteria will be checked against the definition given as a
PML expression or the definition selected from the library
as shown.

The PML expression should be a Boolean type and it

should return a value of TRUE. Returning a FALSE value
will cause the actions in the next tab to be applied to all
shapes on the page that don’t comply with the shape
selection criteria.

11 A
2
- 2 NIC
/2
There are a number of standard checks defined in
Diagrams Consistency Rules Library, but it is also possible
to define custom checks. They should be defined as
22 TEC
classes implementing IDiagramsRulesCheck specified in
8/
Aveva.Diagrams.DiagramsRules in Aveva.Diagrams.dll.
To be automatically picked up, the class defining check
/1 SIN

should be placed in a dll named *ConsistencyRulesLibrary.dll.

23 er:
1/
te: m
Da sto
Cu

Checking the Execute for each connection checkbox will

apply the definition for every connection of a given shape and
action will be performed on every failed connection. If this
option is un-checked, checks are performed only once for
every shape matching selection criteria.

On the Actions tab, the administrator can define actions to be

taken on the shapes that have been selected by the shape
selection criteria and failed to satisfy check definitions.

The action can be defined as a PML macro which can be any

operation to be executed on a database element connected
with a shape.

Copyright © 2013. 113 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

In addition, it is possible to select a number of

actions from library. They can be added or
removed by using Add action and Remove
action link labels. Actions are executed in the
order they appear in the list. To modify this Move
up or Move down link labels can be used.
Similar to the check definition, actions are also
pre-defined in Diagrams Consistency Rules
Library, and also can be added by the
administrator. To add custom actions, the
administrator should define class implementing IDiagramsRulesActon specified in
Aveva.Diagrams.DiagramsRules in Aveva.Diagrams.dll. To be automatically picked up, the class defining
check should be placed in a dll named *ConsistencyRulesLibrary.dll.

As well as actions, severity of the rule and a message could be added to the rule details using the Actions
tab. The severity could be selected as Information, Warning or Error. The icon displayed in the Message Log
will depend on the severity of the rule and will be different for each. The message to be displayed in the
Message Log can be typed in the Message field.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Using the Rule Options tabs could be helpful in customising the behaviour of the rules on certain events.
23 er:
1/
te: m

Don’t execute rule on events The rule will be

executed
Da sto

manually.

Use default configuration Behaviour

Cu

depends on the
Consistency
Rules settings in
Diagram Options.

Custom configuration Behaviour is

specified locally
for the rule and
doesn’t depend on
default configuration.

Select Cosistency rules options from Diagrams options below:

Copyright © 2013. 114 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

7.2 Auto Formatting Rules – A Worked Example

In AVEVA Diagrams the user can define rules to be applied during the design to affect the formatting of the
shapes. The Consistency Rules and the Formatting Rules both reside in the Diagrams Rules form which can
be reached via the Rules command from the Admin tab as shown previously.

11 A
2
- 2 NIC
/2
22 TEC
Once the Diagrams Rules form is displayed, right click on the Formatting Rules node and select Create
8/
Rule Set option from the right click context menu. Key in a name for the rule set and click OK
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Having created and selected a rule set, it is possible to right click on

the rule set or the right hand side of the form and select Create Rule
from the right click context menu.

This will display the Diagrams Rule Details form which has 3 tabs,
Shape Selection Criteria, Format to be assigned and Rule options.

Copyright © 2013. 115 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The Shape Selection Criteria tab is used to specify which

items and which attributes should be used to select the
items. In this example the Criteria is set to Type and
attribute value, which means the type of item can be
selected from the drop down list below (in this case All is
selected) and the rules for applicable attributes and their
values are set-up in the grid below.

The alternative to the Type and attribute value method of selecting the criteria is to use a PML expression.
Key in the name and the description of the rule. In the Shape Selection Criteria tab, select the PSPE
attribute and key in SP/DR07C in the Value field as shown.

The administrator can also determine which shapes are selected using a Visio formula to filter the shapes on

11 A
2
the page as described previously.

- 2 NIC
/2
 If the administrator has access to the schematic design; to identify which items on the diagram match
this shape selection criteria the Highlight link on the form could be used, this highlighting can be
22 TEC
removed using the Reset highlighting link 8/
Once the selection criteria are specified as required, the desired formatting to apply to the matching items
/1 SIN

can be specified using Format to Assign tab. A variety of formatting options are available including the
ability to place the item on a drawing layer.
23 er:

 The drawing layer must have been previously set

1/

up to be visible in the drop down list

te: m

Clear auto formatting checkbox can be used to clear

Da sto

previous formatting applied by other rules if the items

fulfill the current rule criteria. When checked the
Cu

formatting table will be greyed out and disabled for

editing.

 This rule can be used as an exception clause, i.e.

one rule may say format everything with a spec of
SP/DR07C, a second rule could be set up using
the Clear auto formatting checkbox to clear the
formatting for any pipe under 100mm in diameter
 It is also possible to add or remove a user defined
style using Add format and Remove format,
provided that the Visio cell name and the value is
known.

The final tab of the Diagrams Rules Details form allows

the rule options for the application to be specified.

Copyright © 2013. 116 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

If the Apply rule to protected members of grouped shapes option is not checked then any format defined
in the rule will not be applied to group members protected from group formatting. It can be set by selecting
Format > Protection and checking appropriate checkbox in Protection form.

11 A
2
If the Overwrite guarded Visio formulas option is not checked then format will not be applied if

- 2 NIC
/2
corresponding cell in shape sheet is guarded, e.g. line colour will not be applied to shape if its LineColor
cell contains formula “=GUARD(7)”
22 TEC
 These options will be ignored and disabled for editing when “Clear auto formatting” is checked in
8/
“Format to be assigned” tab
/1 SIN

If the Apply rule automatically on events (if enabled) option is not checked then the rule will not be
executed automatically even if Auto apply rules setting is on whilst executing the rules.
23 er:

In the Handling Annotations section the settings provide the possibility to decide when shape matches the
1/

rule, format should be applied to the shape itself without its annotations (labels), to shape with its
annotations or to the annotations only.
te: m
Da sto

Once the rule has been set up as required, the Save button will save the rule and make it available to be
applied.
Cu

Additional options regarding the use of the auto formatting rules can be set up from the Diagrams Options,
accessed from the Options section in Project tab.

Copyright © 2013. 117 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

As rules are created the Auto Formatting Rules form will be updated. This form can be used to select which
rules or rule sets should be applied using the check boxes in the tree view.

 The rules are stored in xml files in the %PDMSDFLTS% folder

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 118 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 8

8 Link Documents

Each document or other resource, either external or internal, that can be linked to a database element is
represented in the database as Link Descriptor. The Link Descriptor's main role is to carry information about
the document it describes and a Uniform Resource Locator (URL).

It is possible for any other elements in the database to reference these Link Descriptors through a two-way
mechanism. This enables the users to find all elements that reference a particular Link Descriptor and the
reverse, to find all documents referenced by an element.

It is also possible to assign classification information to each Link Descriptor. The classification information
provides the facility of assigning multiple class information to a Link Descriptor so that a search for all
elements that have references to documents with specific classification assigned can be made. i.e., a search
can be made for all Link Descriptors classified as "Installation"- class document or all pumps that do not
reference any "Certificate" and "Security"- class documents.

11 A
2
- 2 NIC
/2
The schematic overview below shows the possible linkage to external documents and internal drawings.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Link World (LINKWLD)

All elements related to links are stored under Link World elements. To use links the user has to create at
least one Link World. It can store Link Folders, Link Classes and Link Descriptors.

It is possible to assign Link Descriptors to elements in other databases. It is therefore recommended that
LINKWL elements are created in a Schematic database of its own to which all relevant teams have read and
write access.

Link Folders (LNFOLD)

Under Link Worlds it is possible to organise all elements into a tree structure. The users can create Link
Folders that can contain more Link Folders or Link Classes and Link Descriptors. This way it is possible to
freely configure the hierarchy.

Copyright © 2013. 119 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Link Descriptor (LNDESC)

A Link Descriptor (LNDESC) element holds a link to documents and external resources. Both external
documents and draft drawing elements can be referenced using a LNDESC.

A Link Descriptor has the following attributes.

NAME User-defined name of the LNDESC element.

DESC Description of the element.
LNKURL A string storing raw Uniform Resource Locator of the linked document.

Link Class (LNCLAS)

The classification of documents is possible through use of Link Classes (LNCLAS). Each Link Descriptor
(LNDESC) may be classified by multiple classes. The diagram below shows how each LNDESC is
associated with more than one LNCLAS. A single Link Class may classify multiple Link Descriptors; in the
diagram LNCLAS1 is associated with all three LNDESC.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:

 A Link Class has the following attributes: NAME - user-defined name of the LNCLAS element.
1/

DESC - description of the element

te: m

 There is also a pseudo attribute available named LNKDOC that returns a list of LNDESC elements
Da sto

that are classified by this LNCLAS

Cu

8.1 Configuring the Links Hierarchy – A Worked Example

Before it is possible to link documents to database elements it is necessary to create at least one Link World
(LINKWL). The user can organise Link Descriptors and Link Classes into a hierarchy of folders.

From the main pull down menu, select Links command from the View tab, the Linked Documents form is
displayed. Select the Folders/Classes tab on the form and then right click and from the context menu select
New World.

Copyright © 2013. 120 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

A New Link world folder is created, change the name to TrainingLinkWorld. Right click and from the
context menu select New Folder. A New folder is created, change the name to TrainingLinkFolder.
Navigate back to the TrainingLinkWorld element and repeat this to create a class named
TrainingLinkClass

11 A
2
- 2 NIC
/2
22 TEC
8/
8.2 Adding Document Links – A Worked Example
/1 SIN

Using the Schematic Explorer navigate to the element that requires the link. From the right click context
menu of the current element or the Linked Documents form select Add Link.
23 er:
1/
te: m
Da sto

Or
Cu

Copyright © 2013. 121 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The Add Link to form is displayed. The user has four

options to choose a link category.
Existing link Allows user to add an already
existing link in the database
Existing file Allows user to add an already
existing file in the database
Web page Allows user to add a web
address
E-mail address Allows user to add an e-mail
address

Select the Web page category to add. A Name and a

Description may be added. Key in the web page
address or use the Browse button to open the internet
browser. Click the OK button to close the form.

The Select Destination container form appears, select the container inside which the link is going to be

11 A
created and click OK button.

2
- 2 NIC
/2
 A New World, New Folder or a
22 TEC
New Class can be created from
8/
the Select Destination Container
form by right clicking and
/1 SIN

selecting the required command

from the context menu
23 er:
1/
te: m
Da sto
Cu

The linked web page details can now be seen in the Linked Documents Form.

 Linked documents can be removed and the link broken by selecting the related document, right clicking
and selecting Remove from the context menu

Copyright © 2013. 122 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Folders including their contexts can be deleted by selecting the folder to be deleted and then right
clicking and selecting Delete command from the context menu

8.3 Assigning a Class – A Worked Example

Once a Document has been linked a Class can be assigned. From the Linked Documents folder select the
linked document to add it to a class. Select the Assigned Class required i.e. TrainingLinkClass by checking
the relevant check box.

11 A
2
- 2 NIC
/2
8.4 Displaying Links – A Worked Example
22 TEC
8/
If it is necessary for the user to check if a link exists, select the Links tab on the Linked Documents form and
/1 SIN

check the Follow CE check box. Using the Schematic Explorer the user can select each element to check if
a link has been added.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 123 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 6 – Linked Document

1. Add link to TRA_Stencil selecting the E-mail address category.

2. Add the same link to TRA_Diagram using Existing link category.
3. Display the links added to TRA_Diagram.
4. Add further links to design elements as per your company practise (i.e. Nozzle Spec).

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 124 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 9

9 Reporting Schematic Data

The AVEVA Plant Schematic database stores a large amount of 2D schematic information about each
element. The user can extract this data either graphically, in the form of diagrams, or in text form, in the form
of a report. This chapter describes the principles and practice of producing reports from the Schematic
database.

Reports on the Schematic database can currently be produced using any of the methods listed below:

▪ Visio Report
▪ Report Designer

9.1 Visio Report

11 A
2
- 2 NIC
/2
All of the information needed to generate a report can be saved in a report definition. A report definition
determines which shapes and properties are included in the report and how the report is formatted. The user
can save a report definition in a file or directly in a drawing. To use the same report definition to generate
22 TEC
reports from multiple drawings, the user must save their definitions in a file. To generate a report only in one
8/
drawing and easily distribute that drawing, save the definition in the drawing.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 125 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

9.1.1 How to Create Visio Report – A Worked Example

The user can set up report definitions to summarize data by including subtotals and grand totals in the
generated report. The user can also sort the report by columns and rows.

From the Tools tab in AVEVA Diagrams, select Reports > Visio Reports, the Reports form is then
displayed. Click the New button to display the Report Definition Wizard window.

Choose the desired shapes to report on, in this example select the Shapes on the current page radio
button and then click the Advanced button.

11 A
2
- 2 NIC
/2
22 TEC
8/
The Advanced form is then displayed. Select the
TYPE from the Property pull down list and equals
/1 SIN

from Condition from the pull down list. Enter in the

Value SCVALV and click the Add button to
populate the Defined criteria section of the form.
23 er:

Finally click the OK button.

1/
te: m

The previous form is once more displayed, click the

Next button. Select the properties to produce a
Da sto

report on by ticking the boxes i.e. Description,

Name, Scstype and Pspec and then click the
Next button.
Cu

Enter in a Report Title Valve_Report and then click

the Sort button to put the Report into the correct
reporting sequence.

Copyright © 2013. 126 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Move the Column order up or down to suit the report required, then click the OK button.

The previous screen appears once again, click the Next button. Key in a Name field Valve_Report, click the
Save in a file radio button and then click the Finish button.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

When the user runs the definition the data will be sorted with respect to the report definition given.
Cu

 For more information on

creating a report template see
the TM-1300 AVEVA Plant (12.1)
System Administration (Basic) or
TM-2120 AVEVA Marine (12.1)
System Administration (Basic)
Training Guides

Copyright © 2013. 127 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

9.2 Report Designer

Report Designer enables users to create new reports, bind them to data, and pass them to another
Workstation for loading into another instance of the Report Designer. In addition to report editing
capabilities, it allows the user to display print previews and to print reports and export or print reports in
different format such as PDF, HTML etc.

9.2.1 How to Create Report Template via Report Designer – A Worked Example

In AVEVA Diagrams, Report

Designer is accessed by
selecting Tools > Reports >
Reports > Designer from
AVEVA Diagrams main
toolbar. The administrator could
create the report template and
save it to be used later by the
user.

11 A
2
This will display the Report Designer window is then displayed.

- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 128 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

While creating a new report it is important that the administrator defines the Data Source and Scope of the
report. Click Data Source from Report Designer main toolbar, Data Source Wizard dialog is displayed as
shown below.

It is possible to define the data source by creating a

new one or using an existing DB view. The data
source created during this process will be saved into
the definition of the report. To create a new data
source select New and click the Next button.

11 A
2
- 2 NIC
/2
22 TEC
Selecting Next button, displays the Properties dialog.
8/
/1 SIN
23 er:
1/

In the Name field enter require name, in this example

te: m

enter Equip List

Da sto

In the Description field enter require description; in

this example enter Equipment List
Cu

Click Next button from the Properties dialog. The Base Element Types dialog of the wizard is then
displayed. Select at least one element type (in this case SCEQUIP), this will be the element type used to
populate the report.

Copyright © 2013. 129 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The list of elements shown may be filtered by typing in the filter box.

 The Database Type Filter may be

applied by selecting the required
database from the Database Types Filter
field pull-down list highlighted.

11 A
2
- 2 NIC
/2
22 TEC
8/
Select the required element(s) in this case SCEQUIP by clicking on them and use the arrow buttons to move
the selected elements for the data source to the Base Element Types box as shown below.
/1 SIN
23 er:
1/
te: m
Da sto

 The Ctrl and Shift keys may be used to

make multiple selections.
Cu

Click Next button from the Base Element Types dialog. The Filters dialog of the wizard is then displayed.

Copyright © 2013. 130 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 The Filters may be added to limit the

elements returned by the data source. These
filters maybe simple attribute based comparisons,
or more complex PML1 expressions.

 Enter attribute based comparison filters in

the Attribute Filters box. Enter PML1 expression
filters in the Expression Filters box.

To add a new filter click on Add Filter button, select the required attribute (in this case “Name”) to apply the

11 A
2
filter to and select the appropriate “Operator” which is this case “Contains”. Then enter the required

- 2 NIC
/2
Operator “Value” (in this case “/P”) as shown below.
22 TEC
8/
/1 SIN
23 er:
1/
te: m

 Multiple filters may be defined. To delete a

filter, select it from the list of filters and select the
Da sto

appropriate Delete Filter button

Cu

Click Next button from the Filter dialog. The Columns form of the wizard is then displayed.

 The Columns dialog or page allows user(s) to select the attributes to be included in the report for the
selected element types.

 The attributes of the base elements of the data source are displayed in the Available Columns box. If
multiple elements have been selected for the data source, then either all attributes of these element
types may be listed by clicking All Attributes, or only those common to all the selected element types
may be selected by clicking Common Attributes

Copyright © 2013. 131 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

To add attribute column to the data Source Columns pane, which will be included in the report, click on the
required and use the arrow buttons highlighted below to move the selected columns to the Data Source
Columns box as shown below.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

 For multiple selections, press Ctrl and Shift keys from the keyboard.

Click Finish button when the data source definition is complete.

23 er:
1/

The new data source is now available for use in the report. The data source is saved inside the report and
the Field List on the right-hand side will display the attributes selected in the Data Source wizard as shown:
te: m
Da sto

 The data source may be edited by selecting Edit option of the Data Source Wizard
Cu

Copyright © 2013. 132 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Select Equip List from Field List, Drag and drop the list to Detail section in the report or individually Drag
and drop required attributes to Detail section in the report.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Use the Standard Control functions to add Page Header, Report Header and Company Logo if required as
shown below.

Copyright © 2013. 133 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Click Preview tab to see a preview of current layout with the first 20 records available from the associated
data source:

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Click on Run Report as shown below to run the report definition with the actual data available from the
currently bound data source.

Copyright © 2013. 134 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
Select the Watermark Icon from the Run Report dialog to insert ghosted text as shown, if required.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The report can be saved, export or print in different format such as shown.

 The data source may be edited by selecting Edit option of the Data Source Wizard

Copyright © 2013. 135 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Click on Save button from Report Designer main toolbar as highlighted below or menu option to save the
current report definition as a report definition or report layout.

11 A
2
- 2 NIC
/2
22 TEC
Enter appropriate File name, in this case enter “Equipment List” as shown and Click on Save button to save
8/
the file.
/1 SIN
23 er:
1/

The file is save to User:

te: m

%PDMSUSER%\Data\Reports
Da sto

as shown
Cu

Copyright © 2013. 136 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 7 – Report

1. Create a report using one of the functionalities described above to list all equipment items with Spref
unset. Create columns to display Name, Description, Spref, and Position.
2. Experiment with the sorting facility and notice the way it changes the output.
3. Create a report template using one of the functionalities.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 137 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 138 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 10

10 Status Control Configuration

10.1 Overview

The Configuration of Status sequences and their status values is an administrative task done for each
project. The configuration data is defined in the Lexicon module and is stored in the Dictionary database.

 This chapter will require work in the Lexicon module (DICT database). Please make sure you have the
required type of database with sufficient rights included in your current MDB

Normal Lexicon commands for creating and deleting elements and setting the attributes values, are
available to allow the systems administrator to build the status sequence and status value data structure.

Status Management is the ability to control and report on the status of individual model objects as they

11 A
2
progress through their lifecycles. It can be applied to any model objects, i.e. tagged items, catalogue

- 2 NIC
/2
components, drawings etc. the example below is a typical workflow:
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 139 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The status Management data model defines a workflow as a status definition owning a set of Status Values.
Individual model objects reference the status value via a status link object as shown below. Status data is
stored on the status link objects the user does not need write access to the model object in order to set its
status. The status link objects are distributed globally with the model objects they refer to. They are not
visible to the end user, but the status data is available as pseudo attributes.

Schematic Database (Diagrams) Dictionary Database (Lexicon)

Globally distributed with

model objects

Status Link World

11 A
2
Status Link Status Definition

- 2 NIC
/2
Element Ref
Status Value Ref
Comment: Text
22 TEC
Diagram
8/
/TRA_Diagram
Pseudo Attribute
/1 SIN

Design Status Value: Work Completed

Design Status Number: 40%
23 er:
1/
te: m

Status Value
Da sto

10.2 Creating a Status World - A Worked Example

Cu

Having selected a writable element, from the Dictionary Explorer, right click and from the context sensitive
menu select Create > STAWLD: Status Configuration world, the Current Element Editor is now active for
the new element key in the Name ‘Diagrams_Status_World’ and the Description ‘Diagrams Status
World’.

Copyright © 2013. 140 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Navigate to the STAWLD. Select Create from right-click menu and click on STAGRP option from the right-
click submenu. In the new element key in the Name ‘Diagrams_Status_Group’ and the Description
‘Diagrams_Status_Group’.

10.3 Creating a New Status Definition - A Worked Example

11 A
2
- 2 NIC
/2
Using the Dictionary Explorer navigate to the newly created Diagrams_Status_Group’, click the right
mouse button and from the context sensitive menu select Create > STADEF: Status Definition.
22 TEC
Update Current Element Editor accordingly: 8/
Name field: Diagrams_Status
/1 SIN

Description field: Diagrams_Status

23 er:
1/
te: m
Da sto
Cu

Click in the ‘Controllable element types’ field and a browse icon is activated.

Copyright © 2013. 141 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Click the activated browse icon, the ‘Select element type’ form is displayed, in the Filter field key in SCD,
select SCDIAGRAM from the resultant list and then click the Add to List button, this adds the selected
element to the Chosen element types list. Additional elements could be added if required, if no more
elements are required click the OK button.

11 A
2
- 2 NIC
/2
10.4 Creating a New Status Value
22 TEC
8/
Using the Dictionary Explorer navigate to the newly created Diagrams_Status definition, click the right
mouse button and from the context sensitive menu select Create > STAVAL: Status Value.
/1 SIN

The Current Element Editor can now be updated key in the Name WorkPending, the Description Work
Pending and Numerical value 0.
23 er:
1/
te: m
Da sto
Cu

Repeat this process to create additional Status Values using the given data below.

Name Description Numerical Value

Work_Started Work Started 20

Work_Suspended Work Suspended 15
Work_Complete Work Complete 50

Copyright © 2013. 142 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

10.5 Setting the Transitions - A Worked Example

Once all the Status Values have been created the Transitions need to be set up against each status value.
Using the Dictionary Explorer navigate to the first Status Value ‘Work_Started’, in the Current Element
Editor, select the Valid transactions field, a browse button appears.

Click the browse button and the Select Valid status transitions for is displayed. Click the Valid transitions i.e.
Work_Started and click the OK button.

11 A
2
- 2 NIC
/2
Now the ‘Promote’ and ‘Demote’ transactions can now be populated from the pull down list. i.e. Set
Promote field to ‘Work_Started’.
22 TEC
8/
/1 SIN

 When there is more than one Promote valid

transaction the one selected becomes the default and if
the other valid transaction is required this can be selected
23 er:

from the Status Controller in Outfitting using the Edit

1/

Status option.
te: m
Da sto
Cu

Repeat this process adding the Valid transactions, the Promote and Demote for each status value as given
below.

Status Value Valid Transactions Promote Demote

Work_Started Work_Suspended Work_Complete Work_Suspended

Work_Complete

Work_Suspended Work_Started Work Started

Copyright © 2013. 143 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

It is possible to view the definition values in a graphical view using the right click context menu as shown:

11 A
2
- 2 NIC
/2
Once all the Valid Transactions have be setup, the administrator needs to select Lexicon > Save Work, a
22 TEC
confirm form appears, click the Yes button to confirm.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 144 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 8 – Status Control Configurations

1. Create additional Status Values to “Diagrams_Status” definition created in ‘Section 10.4’, using the
given data below:

.
Name Description Numerical Value

Rework Rework 25
For_Check For Check 60
Checked Checked 80
Approved Approved 90

2. Using the procedure explained in ‘Section 10.5, adding the Valid transactions, the Promote and Demote
for each status value as given below:

Status Value Valid Transactions Promote Demote

11 A
2
Work_Complete For_Check For_Check

- 2 NIC
/2
Rework For_Check For_Check
22 TEC
For_Check Checked Checked
8/
/1 SIN

Checked Approved Approved Rework

Rework
23 er:

Approved Work_Started Work_Started

1/
te: m
Da sto
Cu

Copyright © 2013. 145 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 146 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 11

11 Revision Control Configuration

The Revision Control Mechanism is a version control tool. It allows user(s) to create a working revision,
which can be later promoted to Issued (read-only) state. This process could be repeated resulting in multiple
Issued Revisions of a drawing.

The Revision Control Mechanism is based on Status definitions; as a result administrator must ensure that
there is a preferred status definition that has the Schematic Diagram element type in its list of controlled
element type.

Revision Control configuration setup consist of three parts, this is illustrated below:

▪ Revision Number Definition

▪

11 A
Revision Block Definition

2
▪
- 2 NIC
/2
Revision Configuration 22 TEC
- Revision Configuration World
8/
/1 SIN

- Revision Configuration Group

23 er:
1/

Revision Number Definition

te: m
Da sto

Revision Block Definition

Cu

Revision Configuration Definition

The Revision Control Configuration is defined in the LEXICON module of the AVEVA Administration
product and is stored in the Dictionary database.

 This chapter will require work in the Lexicon module (DICT database). Please make sure you have the
required type of database with sufficient rights included in your current MDB

Copyright © 2013. 147 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11.1 Revision Number Definition – A Worked Example

This worked example illustrates how to configure a revision numbering system for Revision Control
Mechanism in AVEVA applications.

To start the creation of revision elements, administration folders/ containers must be created. Navigate to
the Dictionary World /*. Select Create from right-click menu and click on REVCWL option from the right-
click submenu.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Enter the following data in the appropriate Current Element Editor Form textboxes
Cu

Name: Diagrams_Revision_World

Navigate to the REVCWL. Select Create from right-click menu and click on REVCGP option from the right-
click submenu.

Copyright © 2013. 148 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Enter the following data in the appropriate Current Element Editor form textboxes.

11 A
2
Name: Diagrams_Revision_Group

- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

To define the ‘Revision Number’; navigate to the REVCGP Group, select Create from right-click menu and
te: m

click on REVNOD (Revision Number Definition) option from the right-click submenu to create a REVNOD
revision element.
Da sto
Cu

Select “Edit Revision Number Definition” from right-click menu submenu of the newly created REVNOD
to display the Revision Number Definition form.

Copyright © 2013. 149 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Enter the following data in the appropriate textboxes:

23 er:
1/
te: m

Display Name: Diagrams_Revision_Number

Da sto


Cu

The displayed name is a user defined

name. User can enter any preferred name.

Working Revision text: Enter any desired text e.g.

*

 Working revision text is displayed after the

revision number on a non-issue version of a
diagrams e.g. A01*.

Copyright © 2013. 150 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Number of Parts: Select the number of revision

parts e.g. “2”

 A revision number can have several parts.

Each part is either alphabetic or numeric.

Part: Select the revision part number e.g.”1”,

Part Name: Enter appropriate Part Name e.g.

“Major”

Value type: Set the part number value type e.g.

“Alphabetic”.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Number of Parts: Select the number of revision

parts e.g. “2”
23 er:

Part Name: Enter appropriate Part Name e.g.

“Minor”
1/
te: m

Value type: Set the part number value type in this

Da sto

case. “Custom” to set up a custom defined

sequence of characters.
Cu

To display the dialog for entering the sequence

values click the Set button.

Enter each value on a separate line. The values can contain only alphabetic and numeric characters. A
value can be more than one character long.

Copyright © 2013. 151 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
The Test button will generate a test sequence and check if any duplicate values can be generated with the
8/
sequence.
/1 SIN
23 er:
1/
te: m
Da sto
Cu

 The “Test Revision Number” form is shown with sample values from the sequence for each part and
the combined revision number. If there are duplicate values it will show a message and highlight
duplicate values in red.

Copyright © 2013. 152 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11.2 Revision Block Definition – A Worked Example

Navigate to the REVCGP Group (Revision Configuration Group), select Create from right-click menu and
click on REVBLD (Revision Block Definition) option from the right-click submenu to create a REVBLD
revision element.

11 A
2
- 2 NIC
/2
Select “Edit Revision Block Definition” from right-click menu submenu of the newly created “REVBLD”
22 TEC
(Revision_Block) to display the Revision Block Definition form.
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Enter the following data in the appropriate textboxes.

Copyright © 2013. 153 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Display Name: Diagrams_Rev

 The displayed name is a user defined

name. Users can enter any desired name.

Status definition: Select the appropriate the status

definition e.g. “Diagrams Status”.

 The Schematic Diagrams element type “SCDIAG” must be added to status definition list of
controlled element type.

Select the “Add attribute” option to add desired attributes to the attribute column and enter preferred name
in the “Header” column.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN


23 er:

The attributes are derived from status values. The attribute drop down contains fields for all states in
the selected status definition.
1/


te: m


Da sto




Cu

Select the “Display headers” checkbox option to

display the headers.

Click the “OK” button from the “Revision Block

Definition” form to save the settings.

Copyright © 2013. 154 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11.3 Revision Configuration Definition – A Worked Example

Navigate to the REVCGP Group (Revision Configuration Group), select Create from right-click menu and
click on REVCON (Revision Configuration) option from the right-click submenu to create a REVCON
revision element.

Select “Edit Revision Block Definition” from right-click menu submenu of the newly created REVCON
(Revision Configuration) option.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Display Name: “Diagrams_ Revision_ Confi”

 The displayed name is a user defined name. Users can enter any desired name.

Copyright © 2013. 155 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Element type: Select the Schematic Diagrams element type “SCDIAG” via the ellipsis button.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 156 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Status definition: Select the appropriate Status definition

from the pull-down list e.g. “Diagrams Status”. Associated
revision block definition will automatically be displayed.

Create working revision at: Select the appropriate Status

definition value from the pull-down list e.g. “Working
Started”.

Issue revision at: Select the appropriate Status definition

value from the pull-down list e.g. “Approved”.

Revision number definitions: Select the appropriate

Revision number definition from the pull-down list e.g.
“Diagrams_Revision_Number”.

11 A
2
Revision block definitions: Revision number definition

- 2 NIC
/2
checkbox must be selected.
22 TEC
8/

/1 SIN

 The Revision block definitions are optional, but should be selected for any configuration that uses them.
The Datasheets application will list the selected revision blocks in the datasheet template explorer.
23 er:

Click the “OK” button from the Revision Configuration form to save the settings.
1/
te: m

Fully configured Revision Control configuration setup consists of three parts as shown below:
Da sto
Cu

Copyright © 2013. 157 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Exercise 9 – Revision Configurations

1. Defined preferred Revision control configuration for Schematic Diagrams element type “SCDIAG” as
shown.

(a) Revision Number

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

(b) Revision Block

te: m
Da sto
Cu

Copyright © 2013. 158 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

(c) Revision Configuration

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 159 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 160 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 12

12 Project Explorer

The Project explorer is a user interface based on the AVEVA Flexible explorer tool.

This interface allows for the presentation of schematic and engineering items structured according to 2D
modelling preferences, functional locations or any other user defined structure formats. These structure
formats are displayed in a hierarchical form within the AVEVA Diagrams application.

Each structure can be based on a template which is also defined as a ‘Root Node’. Further nodes can be built
beneath the root node. Templates and their contents are represented as individual hierarchies within the
Project Explorer. Every template is configured to be primarily based on a type (or purpose) of data, e.g.
Schematic objects, Systems, Classes, and Documents or as a Project BreakDown Structure (PBS).
Unlike the conventional tree view explorer, the Project explorer has a dynamically active hierarchical structure.
This means that the location of items can be dependent on the current set criteria, object types and attribute
values.

11 A
2
- 2 NIC
/2
The Project explorer is fully configurable and can be setup within the LEXICON module of the AVEVA
Administration product, or by XML configuration. LEXICON procedures required for a typical configuration
are demonstrated in this chapter.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 161 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

12.1 Flexible Explorer node configuration structure

Using the Flexible explorer tool the Project Explorer can be configured according to the Lexicon/dictionary
elements hierarchical structure shown:

Each box/nodes on the diagram is defined as shown:

11 A
2
- 2 NIC
/2
PBS Templates world:
PBSWLD
The top-level administrative element, which
holds the PBS Templates.
22 TEC
8/
PBS Template Definition:
/1 SIN

PBSTPL This is a definition of separate hierarchy structure, and is

presented as a single root node
23 er:
1/
te: m

PBS Object Node:

This can represent database objects, and can be used to define the
Da sto

PBSOBN generation of a set of nodes beneath the hierarchical level it is

placed. The nodes and their inherent members will be dynamically
Cu

updated when the attributes or criteria of related database objects

are modified

PBS Text Node:

PBSTXN This is simply a generating node, and does not represent any
database object. But they can contain PBSOBNs

PBS Criteria:
PBSCRT This element is used to position resulting objects from defined
nodes, beneath an appropriate/required parent nodes

 The demonstrations in the following worked examples cover the creation and definition of the
dictionary elements for a sample schematic project explorer. This explorer will be developed and
structured to display hierarchies for schematic diagrams, equipment, offline instruments, lines and
their inherent inline components, for available schematic areas.

Copyright © 2013. 162 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

12.2 Configure Project Explorer

This section covers the detailed configuration procedures required to build up a standard schematic project
explorer. Prior to configuring a project explorer, the user must have clearly defined the requirements and
purposes of the explorer. This will enable for appropriate procedures to be followed to achieve the required
explorer behaviours.

The generated schematic explorer will be largely similar to the default schematic database explorers except
for additional hierarchy elements, and specific explorer behaviours.

These configuration exercises are conducted within the LEXICON module of an AVEVA Administration
product within an appropriate dictionary (DICT) database.

12.2.1 Creating a PBS World (PBSWLD) – A Worked Example

Within the Dictionary Explorer of the Lexicon module, select the topmost element in the dictionary explorer
(Dictionary World), click the ‘Create’ entry on the menu bar, or right click to display the context menu and
click the ‘Create’ > ‘PBSWLD: Flexible Explorer Templates World’ entry, to create a PBS Templates

11 A
world

2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Within the Current Element Editor, fill in the attribute details of the created PBS world as shown.
Cu

12.2.2 Creating a PBS Template (PBSTPL) – A Worked Example

Select the created PBS World, display the context menu and click ‘Create’ > ‘PBSTPL: Flexible Explorer
Template Definition’ to create Flexible Explorer Template definition.

Copyright © 2013. 163 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

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

11 A
2
- 2 NIC
/2
The ‘Flexible Explorer Text’ entry specifies the text to be displayed on the created template, like a node
22 TEC
name. This is set to ‘Schematic Project Explorer’.
8/
‘Flexible Explorer Sorting’ entry specifies the order in which items generated from nodes beneath the root
/1 SIN

node/template will be placed. This is set to ‘Natural Unless Type forces Sequence’, which is selected from
the pick list. Hence items with node texts which begin with earlier alphabets will be listed/ordered first before
lower alphabets, except in the cases where items are listed beneath types.
23 er:

A user defined context menu can be referenced and setup for the template node with the ‘Flexible Explorer
1/

Context Menu’. This could be extracted from a method within a pml function using the ‘Flexible Explorer
te: m

Expression Editor’ form.

Da sto
Cu

 An example on the use of this function will be demonstrated later in this chapter

Each node and items on the Flexible Explorer interface can have an icon displayed next to its text. The
‘Flexible Explorer Icon’ entry specifies what icon is to be displayed by typing in the icons name (as this must
already exist in the Shared Resources location) or can be derived with a PML 1 expression.

Copyright © 2013. 164 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

This will be left blank, which will have a default icons representing the objects displayed in the explorer.

From the created PBS World, and PBS Template, the resulting explorer hierarchy will be displayed within the
AVEVA Diagrams application as shown:

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

 The user will have to log into the Diagrams module of the Diagrams 14.1.SP1 application, click the
Project Explorer button to display the Project Explorer. If the explorer user interface is already
23 er:

being displayed, then running a ‘Getwork’ updates the contents of the explorer with changes from
1/

the Lexicon module

te: m
Da sto

12.2.3 Creating a PBS Object (PBSOBN) – A Worked Example

Cu

Select the created PBS Template, display the context menu and click ‘Create’ > ‘PBSOBN: Flexible
Explorer Object Node’ to create PBS Object Node.

Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown:

Copyright © 2013. 165 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The ‘Flexible Explorer Text’ entry is specified by an expression which first checks if derived groups have a
‘NAME’, before combining the identified name with the reporter text and type sequence of the resulting object
separated by a space. This way the display texts (node name) of the derived objects are generated.

The selection of a ‘Flexible Explorer Formula Type’ entry determines the kind of formula or method which is
used to derive the objects to be listed in the explorer (resulting nodes). Select the ‘PML expression’ entry
from the pick list.

11 A
2
- 2 NIC
/2
The ‘Flexible Explorer Formula’ entry is a text attribute whose entered values is dependent on the formula
type selected. Type in: ‘Collect all scgrou’. This will fetch all available Schematic group objects available in
schematic databases within the current MDB.
22 TEC
‘Flexible Explorer Sorting’ entry is set to ‘Same as on Parent’. Resulting nodes will be ordered using the
8/
same selection that was selected for the owning PBSOBN element (Natural Unless Type forces sequence)
/1 SIN

From the created PBS object, the resulting explorer hierarchy will be displayed within the AVEVA Diagrams
application as shown:
23 er:
1/
te: m
Da sto
Cu

12.2.4 Creating a PBS Object (PBSOBN) – A Worked Example

Select the created PBS Object, display the context menu and click ‘Create’ > ‘PBSTXN: Flexible Explorer
Text Node’ to create PBS Text Node.

Copyright © 2013. 166 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

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

11 A
2
- 2 NIC
/2
22 TEC
8/
‘Flexible Explorer Formula Type’ entry is set to ‘PML function’ as this specifies that the following ‘Flexible
/1 SIN

Explorer formula’ entry will be a global variable (and an argument) which points to a pml function within
the current pml library. Enter: ‘!!getNonEmptySchematicClasses()’
23 er:

The PBS formula could also be entered using the ‘Flexible Explorer Formula Editor’ form
1/
te: m
Da sto
Cu

This node will collect schematic classes for each of the schematic groups

 The pml functions should be available by default within the AVEVA Diagrams 14.1.SP1 product
installation or will be made available along with the copy of the supplied Training project utilised for
this training

‘Flexible Explorer Formula Type’ entry is set to ‘PML function’ as this specifies that the following Flexible
Explorer Formula entry will be a global variable (and an argument) which points to a pml function within the
current pml library. Enter: ‘!!getNonEmptySchematicClasses( '#PARAM(/SchematicGroups)' )’

Copyright © 2013. 167 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The entered formula reads and deploys the methods contained within the referenced PML function. This
particular function is designed to generate nodes which will specifically hold objects of schematic object

11 A
2
types/Classes. This will create folders in the explorer hierarchy which will be named after the schematic

- 2 NIC
/2
element type of the objects they will contain. This means that when a schematic object is created, it will be
grouped by its schematic element type folder.
22 TEC
The FlexibleExplorer Formula Editor can also be utilised to enter the pml expressions or function necessary
8/
for to derive/generate the required object nodes. Parameters can be selected as function arguments for an
entered pml function. This could be required in order for the function to be deployed for the subjects of the
/1 SIN

argument.

Place the cursor inside the parenthesis ( | ) and then click the ‘Insert parameter’ link label, then select the
entry as shown:
23 er:
1/
te: m
Da sto
Cu

This essentially means that schematic classes could be derived for each existing group (derived earlier from
within the ‘Schematic Groups’ PBSOBN).

 The selected parameter is PBSOBN which was created earlier

Copyright © 2013. 168 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Select the created PBS Text node (SchematicClassesForGroup), and ‘Create’ > ‘PBSOBN: Flexible
Explorer Object Node’ to create a PBS Object Node.

This PBS object node (PBSOBN) will derive and generate schematic database objects, and locate them within
their appropriate schematic classes.

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

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

The Flexible Explorer Text entry derives the name/title of the objects with the entered expression as
te: m

explained previously: <ISNAMED ? NAMN : REPTXT + ' ' + STRING(TYSEQUENCE)>

Da sto

‘Flexible Explorer Formula Type’ entry is set to ‘PML expression’. For the Flexible Explorer Formula
entry, use the FlexibleExplorer Formula Editor form as described previously:
Cu

Copyright © 2013. 169 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The formula indicates that the objects to be generated will be an

item(s) whose element type/class has been derived from the parameter
(SchematicClassesForGroups) which was previously created, and
these will be for all collected schematic groups within the node
(SchematicGroups).

‘Flexible Explorer Context Menu’ ensures that the resulting objects

will be able to display a context menu when they are selected and right
clicked. The contents/entries of the context menu are obtained from a
default xml file which are located in the installation directory of the
AVEVA Administration product. This should be set as
AVEVA.Diagrams.FlexExplorer.Menu.Context

Run a ‘Savework’ within the LEXICON module, and then a ‘Getwork’

action within the AVEVA Diagrams application, to display the resulting
schematic project explorer as shown:

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m

 The referenced pml functions were configured to first collect and list
Da sto

available schematic groups, then schematic element types/classes were

configured to be located within the groups
Cu

 Derived schematic objects were located within their appropriate

schematic element types/classes, within their relevant schematic groups

 The behaviour and contents of the object context menu is derived

from the PBS context menu entry expression. This expression references
the ‘TagAddins.xml’ an xml file located within the installation location of
the AVEVA Diagrams product and which contains instructions on the menu
entries and behaviour, hence allowing the context menu to be visible when
displayed from the derived object as shown.

Copyright © 2013. 170 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

12.2.5 Configure nodes for Element Members – A Worked Example

Further PBS Text nodes and Object nodes can be configured to cater for member elements of items which
can be seen as parent object. For example, the Flexible explorer can be configured to display available
nozzles beneath equipment items.

Select the last created PBS Object (SchematicItems), display the context menu and click ‘Create’ >
‘PBSOBN: Flexible Explorer Object Node’ to create a PBS Object Node.

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

11 A
2
- 2 NIC
/2
22 TEC
For the name of the node, enter: PrimaryVisibleMembers.
8/
The Flexible Explorer Text entry which derives the name/title of the member will be an expression which is
similar to that described previously: <ISNAMED ? NAMN : REPTXT + ' ' + STRING(TYSEQUENCE)>
/1 SIN

‘Flexible Explorer Formula Type’ entry is set to ‘PML function’.

23 er:

For the Flexible Explorer Formula entry, use the FlexibleExplorer Formula Editor form as described
1/

previously, and enter the global variable which references the pml function which derives any member
te: m

elements for derived explorer object items: !!getPrimaryVisibleMembers()

Da sto

An argument (/Schematicitems) will need to be referenced to define the scope of the derivation action. This
is achiever just as described previously.
Cu

Copyright © 2013. 171 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The creation of this node will now make it possible for the valid member elements of the derived objects to
also be derived and appropriately located beneath their owning
schematic object as shown.

Do note that the derivation of the member elements is limited to a

certain membership hierarchy level. This means that only members
items of certain objects will be listed, and not the members of
members.

Observe that the members of the pipe segments are not derived.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Create 2 new PBS object nodes to derive the member of member objects, and this will also be setup to derive
further member objects if they exist and are applicable for the owning member items. This is as shown:
23 er:
1/
te: m
Da sto
Cu

For the names of the nodes, enter: PrimaryMembers1 and PrimaryMembers2

The Flexible Explorer Text entry: <ISNAMED ? NAMN : REPTXT + ' ' + STRING(TYSEQUENCE)>

‘Flexible Explorer Formula Type’ entry is set to ‘From owners attribute’.

For the Flexible Explorer Formula entry, use the Flexible Explorer Formula Editor: memb

‘Flexible Explorer Context Menu’: AVEVA.Diagrams.FlexExplorer.Menu.Context

Copyright © 2013. 172 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Flexible Explorer Recurrent Node: PrimaryMembers1.The recurrent node ensures that the evaluation for
member items will be a recurrent action within the selected node.

Run a ‘Savework’ within the LEXICON module, and then a ‘Getwork’ action within the AVEVA Diagrams
application, to display the resulting schematic project explorer as shown:

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

12.2.6 Configure nodes for Secondary Classes – A Worked Example

Having configured nodes to derive and display member items for schematic objects, it is also possible to
configure a set of schematic classes beneath derived schematic diagram objects (SCDIAG). This will
essentially allow the user to navigate across a secondary hierarchy of schematic objects.

This is intended to quickly collect, group and display the schematic objects which are located in a selected
drawing.

Navigate to the PBSOBN SchematicItems node, and create a PBSTXN node beneath and detail this as
shown:

Copyright © 2013. 173 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

For the name of the node, enter: SecondaryClasses

‘Flexible Explorer Formula Type’ entry is set to ‘PMLfunction’.

For the Flexible Explorer Formula entry, enter

!!getSchematicClassesForSecondary(#PARAM(/SchematicItems) )

11 A
 Run a ‘Savework’ in the LEXICON module and ‘Getwork’ in the Diagrams application to display

2
- 2 NIC
/2
the schematic classes beneath a diagram object in the project explorer
22 TEC
8/
Navigate to the PBSTXN SecondaryClasses node and create a new node which will derive available
objects for each of the classes beneath the SCDIAG object, as shown:
/1 SIN
23 er:
1/
te: m
Da sto
Cu

For the name of the node, enter: SecondaryMembers

‘Flexible Explorer Text’ entry is set to ‘FLNN’.

‘Flexible Explorer Formula Type’ entry is set to ‘PMLfunction’.

For the Flexible Explorer Formula entry, enter: !!getSecondaryMembers(#PARAM(/SchematicItems) )

Next create nodes which will derive member items for the derived objects (example, nozzles for equipment).
These nodes are created just as was done previously:

Copyright © 2013. 174 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

For the names of the nodes, enter: PrimaryMembers3 and

PrimaryMembers4

The Flexible Explorer Text entry: <ISNAMED ? NAMN : REPTXT + ' '
+ STRING(TYSEQUENCE)>

‘Flexible Explorer Formula Type’ entry is set to ‘From owners

11 A
attribute’.

2
- 2 NIC
/2
For the Flexible Explorer Formula entry, use the Flexible Explorer
Formula Editor: memb
22 TEC
‘Flexible Explorer Context Menu’:
8/
AVEVA.Diagrams.FlexExplorer.Menu.Context
/1 SIN

Flexible Explorer Recurrent Node: PrimaryMembers3.The recurrent

node ensures that the evaluation for member items will be a recurrent
action within the selected node.
23 er:
1/
te: m
Da sto

 Run a ‘Savework’ in the LEXICON module and ‘Getwork’ in the Diagrams application to display
the secondary schematic classes, their objects and member items beneath a diagram object in the
Cu

project explorer

Copyright © 2013. 175 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

12.2.7 Creating a PBS Criteria Node (PBSCRT) – A Worked Example

The PBS criteria element ensures that the derived objects within the node where it is created correctly fits to
its parent hierarchy.

This means that when items are created, the criteria element will help determine and correctly enforce the
placement of these items within the appropriate node.

Select the previously created PBS Object PrimaryMembers3, display the context menu and click ‘Create’ >
‘PBSCRT: Flexible Explorer Criteria’ to create a PBS Criteria.

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

11 A
2
- 2 NIC
/2
22 TEC
8/
The PBS criteria must be created beneath the item for which the location checks will have to be made.
/1 SIN

Hence in the example shown, the PBSCRT was created beneath the PBSOBN which generates the
schematic items.

Flexible Explorer Query Node allows for the selection of the appropriate node in which the location checks
23 er:

will be made. So in the case shown, the PBS query node was selected as the top level PBS element, the
1/

PBS-Template (Schematics Classes) created earlier. This means that items created will be checked to
te: m

ensure their correct storage within the PBS-TEMPLATE node only. Hence this selection is made from the
pick list as shown.
Da sto
Cu

Copyright © 2013. 176 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

12.3 Configure Project Explorer (Unassigned items)

Having configured the standard Schematic project explorer as detailed previously, it is possible to configure
additional behaviours into the standard explorer.

Within the AVEVA Diagrams application, unassigned items are 2D/schematic objects which do not exist on
the drawing canvas, but are database elements and exist on the explorer. They are categorised with a ‘U’
symbol on their object icons.

There could be several design/engineering reasons for having unassigned schematic objects located within
the explorer, but it could be configured to be presented in an organised and tidy manner, so as the
appropriate items are located within dedicated node for unassigned items.

The configuration for handling unassigned items could be achieved in

several ways, but this guide will focus on one method.

11 A
For the following exercises, additional pml function files are

2
- 2 NIC
/2
required. These will be part of your installation, or will be
supplied by trainer.
22 TEC
8/
/1 SIN
23 er:
1/
te: m

12.3.1 Creating an Unassigned node – A Worked Example

Da sto

Select the PBS object node (SchematicGroups), display the context menu and click ‘Create’ > ‘PBSTXN:
Flexible Explorer Text Node’ to create a PBS Text Node.
Cu

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

For the name of the node, enter: UnassignedItemsNode

‘Flexible Explorer Formula Type’ entry is set to ‘PMLfunction’.

For the Flexible Explorer Formula entry, enter: !!getUnassignedItemsNode()

Copyright © 2013. 177 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The referenced pml function must exist in the pmllib.

This will create an ‘Unassigned items’ folder beneath all derived schematic groups.

Select the created Flexible Explorer Text Node (UnassignedItemsNode), display the context menu and
click ‘Create’ > ‘PBSTXN: Flexible Explorer Text Node’ to create a PBS Text Node.

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

11 A
2
- 2 NIC
/2
For the name of the node, enter: UnassignedSchematicClassesForGroup

‘Flexible Explorer Formula Type’ entry is set to ‘PMLfunction’.

22 TEC
For the Flexible Explorer Formula entry, enter:
8/
!!getnonEmptySchematicClasses(‘#PARAM(/SchematicGroups)’)
/1 SIN

This will derive and create schematic class locations for the element types of identified unassigned objects,
beneath all derived schematic groups.
23 er:

Select the created PBS text node (UnassignedSchematicClassesForGroup), display the context menu
1/

and click ‘Create’ > ‘PBSOBN: Flexible Explorer Object Node’ to create a PBS Object Node.
te: m

Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.
Da sto
Cu

For the names of the node, enter: UnassignedSchematicItems

The Flexible Explorer Text entry: <ISNAMED ? NAMN : REPTXT + ' ' + STRING(TYSEQUENCE)>

‘Flexible Explorer Formula Type’ entry is set to ‘PML expression’.

For the Flexible Explorer formula entry, use the Flexible Explorer formula editor: enter the following:
collect members of #PARAM(/SchematicGroups) where type eq
'#PARAM(/UnassignedSchematicClassesForGroup)' and unset(SCBREF)

Copyright © 2013. 178 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

‘Flexible Explorer Context Menu’: AVEVA.Diagrams.FlexExplorer.Menu.Context

Unassigned items do not exist on a drawing canvas, so do not carry a set ‘SCBREF’ attribute. This attribute
references a ‘SCIND’ object. So this formula will look to evaluate objects within the arguments and return the
items which have unset SCBREF attributes.

It should be noted that if this configuration is run in this form,

there might be some errors experienced within the project
explorer. This is because Schematic Pipelines, Schematic
Diagrams, Templates and Stencils do not carry an SCBREF
attribute, so this will be ‘unset’ for these objects.

This means that the system will encounter a conflict when

trying to deploy the rules. This is handled by creating
another schematic class explorer structure which references
a pml function in order to evaluate these elements
specifically, and also some negating expressions entered
within the original schematic class structure.

11 A
2
Copy the node PBSTXN SchematicClassedForGroup (this

- 2 NIC
/2
will copy all of its children elements). Paste this beneath the
PBSOBN SchematicGroups element as shown.
22 TEC
8/
/1 SIN

After pasting this node, rename all the elements by including the text (NoSCIND) to all their names, as
shown:
23 er:
1/
te: m
Da sto
Cu

The Flexible Explorer Formula for the ‘Schematics ClassesForGroupNoSCIND’ element, must be changed
to reference a specific pml function (which must already exist in the pmllib)

Flexible Explorer Formula: !!getNonEmptySchematicClassesNoSCIND( '#PARAM(/SchematicGroups)' )

Parameters and referenced entries will dynamically align themselves. For example, the Primary members2
node will have it’s recurrent node set to the correct one:

Copyright © 2013. 179 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Finally, within the PBSOBN SchematicItems node, include this extra text to its PBS Formula expression:
and not(unset(SCBREF))

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 180 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Run a ‘Savework’ in the LEXICON module and ‘Getwork’ in the Diagrams application to display
the all node objects along with their member items in the project explorer

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 181 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 182 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX A

13 Appendix A - Optimising Project Performance and Storage Space

13.1 Recommendations to Improve Performance of Save Work

▪ Avoid having many pages in the same diagram. It is better to create separate diagram files. At the
moment, all the pages in the diagram are being processed and saved as SVG files during
SaveWork, this is the case even if the user has just modified one of the pages.

▪ Avoid using heavy bitmaps or too detailed vector graphics in title block and backgrounds. You can
experiment by removing some of these and measure the SaveWork performance to determine if you
have an issue with this.

▪ There is a setting to control whether SVG files should always be created, or only when the drawing
contains anything released to 3D. If this setting is used, it is possible to get better performance when
initially working with the drawing. After it has been released to 3D, there will then be a performance

11 A
2
degradation as the SVG files starts getting created. Please note that once SVG files starts

- 2 NIC
/2
generating, you cannot turn it off again, so this setting has to be applied from the start of a new
diagram drawing.
22 TEC
▪ During Save Work, there is intense file storage activity with Visio and SVG files. For this reason it is
8/
recommended that the IT infrastructure such as network and file server disk performance where the
files reside (xxxDIA) is optimized.
/1 SIN
23 er:

13.2 Refresh Performance

1/

The performance of the Refresh command is dependent on how many shapes are being refreshed and how
te: m

many attributes belong to each of these shapes in the Custom Properties.

Da sto

It is easy to get large numbers here, i.e., if there are 100 shapes in a drawing where each has 50 attributes
belonging to it, this will produce 5000 attribute values to be read from Dabacon and updated in the shapes'
Cu

Custom Properties.

▪ Only use the Refresh command when necessary, i.e. when it is suspected something has been
updated in the DB and the user needs to see it reflected in the drawing.

▪ If some shapes are selected in a drawing when doing the refresh, only those shapes will be
affected. It is often unnecessary to refresh the whole drawing if only one part is being worked on.

▪ Reduce the number of attributes per shape to be shown in Custom Properties down to a set of
attributes that are really being used by the AVEVA Diagrams user. It is possible to control which
attributes should appear in the Custom Properties through the Attribute Presentation function. If for
instance half of the attributes shown in the Custom Properties are never used, then removing them
will halve the time used for refreshing the whole drawing. Check the usage of the UDA’s regularly
and remove unused ones from the project.

Copyright © 2013. 183 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

13.3 Project Storage with Respect to Visio and SVG Files

▪ As mentioned above, it is possible to disable the SVG creation until it is really needed (when the
diagram has been released to 3D).

▪ There is a setting to control whether to use binary Visio files or XML format Visio files. XML format
requires much more storage space, thus make sure to use the binary format.

▪ There is a 'Keep session files' setting that will determine whether the old versions of the Visio and
SVG files will be kept during each Save Work or not. With this setting the user can switch between
'more data management capability & more storage space required' or 'less data management
capability & less storage space required' as is described below.

▪ If this setting set to True there is a possibility to backtrack the Dabacon session and access
the specific Visio/SVG file versions related to that particular session. The drawback is that it
may take a significant amount of storage space to save the related files for all sessions.

▪ If this setting set to False only latest versions of the Visio/SVG files will be kept. This means
that backtracking a Dabacon session will not give access to the corresponding Visio/SVG
files. However, storage space requirements will be less demanding.

11 A
2
▪ Alternatively, if 'Keep session files' setting is set to True, and sessions are to be merged, then select

- 2 NIC
/2
Admin > Project Maintenance > Clean Old Session Files… to remove the corresponding
Visio/SVG files. This can be an approach where there is a possibility to backtrack changes during a
period. Merge and clean the sessions and continue from there.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 184 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX B

14 Appendix B - Annotation and PML1 Expressions

14.1 Attribute Presentation Notation

Through the Attribute Presentation format notation, attribute information can be collected from the DB
element that corresponds to the shape as well as from hierarchically superior elements and referenced
elements. It can also be combined with literals in an arbitrary way.

The native notation uses square brackets [ ] for attribute references that should be evaluated before
presentation. All characters outside the brackets are considered as literals and will be presented as-is.
Referenced attributes can be referred by a dot notation (reference.attribute). References can be in several
steps, in that case the reference chain will be followed to resolve the expression and find the attribute value.
An arbitrary number of literals and attribute references can be combined to form advanced attribute
presentation and annotation strings.

11 A
2
Using [scplin.bore] native syntax will fetch the default bore attribute from the pipeline element that owns the

- 2 NIC
/2
current hierarchically subordinate element, for a valve [owner.owner.owner.bore] will provide the same
result as previous. The owner of a valve is the SCSEG element, the owner.owner is the SCBRAN element,
and the owner.owner.owner is the SCPLIN element. [name]-[spref.name] will display the name of the
22 TEC
current element, a literal (in this case a "-"), and the name of the related catalogue element.
8/
/1 SIN

14.2 PML1 Expressions

PML1 expressions should be enabled by setting Parse for PML1 expressions in annotations to True from
23 er:

Annotations settings in Diagrams Options, and always be enclosed with curly brackets { }. The usage of
native square bracketed attribute references within PML1 expressions is also supported. In such case the
1/

square bracketed attribute references are resolved first, and then the PML1 expression is parsed.
te: m
Da sto

 The dot notation can be replaced by the ‘of’ word in PML1, i.e. instead of {AFTER([owner.name],’/’)
it could be used {AFTER([name of owner],’/’)
Cu

The attribute presentation notation can be applied to the following:

▪ Attribute Presentation Setup (In Diagrams Options and in Import Shape Wizard)
▪ Shape Text attribute
▪ Label annotation fields

Using the PML1 expression {STR(abor)} provides the arrival bore value, {SUBST(name,2)} uses the
substring function to provide the part of the name of the element starting at the second character which will
give the name from second character.

Copyright © 2013. 185 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

It is possible to achieve the same result using either the native notation or the PML1 expressions where
applicable; i.e. RED[\n]{STR(para1)} x {STR(para2)} will display the equivalent to
RED[\n][spre.catr.para(1)] x [spre.catr.para(2)]

 The notation can also be a result of a PML1 expression. For more information about PML1 functions
please see Software Customisation Reference Manual, PML1 Expressions
 To get a particular element from an attribute of array type, use a (number) notation. i.e.,
owner.diaref(1). The enumeration of elements is 1-based. The (0) string will give all elements of the
array. To reference an array element in PML1 expressions, use the attribute name followed directly
by a number, i.e. ppbo2

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 186 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX C

15 Appendix C – Diagrams Customisation

Diagrams application has public interface to help all developers that would like to write custom add-ins. The
Aveva.Diagrams.Interface.dll contains tools that might be helpful during this process. Customisation using
other dll files is not recommended as these files are subject to change. The detailed documentation for
AVEVA Diagrams Interface library can be found in AVEVA Diagrams API documentation.

15.1 Shape Context Menu (Shape Sheet Action Section)

It is possible to add custom context menu options and call an Execute() method from any registered
command class or call a PML function. To achieve this, the master shape that is representing item has to be
edited in Visio. In the shape’s shape sheet, the Action section has to be updated about custom row(s) as
shown. As a result, all shapes that are based on this master will have additional context menu.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 187 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

This mechanism is based on QUEUEMARKEREVENT Visio function. It requires parameters that will be
parsed when QueueMarkerEvent will be handled by AVEVA Diagrams application. According to the given
parameters, PML function or Command.Execute() will be called.

15.1.1 PML Function

If the administrator wants to call a simple PML function that as shown below,

define function !!DiagramsPrint()

$P Hello world!
endfunction

The only action needed is to write a formula in the Action cell. In this case, it will look like below:

=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=PMLFUNC

/name=DiagramsPrint")

 In some cases it might be useful to pass reference number of the database element that the shape
is representing

11 A
2
- 2 NIC
/2
If the administrator wants to call a PML function that as shown below,

define function !!DiagramsPrintParam(!DbRefNum is string)

22 TEC
!a = object DBREF(!DbRefNum) 8/
handle any
endhandle
if (UNDEFINED(!a) or UNSET(!a) or BADREF(!a)) then
/1 SIN

$P element not found

return
endif
23 er:

!n = !a.name
1/

$P The clicked item is $!n

te: m

endfunction
Da sto

In this case a parameter needs to be passed to the PML function. This can be achieved by adding
/param=refnum to the formula. The updated formula should look like this:
Cu

=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=PMLFUNC

/name=DiagramsPrintParam /param=refnum")

15.1.2 Command Execute

It is also possible to call Execute() methods from classes based on a command.

If the administrator has a class defined like below,

class DiagramsAPICommand : Command

{
internal DiagramsAPICommand()
{
this.Key = "TEST_DIAGRAM_API_CMD";
}

public void Execute(Shape shape)

{
MessageBox.Show(string.Format("The shape: {0} was clicked!", shape.Name));

Copyright © 2013. 188 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

public override void Execute()

{
MessageBox.Show("Execute!");
}
}

There are two Execute() methods:

▪ Execute()
▪ Execute(Shape shape)

It is possible to set up a formula in the Action cell to call both versions. If Execute without parameter is to be
called then the formula should look like below:

=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=COMMAND

/Key=TEST_DIAGRAM_API_CMD")

If Execute with parameter is to be called, param=shape needs to be added to the formula. Updated formula
should look like below:

11 A
2
=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=COMMAND

- 2 NIC
/2
/Key=TEST_DIAGRAM_API_CMD /param=shape")

 The Command has to be registered in

22 TEC
Aveva.ApplicationFramework.Presentation.CommandManager
8/
/1 SIN

The parameters used in QUEUEMARKEREVENT are shown below:

Parameter Allowed Values Comments

23 er:

Name
1/

module Diagrams Application name

te: m

type shapecontext Says that it is shape context menu.

Da sto

code PMLFUNC The PML function will be called

COMMAND The Command Execute will be called
Cu

name [PML function name Used with PMLFUNC only

key [Command Key] Used with COMMAND only
param refnum Database reference number as string of item
that is Represented by Visio Shape. This
parameter can be used only when PMLFUNC
shape Visio Shape will be passed as parameter.

Copyright © 2013. 189 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 190 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX D

16 Appendix D – Schematic Model Viewer Icon Configuration

16.1 Icons

The icons used by Schematic Model Viewer to represent the equipment, generic branch points and inline
fittings are determined by a set of user configurable rules. These rules are stored in an XML file, called
SchematicSymbols.xml which resides in the main installation directory.

11 A
2
Below is an example of the .xml file. By changing the file, it is possible to apply different rules for the

- 2 NIC
/2
selection of icons. The administrator can view and modify this file in a text or XML editor.
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 191 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The icon files are by default stored in the %PMLLIB%\icons\schematicmodelviewer\ directory. New icons
can be added to this location and it is also possible to modify or replace the existing ones if so desired.

11 A
2
- 2 NIC
/2
22 TEC
8/
It is possible to determine which symbol should be used when
creating a model view and also to set the displayed text beneath
/1 SIN

the item using the Options form.

Attributes can be used by entering the attribute name in brackets,

23 er:

e.g. [Type]. To use a shape from a stencil instead of the icons the
Use Icon setting needs to be set to False and the settings Set
1/

Stencil Name and Stencil Shape should be valid names.

te: m

However, if the system is unable find a shape or a stencil the icon

Da sto

will be automatically used instead. If an icon, a shape or a stencil

is not found the default rule will be used when a model view is
generated.
Cu

 Stencils and icons have to be located in the

%PMLLIB%\icons\schematicmodelviewer\
directory. The location can be changed using
the Path setting in Default section
 An already drawn item cannot be replaced
using the Options form

Copyright © 2013. 192 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

To save the changes permanently to the Options form the administrator needs to click Save to defaults
button. This will save the changes to the SchematicModelMapModuleUserSettings.xml file in
%PDMSDFLTS% folder.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 193 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 194 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX E

17 Appendix E – Project Upgrade

17.1 Upgrade Drawing

The Drawing command in the Upgrade section of Admin tab will upgrade all Tribon M3 or any previous
AVEVA Diagrams shapes on the current drawing to the current version of AVEVA Diagrams shapes. Non-
Tribon M3 shapes will be ignored. Upgraded shapes will not automatically be defined in the database. This
will have to be done manually afterwards using the Define function.

11 A
2
- 2 NIC
/2
 The user can upgrade the drawing automatically using the
Diagrams Options > General Options > System Configuration >
22 TEC
Component Verification > Upgrade drawing on Open setting
8/
/1 SIN

17.2 Upgrade Database

The Database command in the Upgrade section of Admin tab will copy values from CREF to SCIREF
23 er:

attribute for earlier version(s) of offline instruments. The administrator will need to save work afterwards.
1/
te: m
Da sto
Cu

17.3 Upgrade Diagrams Options

Diagrams Options are configured by an xml file that contains both the definitions and the actual values of all
options. For various reasons, the administrator may have more than one version of this file. If a definition of
the option exists in both the old options file and the current one a copy of the old value is inserted to the new
options file. If a value for a (new) definition of option is not found in the old options file the default value of
that option is assumed.

Copyright © 2013. 195 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

If a value of option is found in the old options file that is not available in the current options definition then the
option is ignored and a warning is given in the Message Log. If any problem is detected during upgrade, the
user will be prompted.

During the initialisation of the application AVEVA Diagrams invokes a merge of options from the admin
storage area of the project and the user store if applicable. The merge will be made in a way that all options
that are marked in the admin store as read-only will be disabled for change, and the values for these options
will overwrite whatever the values in the user store area.

Read-only and read-write attributes will be determined in this xml file by the keywords (“ro”) and (“rw”)
respectively placed in the xml file for each option required.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN


23 er:

The user storage area is the location

corresponding to
1/

%PDMSDFLTS%\Diagrams\, while the

te: m

admin storage area is

Da sto

%<PROJ_CODE>DFLTS%\Diagrams\


Cu

The Attribute Presentation settings are

stored in
DiagramsAttributePresentations.xml file
in the defaults folder which is referred as
%<PROJ_CODE>DFLTS%/Diagrams or
%PDMSDFLTS%/Diagrams

Provided that the admin storage area is only controlled by the administrator access to the options (read-only
or read-write) is decided by an administrator. The user can only affect the option value if allowed to do so.
The rest of the option data i.e. position in the options file, name, description, type, default value is not
editable.

Copyright © 2013. 196 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX F

18 Appendix F – Batch Update

This functionality allows administrators to update many drawings in one go without opening them where the
user may request to update the drawings according the master shape changes, defaults, catalogue defaults
and/or Diagrams Options. The option is available from the Batch Job command in Tools tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Select the diagram to be updated and using the Add button, ensure the diagram is displayed in the
23 er:

Selection list. Then click Update Diagrams button.

1/
te: m

Make sure the selected diagram is closed before proceeding, otherwise a warning will be displayed and it
won’t be possible to update an open diagram.
Da sto
Cu

The Update Diagram Options form will be displayed. The form contains
options with which the user can select which actions to be carried out,
e.g. type of data to be updated, category of updates to be undertaken.

Copyright © 2013. 197 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

Update symbols according to master shapes This option will replace shape symbols if the shape
master that is located in document master, has any
difference than master selected by user.

Update symbols according to catalogue information This option replaces symbol shape according to
data in specification. Symbol from SPREF will
replace existing one. SPREF attribute must point to
element that has valid SYMGROU and SYMNAME
attribute values.

Update annotation formats This option allows the user to update auto labels
and presentation text according to Diagrams
Options or master settings. If master was selected
then labels and text rule is taken from master
instance. In case when master is not selected then
system will check if shape that should be updated
took its setting from master or default. If settings
were taken from master and master is not selected
then some shape settings will not be updated. If
settings were taken from Diagrams Options then
system will update them.

11 A
2
- 2 NIC
/2
Update attribute presentation settings This option allows the user to update Shape Data
order, presentation texts, visibility etc. according to
Diagrams Options or master settings. This option’s
22 TEC
8/ behaviour can be controlled globally for each type
separately by checking Allow individual shapes
to override default settings in Diagrams Options
/1 SIN

for the data from selected master will be used.

Otherwise the shapes will be updated according to
Diagrams Options. When master was not selected,
system checks if the shapes that should be
23 er:

updated took their settings from the master or

1/

Diagrams Options. If the settings were taken from

te: m

the master and the master is not selected then the

shapes will not be updated. If settings were taken
Da sto

from Diagrams Options then system will update the

shapes. During update all Shape Data that exist in
shape instance but does not exist in current
Cu

settings will be removed.

 If an attribute is removed using Batch Update, the system will not remove it but will give a warning if
other attributes are using this data, i.e. where Instrument type is used as shown, it will not be possible
to update the shape not to show this attribute in Shape Data.

Ignore stencil settings This option allows the user to update the shapes
according to Diagrams Options and not the master
settings.
Refresh shapes This option calls a refresh on each shape.

Copyright © 2013. 198 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Ignore stencil settings option will not work for autolabels’ layer. The layer for autolabel is taken from
master that is used to create autolabel
 Shapes that do not have settings in Diagrams Options will require master to be selected, i.e. Title
blocks and Multi labels
 Batch Update cannot be used to set any default values to shape data

Once the desired settings are checked on the Update Diagrams Options, it is possible to select the masters
for the update to be applied to. Click on the Browse button which is next to Select master shapes to use for
update (0 selected). This message will be updated with the number of the master shapes after the selection
is accepted. The Select Masters to update form will be displayed where the user can add a stencil and pick
some or all masters from it to be updated in the drawing(s) previously selected.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:

Click the Add Stencil button and selecting the

1/

required stencil click Open button.

te: m
Da sto
Cu

Select the shape from the stencil and using

the right click context menu or by dragging
and dropping add the shape to the Masters
to update area. If desired Add all
checkbox can be used.

Masters also can be removed from the

Masters to update list using a right click
context menu.

Click the OK button and the Update

Diagrams Options form should now show
the number of the masters to be updated.

 It is possible to use the Load log

button on the Update Diagrams Options
form to open a saved log file using Save
Report button on Update Diagrams Status
form

Copyright © 2013. 199 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

The Update Diagrams Status is now displayed and the user can click on the links shown in the related
columns to view the informational messages, warnings or errors.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Click OK button on the Update Diagrams Status form, then dismiss the Batch Job form and open the
23 er:

updated diagram.
1/
te: m
Da sto
Cu

 If the user deleted an auto label from a shape, it may not be added after the update as system
remembers the deletion. To add the auto label, use Ignore stencil settings checkbox or select the
appropriate master

Copyright © 2013. 200 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

 Clicking Cancel on the Update Diagrams Status form will revert all changes done by Batch Update
process

The updated changes should now be reflected by the shapes on the diagram from the selected masters. If
the diagram is not refreshed automatically upon opening due to Diagrams Options, manual refresh may be

11 A
2
required. The user needs execute a Savework command for the changes to be permanent.

- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 201 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP3)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 202 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX G

19 Appendix G – Copy Data Between Database

It is possible to use the RECONFIGURE command to copy schematic data between databases and also to
copy databases between projects. Below is an example of procedure for copying data from
SAMPLE/CABLDIA database in SAM or SCHEMATIC/DIAGRAMS database in MAR project to
SCHEMATIC/DIAGRAMS database located in a newly created TPS project.

Log in to Admin module using SAM or MAR project and type following commands in the command line.

FROM DB SAMPLE/CABLDIA
TO FILES /TMPF1 /TMPF2
RCFCOPY ALL
RECONFIGURE

11 A
2
Switch to Admin module using TPS project. Make sure that the target TEST database exists in TPS project

- 2 NIC
/2
(if not create it). It is not necessary that the source and target databases have the same number. Type the
following instructions in command line:
22 TEC
FROM FILES /TMPF1 /TMPF2 8/
TO DB SCHEMATIC/DIAGRAMS
RECONFIGURE
/1 SIN

All data have been copied now together with associated files (for diagrams, templates and stencils) and no
other action is required before they can be used
23 er:
1/

 For more information on the RECONFIGURE command please see Administrator Command Reference
te: m

Manual
Da sto
Cu

Copyright © 2013. 203 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

19.1 Include or Copy Foreign Database

The administrator may wish to re-use data from another project, i.e. templates and stencils. To be able to
make this data available to the current project the database can be included or copied from a project.

When a database is included, the data will be shared between the two projects and any change made to this
database will be available to the current project users. When a database is copied, a copy of this database
will be created in the current project using the latest saved data from the target database.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The administrator will need to create any teams required by this process.

Copyright © 2013. 204 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

19.2 Document Files and Sessions

All Microsoft Visio documents such as diagrams, stencils and templates are handled through index elements
in the database. When a diagram is created, an SCDIAG element is created in the database, and this
contains a pseudo attribute called VISF that provides the file name of the actual file in the file system. File
names are composed by <element ID><session no>. This mechanism and naming convention supports the
Dabacon session concept and provides a mechanism for Global to manage the files in a multi-location
project. These file names are not visible to the user. The user will handle all diagrams through the index
elements in the database and will only see the names of the index elements.

This mechanism creates new files each time a SaveWork is executed. This means that when users have
been working for a certain amount of time, a large quantity of files may exist in the
%<PROJECTCODE>DIA% directory, in the same way that a Dabacon database grows as sessions are
being added. There is currently no mechanism to automatically delete obsolete versions of the files when a
database session merge is executed.

At the same time as a diagram file is saved, an SVG format file is also created. This is for the purpose of
viewing the diagrams in other applications such as the AVEVA Schematic 3D Integrator without having the
need for a Microsoft Visio installation. In the same way as querying the VISF attribute on the SCDIAG

11 A
2
element for obtaining the Microsoft Visio diagram file name, the SVG file name can be found by querying the

- 2 NIC
/2
NVIEWF attribute. Changing the Create SVG on Save Work setting to Always in Diagrams Options, will
result in creation a new SVG file every time a save work processed. When it is set to False a new SVG file
would only be created if any element is released to 3D.
22 TEC
8/
Changing the KEEP_SESSION_FILES default setting to False in Diagram Options, will result in only the
latest version of the Visio diagram file to be kept. If this setting is used it will not be possible to restore a
/1 SIN

previous session including the corresponding diagram file version.

Microsoft Visio templates and stencils are handled in the same way as the diagrams, using SCTEMP and
SCSTEN index elements in the database. With the exception that no SVG format files are created when
23 er:

templates and stencils are saved by the application.

1/
te: m

19.3 Cleaning Old Session Files

Da sto

The AVEVA Diagrams application provides a tool for removing old document session files from a project. It
Cu

can be used when the Keep session files setting (KEEP_SESSION_FILES) in Diagrams Options is set to
False

Select Project Maintenance > Clean Old Session Files from the Admin tab, the dialogue window is
opened and provides the possibility to select the document types to clean.

Copyright © 2013. 205 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

Select the document type(s) to clean. After clicking OK button the following
confirmation dialogue is displayed.

After clicking the Yes button all old session files connected with DB elements (of selected types) existing in
the current MDB are removed. Files that are not connected with any SCDIAG, SCTEMP or SCSTEN from
the current MDB are not considered to avoid accidental deleting of important files.

11 A
2
- 2 NIC
/2
 Cleaning old session files allows saving disc space in the case that there is no need to keep previous
documents versions, but after performing the operation it will not be possible to restore earlier sessions
including the corresponding diagram file versions
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 206 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 APPENDIX H

20 Appendix H - Diagrams Options

In the Diagrams Options dialogue, there are multiple settings that control the operation of the AVEVA
Diagrams application.

This Appendix provides a general overview of the Diagrams Options, since these options are used and
explained in various paragraphs of the AVEVA Diagrams 14.1.SP1 training guides and configured in the
training project that is delivered with the training guides.

 For more information about the Diagrams Options please refer to the Help File of AVEVA Diagrams
14.1.SP1, in particular at paragraph ‘Application Settings > Diagrams Options’.

From the Project tab select Options > Diagrams Options, the Diagrams Options form appears.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 207 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

There are two general tabs in the Diagrams Options which are the Defaults and Attribute Presentation.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The Defaults tab has several settings that will control the operation of the application. Below on the form
there is an information area which provides an explanation for each setting as they are selected.

Copyright © 2013. 208 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

The Attribute Presentation tab is used to show and set rules in the Shape Data Window/Item List. i.e.,
setting up the presentation order of attributes and attribute presentation labels.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/

The user can set up the attribute presentation to be used in the Shape Data window as well as in the Item
te: m

List. On the left hand side of the form there is a tree-view containing the different element types relevant to
the AVEVA Diagrams application. If any UDETs have been defined, these will also be included in the list.
Da sto

For each element type selected in the tree view, the attribute presentation can be individually controlled by
the settings in the right hand list view.
Cu

The columns in the table are as follows:

Attribute Name of the attribute. This cannot be modified.

Label Presentation label for the attribute. This controls the name to be presented to the
user in the Shape Data window only. This setting does not apply to the Item
List as it shows mixed items in the same list.

Prompt If a Prompt string is entered, the application will prompt the user for a value as the
shape is dropped on the drawing. The Prompt string will be presented to the user at
that time, i.e. 'Please enter Name'.

Visible If this checkbox is checked, then the attribute will be included in the list of attributes
shown in the Shape Data window.

Visible in Item List If this checkbox is checked, then the attribute will be included in the list of attributes
shown in the Item List.

Copyright © 2013. 209 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

Read Only If this checkbox is checked, it will not be possible to update the attribute value from
the Shape Data window or from the Item List.

Copy with Shape If this checkbox is checked, the attribute value will be copied when shapes are
copied in or between drawings. Please note that the shape must be defined for the
Copy with Shape setting to apply.

By clicking the Move Up and Move Down buttons, the presentation order of the currently selected attribute
can be changed.

 In the Import Shape Wizard there is a possibility to override the default attribute presentation settings
for individual shapes. In case this possibility should be enabled, the Allow individual shape settings to
override default settings should be checked. This setting can be applied individually for each element
type in the tree before clicking the checkbox. If this is not checked, any attribute presentation settings
done in the Import Shape Wizard for individual shapes will be ignored.

Additional attributes can be added by pressing the Referenced attributes button, the Add/Remove
referenced attributes form is displayed for the element that was selected in the Attribute Presentation tab.

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

The user can now select referenced attributes to add by navigating in the tree and then clicking the Add
button, once all the required referenced attributes are added then click the OK button.

If the Visible in Item List checkbox is checked it can then be seeing the Shape Data Window and Item List.

 Referenced attributes can also be added by clicking in the next free line in the Selected attribute list
and then by keying in the name of the referenced attribute using the dot notation i.e. [diaref(1).name]
 Pseudo attributes are not shown in the list of attributes in the Attribute Presentation and Referenced
attributes dialogue. To show these they will have to be manually keyed-in
 Referenced attributes will not be shown in Visio Reports unless they are added to the Shape Data

Copyright © 2013. 210 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

On the other hand the Defaults tab includes for example:

1. System Configuration:

The System Configuration section includes several options, for instance for Auto renaming,
Colouring options, Intelligent copy options and Unassigned items.

 The user can modify

the settings here, for
example to determine
how the Highlight
function will behave
when the Refresh
command is used.

11 A
2
This includes which

- 2 NIC
/2
attributes are to be
ignored, what type of
message should be
22 TEC
given and whether the 8/
highlight should occur
after a refresh is
/1 SIN

initiated automatically
or not.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 211 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

2. Settings Stored in Drawing:

The Settings stored in the drawing section includes session variables which are to be stored in the drawing,
they are, current line, default system, default groups and default attributes in drawing.

11 A
2
- 2 NIC
/2
22 TEC
8/
3. Annotation settings:
/1 SIN

The Annotation settings section includes Automatic Annotation option, Behaviour, Default shapes options,
Labels and Text options, Number of autolabels options, Placement of autolabels (in z-order) options and
Property break option.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 212 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

For more information about the Diagrams Options please refer to the Help File of AVEVA
Diagrams 14.1.SP1, in particular at paragraph Application Settings > Diagrams Options.

20.1 Snap and Glue Settings

Snap and Glue settings varies for each Diagram. In Diagrams 14.1 SP3 a common Snap and Glue settings
can be maintained and these settings are controlled by Administrator. Administrator can enable or disable
this option. If the common Snap and Glue settings are to be maintained across the project the option is set
to True or else it is set to False.

20.1.1 Common Snap and Glue Settings – A Worked Example

Login to Diagrams module with ADMIN user.

PROJECT: Train-DIAG
User: SYSTEM
Password: XXXXXX
MDB: A-PIPING

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 213 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

Go to Default Snap and Glue Settings of System configuration in Diagrams Options window. Select True
to maintain a common Snap & Glue Settings and click OK

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto

Open any SCDIAG available in the project and select the Snap settings and Glue settings available in the
Home Tab of the Main menu.
Cu

Copyright © 2013. 214 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

Open Diagram A0-01-2012-0001

Select the Snap settings as
• Snap to Grid
• Snap to Alignment Box
• Snap to Shape Intersections

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN

Now similarly select the Glue settings for the Diagram

Select the Glue Settings as
• Glue to Shape Geometry
23 er:

• Glue to Connection Points

1/
te: m
Da sto
Cu

 Save the work. Now these Snap and Glue settings will be common for all the Diagrams in the project

Copyright © 2013. 215 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

Login to Diagrams as General User to check the Common Snap and Glue settings are applied.

PROJECT: Train-DIAG
User: A.PIPER
Password: A
MDB: A-PIPING

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Go to Default Snap and Glue Settings of System configuration in Diagrams Options. (This setting is now
been disabled for General User)
As the Default Snap and Glue Settings is set to True through Admin Login. The option visible is True

Copyright © 2013. 216 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

The Snap & Glue settings which are set by Logging in as Admin, can only be used by the General user for
all the Diagrams in the project . Open SCDIAG A0-01-2012-0001 and A0-01-2012-0002 .The Snap and
Glue buttons in the Home menu tab are disabled.

11 A
2
- 2 NIC
/2
22 TEC
8/
 If Default Snap and Glue Settings in the Diagrams options is set to False then the Diagrams can
/1 SIN

have individual settings. The aim of this feature is to use common settings for all Diagrams in the
Project.
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 217 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Diagrams (14.1.SP1)
Diagrams Administration (TM-3534)

11 A
2
- 2 NIC
/2
22 TEC
8/
/1 SIN
23 er:
1/
te: m
Da sto
Cu

Copyright © 2013. 218 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.