AVEVA Instrumentation

(12.1)

TRAINING GUIDE
Administration

TM-6101

www.aveva.com
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 2 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Revision Log

ril)
Ap
Date Revision Description of Revision Author Reviewed Approved
Approved for AVEVA Instrumentation
24/02/2014 3.0 TG/SR TG/KH GC
Training 12.1 SP2

8th
Approved for AVEVA Instrumentation
10/10/2014 4.0 TG/GO TG/JB GC
Training 12.1.SP3
Updated for AVEVA Instrumentation
20/03/2015 5.0 GO TG GC

to
Training 12.1.SP3.Fix4
Approved for AVEVA Instrumentation
30/03/2016 6.0 FF/TG GO GC

il
Training 12.1.SP4

A pr
4-2 2nd
Updates

8-0 d (
All headings containing updated or new material will be highlighted.

4
Suggestion / Problems
- 0 ite
If you have a suggestion about this manual or the system to which it refers please report it to the AVEVA
-24 Lim
Group Solutions Centre at [email protected]

This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
-04 ers

licence conditions.

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

02 ine
te: ng

Disclaimer
Da ing E

1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.

1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar
ult

losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of
data or information; any special, indirect, consequential or pure economic loss, costs, damages,
charges or expenses which may be suffered by the user, including any loss suffered by the user
ns

resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of
whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence)
Co

or otherwise.
ata

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.
r: T

1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
me

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.
sto
Cu

Copyright © 2014. 3 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Copyright Notice

ril)
All intellectual property rights, including but not limited to, copyright in this Training Guide and the associated

Ap
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

8th
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

to
included in this Training Guide and this Copyright notice is prominently displayed at the beginning of every
copy that is made.

il
pr
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

A
may be made and or criminal prosecution may result.

4-2 2nd
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.

8-0 d (
4
@AVEVA Solutions Limited 2016

- 0 ite
-24 Lim
Trademark Notice

AVEVA™, AVEVA Instrumentation™, Tribon and all AVEVA product and service names are trademarks of
AVEVA Group plc or its subsidiaries.
-04 ers

Use of these trademarks, product and service names belonging to AVEVA Group plc or its subsidiaries is
02 ine

strictly forbidden, without the prior written permission of AVEVA Group plc or AVEVA Solutions Limited. Any
unauthorised use may result in a legal claim being made against you.
te: ng

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

All other trademarks belong to their respective owners and cannot be used without the permission of the
owner.
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 4 www.aveva.com

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

ril)
1 Introduction .............................................................................................................................................. 7

Ap
1.1 Aim..................................................................................................................................................... 7
1.2 Objectives ......................................................................................................................................... 7

8th
1.3 Prerequisites .................................................................................................................................... 7
1.4 Course Structure .............................................................................................................................. 8
1.5 Using this guide ............................................................................................................................... 8
2 AVEVA Instrumentation Training Workflow .......................................................................................... 9

to
2.1 AVEVA Instrumentation Administration Training Guide Workflow .......................................... 10
2.2 AVEVA Instrumentation Engineer Training Guide Workflow .................................................... 11

il
2.3 AVEVA Instrumentation Wiring Manager Training Guide Workflow ........................................ 11

pr
2.4 AVEVA Instrumentation Designer Training Guide Workflow .................................................... 11
2.5 AVEVA Instrumentation Process Engineer Training Guide Workflow ..................................... 11

A
3 AVEVA Instrumentation Security Manager ......................................................................................... 13
3.1 Create a New Project ..................................................................................................................... 13

4-2 2nd
3.2 Enable Security Settings ............................................................................................................... 19
3.3 Groups and Users .......................................................................................................................... 20
3.3.1 Add a New Group ..................................................................................................................... 21

8-0 d (
3.3.2 Edit Groups .............................................................................................................................. 21

4
3.4 Authentication Type....................................................................................................................... 22
3.4.1
3.4.2 - 0 ite
Windows Authentication Type .................................................................................................. 23
AVEVA Project Authentication Type ........................................................................................ 25
-24 Lim
3.5 Objects ............................................................................................................................................ 27
3.5.1 Applying Group Access Types to Objects ................................................................................ 28
3.6 Area Access Control ...................................................................................................................... 29
3.7 Options ............................................................................................................................................ 31
-04 ers

3.7.1 Create a New Project ............................................................................................................... 31

3.7.2 Package Project ....................................................................................................................... 31
3.7.3 Create SQL Server Project from Backup ................................................................................. 34
02 ine

3.7.4 Edit Projects ............................................................................................................................. 36

3.7.5 Unlock Excel Import ................................................................................................................. 38
te: ng

3.7.6 Add New User to SQL Server Project ...................................................................................... 39

3.7.7 Import Security Settings ........................................................................................................... 40
Da ing E

3.7.8 Change Administrator Password .............................................................................................. 41

4 AVEVA Instrumentation Engineer ........................................................................................................ 43
4.1 Starting AVEVA Instrumentation Engineer ................................................................................. 43
4.2 Project Setup .................................................................................................................................. 44
4.2.1 Plant Area Types ...................................................................................................................... 45
ult

Exercise 1 – Create Plant Area Type ........................................................................................................... 46

4.2.2 Plant Areas (Worked Example) ................................................................................................ 47
ns

Exercise 2 – Create Plant Areas ................................................................................................................... 48

4.2.3 Pick Lists (Worked Example) ................................................................................................... 49
Co

4.2.4 Tag Formats (Worked Example) .............................................................................................. 50

4.2.5 Assigning Tag Formats (Worked Example) ............................................................................. 56
4.2.6 Class Definitions (Worked Example)........................................................................................ 58
ata

Exercise 3 – Class Definition and Assigning Tag Formats ....................................................................... 59

4.2.7 Instrument Type Catalogue (Worked Example) ....................................................................... 60
Exercise 4 – Instrument Type Catalogue .................................................................................................... 63
r: T

4.2.8 Loop Type Catalogue (Worked Example) ................................................................................ 64

4.2.9 Process Units ........................................................................................................................... 67
me

4.2.10 Project Voltages ....................................................................................................................... 68

Exercise 5 – Create Project Voltages .......................................................................................................... 69
4.2.11 Property Definitions (Worked Example) ................................................................................... 70
sto

4.3 Options ............................................................................................................................................ 72

4.4 Instruments Catalogue (Worked Example) ................................................................................. 74
4.5 Datasheet Catalogue...................................................................................................................... 76
Cu

4.5.1 Modify Datasheet Template (Worked Example) ...................................................................... 77

Exercise 6 – Datasheet Configuration ......................................................................................................... 79
4.5.2 Create an User Defined Datasheet Template (Worked Example) ........................................... 80

Copyright © 2014. 5 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.3 Create an User Defined Front SheetTemplate (Worked Example) ......................................... 83

ril)
4.5.4 Auto Create Properties (Worked Example) .............................................................................. 84
4.5.5 Auto Create Mappings for Multiple Tags (Worked Example) ................................................... 86

Ap
Exercise 7 – Copy Mappings ........................................................................................................................ 90
4.5.6 Export Datasheets to Pre-defined Folder ................................................................................. 93
5 AVEVA Instrumentation Wiring Manager ............................................................................................ 95

8th
5.1 Starting AVEVA Instrumentation Wiring Manager ...................................................................... 95
5.2 Options (Worked Example) ........................................................................................................... 96
5.3 Cable Catalogue ............................................................................................................................. 97

to
5.3.1 Add Cable to the Catalogue (Worked Example) ...................................................................... 97
5.3.2 Select Cables (Worked Example) ............................................................................................ 98
Exercise 8 – Cable Catalogue ....................................................................................................................... 99

il
pr
5.3.3 Import Cables into the Catalogue ........................................................................................... 100
5.4 Field Devices ................................................................................................................................ 103

A
5.4.1 Add a Field Device (Worked Example) .................................................................................. 104
5.5 Major Equipment Catalogue (Worked Example) ....................................................................... 105

4-2 2nd
5.6 Setup ............................................................................................................................................. 109
5.6.1 Wiring Rules ........................................................................................................................... 109
5.6.2 Ferrule Rules .......................................................................................................................... 115
Exercise 9 – Setup Wiring Manager ........................................................................................................... 117

8-0 d (
5.7 Cable Drums (Worked Example) ................................................................................................ 119

4
Exercise 10 – Setup Wiring Manager ......................................................................................................... 120
5.8
5.8.1
- 0 ite
Cable Block Diagrams ................................................................................................................. 121
Enhanced Cable Block Diagram Options ............................................................................... 121
-24 Lim
5.8.2 Enhanced Cable Block Diagram – User Defined Symbols .................................................... 124
Exercise 11 – Symbols Creation ................................................................................................................ 130
6 AVEVA Instrumentation Designer ...................................................................................................... 133
-04 ers

6.1 Starting AVEVA Instrumentation Designer ............................................................................... 133

6.2 Options .......................................................................................................................................... 134
6.2.1 General ................................................................................................................................... 134
02 ine

6.2.2 Revisions ................................................................................................................................ 134

6.2.3 Rev Clouds ............................................................................................................................. 135
6.2.4 Terminations ........................................................................................................................... 136
te: ng

6.2.5 Enhanced Cable Block Diagrams .......................................................................................... 137

6.3 Project Setup ................................................................................................................................ 137
Da ing E

6.3.1 Drawing Titles (Worked Example) .......................................................................................... 138

Exercise 12 – Drawing Titles ...................................................................................................................... 139
6.4 Termination Diagram Seeds ....................................................................................................... 140
Exercise 13 – Generate a Termination Diagram: ...................................................................................... 142
ult

6.5 CBD Seeds .................................................................................................................................... 143

6.6 Loop Templates ............................................................................................................................ 144
ns

6.7 Hookup Drawings......................................................................................................................... 145

6.7.1 Hookup Item Catalogue (Worked Example) .......................................................................... 145
Co

6.7.2 Hookup Catalogue.................................................................................................................. 147

Exercise 14 – Generate a Hookup Template ............................................................................................. 150
ata
r: T
me
sto
Cu

Copyright © 2014. 6 www.aveva.com

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

ril)
Ap
1 Introduction

8th
This training guide has been developed for the instrumentation project administrator user who will be
responsible for the setup, configurations and maintenance of a defined project. The sections covered within
this guide attempts to describe all the relevant activities required to initiate an AVEVA Instrumentation

to
project.

1.1 Aim

il
pr
This guide aims to be a source of the administrative knowledge necessary for the administration of an

A
AVEVA Instrumentation project. This includes the complete definition, setup and configuration of access and
security rights, design criteria, equipment catalogues, templates and seeds of an AVEVA Instrumentation

4-2 2nd
project. The contents of this guide can also be referenced during maintenance activities.

1.2 Objectives

8-0 d (
4
At the end of this training course, the administrator(s) will be able to:
 - 0 ite
Create and setup an AVEVA Instrumentation Project.
-24 Lim
 Define access and security rights.
 Create equipment catalogues
 Create customized Datasheet templates, drawing templates and seeds.
-04 ers

1.3 Prerequisites
02 ine

The following are some basic prerequisites for Trainees attending the Training Course in AVEVA
te: ng

Instrumentation 12.1:
 Familiar with Instrumentation and Process engineering data.
Da ing E

 Familiar with Instrumentation from a design or operations perspective, which includes various types
of Instruments, Cabling and basic knowledge of Process Control System (PLC/DCS).
 Well versed with using Microsoft® Excel.
ult

 Refer the AVEVA Instrumentation Installation User Guide for the system requirements both
ns

hardware and software.

AVEVA Instrumentation has been installed on the Trainee’s computers that they will be using for the duration
Co

of this training course.

Microsoft Office 2007, 2010, 2013 and 365 (Excel) has been installed on the Trainee’s computers that they
ata

will be using for the duration of this training course.

r: T

Enterprise, Standard or Express versions of Microsoft SQL Server 2008 R2 (SP3) or 2012 (SP3) or 2014
(SP1) must be installed on each Trainee’s computer, or each Trainee must have access to an instance of
Microsoft SQL Server installed elsewhere on the network the Trainees might be connected to.
me

The name of the instance of Microsoft SQL Server that the Trainee has access to must be known to each
Trainee.
sto

AutoCAD 2014, 2015 or 2016 is a prerequisite for this training course.

Cu

Copyright © 2014. 7 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
If training is to be conducted in a stand-alone environment, then all four of the AVEVA Instrumentation
modules are to be installed on each machine. This will include Security Manager. Each trainee is to
have read and write access to the instance of the SQL server used for training, and have permissions

Ap
set to be able to create databases on the instance of the SQL server used for training.
 If training is to be conducted in an administrative environment, then all four of the AVEVA

8th
Instrumentation Modules are to be installed on the AVEVA Instrumentation project administrators
machine. This will include Security Manager. The AVEVA Instrumentation project administrator is to
have read and write access to the instance of the SQL server used for training, and have permissions
set to be able to create databases on the instance of the SQL server used for training.

to


il
For any details about the hardware and software requirement and assistance with SQL Server

pr
installation please refer to the AVEVA Instrumentation Installation guide.

A
4-2 2nd
1.4 Course Structure

Training will consist of oral and visual presentations, demonstrations and set exercises. Each workstation will

8-0 d (
have a training project and supporting material. These will be used by the trainees to practice their methods,
and complete the set exercises.

4
1.5 Using this guide - 0 ite
-24 Lim
Certain text styles are used to indicate special situations throughout this document, here is a summary;

Menu pull downs and button press actions are indicated by bold dark turquoise text.
-04 ers

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

02 ine

Annotation for trainees benefit:

 Additional information
te: ng

 Refer to other documentation

Da ing E

System prompts will be bold italic and in inverted commas i.e. 'Choose function'

Example files or inputs will be in the courier new font.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 8 www.aveva.com

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

ril)
Ap
2 AVEVA Instrumentation Training Workflow

8th
The AVEVA Instrumentation product suite consists of five modules:
 AVEVA Instrumentation Engineer

to
 AVEVA Instrumentation Process Engineer


il
AVEVA Instrumentation Wiring Manager

pr
 AVEVA Instrumentation Designer

A
 AVEVA Instrumentation Security Manager

4-2 2nd
The AVEVA Instrumentation Training Manuals give an overview to the user on how to setup and, configure a
project; create and manipulate engineering data and generate project deliverables during a project life cycle

8-0 d (
using AVEVA Instrumentation.

4
AVEVA Instrumentation (12.1) training has been designed to be presented to four different groups and
follows the workflow shown below:

- 0 ite
-24 Lim
AVEVA Instrumentation Administration (TM-6101): Project Administrators
 AVEVA Instrumentation Engineer (TM-6102): Instrumentation Engineers
 AVEVA Instrumentation Wiring Manager (TM-6103): Instrumentation Designers
-04 ers

 AVEVA Instrumentation Designer (TM-6104): Instrumentation Designers and CAD operators


02 ine

AVEVA Instrumentation Process Engineer (TM-6106): Process Engineers

te: ng
Da ing E
ult
ns
Co

 The AVEVA Instrumentation Process Engineer Training can be run after AVEVA Instrumentation
Administrator Training if it is required.
ata

 AVEVA Instrumentation Process Engineer Training Manual is not part of the main workflow of this
training course. Hence the AVEVA Instrumentation Process Engineer data will not be included in the
r: T

main training project.

The Trainee is recommended to refer the flowchart while working through the Training Manual(s).
me
sto
Cu

Copyright © 2014. 9 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

2.1 AVEVA Instrumentation Administration Training Guide Workflow

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 10 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

2.2 AVEVA Instrumentation Engineer Training Guide Workflow

ril)
Ap
8th
ilto
A pr
2.3 AVEVA Instrumentation Wiring Manager Training Guide Workflow

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

2.4 AVEVA Instrumentation Designer Training Guide Workflow

02 ine
te: ng
Da ing E
ult
ns

2.5 AVEVA Instrumentation Process Engineer Training Guide Workflow

Co
ata
r: T
me
sto
Cu

Copyright © 2014. 11 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
This page is intentionally left blank.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 12 www.aveva.com

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

ril)
Ap
3 AVEVA Instrumentation Security Manager

8th
The Security Manager application enables an Administrator to setup access and security rights on objects
and areas in an AVEVA Instrumentation SQL Server database. Security rights can be assigned to a specific
user by name (the user’s login), or can be controlled via a user-defined role name.

to
3.1 Create a New Project

il
pr
A new AVEVA Instrumentation project can be created from any of the AVEVA Instrumentation modules. For
the purposes of this training course, a new project is created via the AVEVA Instrumentation Security

A
Manager Module.

4-2 2nd
8-0 d (
AVEVA Instrumentation Security Manager

4
can be started from the start menu:
- 0 ite Start Menu > All Programs > AVEVA >
-24 Lim
Engineer > AVEVA Instrumentation 12.1.4
> Instrumentation Security Manager
12.1.SP4.
-04 ers

Or, AVEVA Instrumentation Security

Manager can be started from the AVEVA
02 ine

Instrumentation 12.1.4 Icon on the

desktop.
te: ng
Da ing E

If the desktop icon option is selected, a window will open (below ) displaying the AVEVA Instrumentation
modules available to start. Double click on Instrumentation Security Manager 12.1.SP4 to start the
AVEVA Instrumentation Security Manager application
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 13 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

When AVEVA Instrumentation is first initiated after an installation then the user will be presented with this

ril)
Browse for Folder Window to select a folder for Project Workgroup.

Ap
8th
If this window does appear then browse to or make
new folders to create the folder:

to
C:\AVEVA_InstrumentationTraining\Projects

And then select it and then pick OK.

il
pr
 AvevaInstProjects.mdb a Microsoft Access

A
database file will be saved to that location. The
AvevaInstProjects.mdb file holds the list of all

4-2 2nd
of the projects created using AVEVA
Instrumentation; this list is displayed in the
Select an AVEVA Instrumentation Project list

8-0 d (
window.

4
- 0 ite
-24 Lim

 inst.ini is a pointer that AVEVA Instrumentation looks at to display the AvevaInstProjects.mdb list of
-04 ers

projects and this is located at: C:\Users\<UserName>\AppData\Roaming. Any time when the
AvevaInstProjects.mdb file location needs to be updated, this inst.ini file should be removed, then
02 ine

the Browse for Folder Window will appear to set the new location.
 AIReports.mdb a Microsoft Access database file will be saved to the project folder each time a project
is created.
te: ng
Da ing E

If an AVEVA Instrumentation Project or projects already exists, then the user will be presented with the
Select an AVEVA Instrumentation Project… form.

If this form is displayed, (contents will differ to

that shown here) then click New. The
ult

Create a New AVEVA Instrumentation

Project… form (below) will be displayed.
ns

If an existing project does not already exist,

Co

then the Create a New AVEVA

Instrumentation Project… form will be
displayed as the AVEVA Instrumentation
ata

Security Manager module is started using

any one of the methods described above
r: T

(an image of this form is given below).

me
sto
Cu

Copyright © 2014. 14 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Once the Create a New AVEVA Instrumentation Project form is opened, the administrator(s) can enter
project data. Make that the Project folder: text box is pointing to the correct location:
ult

C:\AVEVA_InstrumentationTraining\Projects
ns

If not, click on the command button to the right of the Project folder: text box and navigate to the
correct folder. Now, start entering the project information (details) starting with Project Name or No: by
Co

clicking into the text box.

As soon as the focus is moved away from the Project folder: text box a message is given asking to apply
ata

Project changes to File Locations/Folders.

r: T
me

Click the Yes button to continue.

sto
Cu

Copyright © 2014. 15 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The remaining folder location text boxes are now populated with the correct project folder paths:

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Type: TM6101_01_XX (where XX are the initials of the user) into the Project Name or No: text box.
ult

As soon as the focus is moved away from the Project Name or No: text box, the project name is added to
ns

the project folder path in the Project folder: text box.

Co

To the right of the SQL Server Name:

text box is a button. Select it.
ata

When selected, a login window will

open.
r: T
me
sto
Cu

Copyright © 2014. 16 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The instance of the SQL Server that

ril)
the user will login to is to be typed
into the text box. (What is shown here

Ap
is the writers instance; the users will
be different).

8th
It is advisable to test the connection
by pressing the Test Connection
Button.

il to
A pr
4-2 2nd
If the connection is successful, the user will be informed, select OK to close the message, and then select
OK on the SQL Server Login… form.

8-0 d (
4
Copy options:
- 0 ite
 Empty Project: The default option. A new blank project with no project data and the default security
settings will be created if this option is selected.
-24 Lim
 Demo Project: AVEVA Instrumentation includes a ‘Demo Project’ database which can be copied for
the purposes of evaluating or testing AVEVA Instrumentation.
 Packaged Project: Projects can be “packaged”, that is saved to a single package (.pkg) file.
-04 ers

Project setting and data are copied from the packaged project.

Continue to populate the form with the following data:

02 ine

Check “Empty Project”. Do not check “Share with Electrical”.

te: ng

Project Description text box: My 1st AVEVA Instrumentation Project

Da ing E

Plant Name text box: My Plant

Plant Location text box: My Location

ult

Client Name text box: AVEVA Solutions Ltd

ns

Client Project No text box: TM6101

Co

Design Database TM6101_01_XX (where XX are the initials of the user)

As the user clicks into the Design Database: field, the user is given a prompt, asking about change the
ata

folders location.

Check that project path is correct: C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX (where

r: T

XX are the trainee’s initials), select Yes.

me

If the user has AutoCAD installed on their PC, Select the button to the right of the AutoCAD Start File and
browse for the executable file that will start AutoCAD (normally acad.exe located in the AutoCAD
programme folder).
sto

Another check box Share with Electrical is available, which can be checked anytime during the course of the
project if the administrator(s) would like to share the project database with AVEVA Electrical.
Cu

 A project database once shared between AVEVA Instrumentation and AVEVA Electrical cannot be
unshared later during the course of the project.

Copyright © 2014. 17 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The form will look similar to the following:

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Select Save.
te: ng

AVEVA Instrumentation will then build the database for the project:
Da ing E
ult
ns
Co

When complete, an alert form appears informing the administrator(s) that the project was created
ata

successfully:
r: T

Select OK
me
sto
Cu

Copyright © 2014. 18 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
The Project Selection Form containing the
New Project is Displayed, Select Project
TM6101_01_XX (where XX are the trainee’s

8th
initials), and click Select

il to
A pr
The Login form appears. Type Password into the Password

4-2 2nd
text box and then select Login.

8-0 d (
4
- 0 ite
The AVEVA Instrumentation Security Manager Module opens.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata

3.2 Enable Security Settings

To enable Security Manager on the current project, click Settings in the left-hand pane and then check the
r: T

Security Enabled checkbox in the right hand pane.

Once security is enabled the access rights and restrictions (on objects and areas) assigned to the users are
enforced.
me

Once the Security Manager Security is enabled, the Grid Locks check box becomes available. Once
sto

checked, the grids will be locked for the selected project to prevent more than one user editing the same
information. If another user attempts to edit the same information, they will be locked out and a message is
displayed warning the user that the information is currently being edited by another user
Cu

 By default, Security is disabled on all new Security Manager projects. If security is not enabled, all
users will have read and write access to all data.

Copyright © 2014. 19 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.3 Groups and Users

ril)
AVEVA Instrumentation Security Manager has four default groups pre-created to cover the common user

Ap
types on any project:
 Everyone

8th
 Process Engineers
 Instrument Engineers

to
 Instrument Designers.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

Each of these groups has default access rights pre-set as default to Security Manager objects based on
typical project requirements. These default access rights can be modified by the Administrator.
02 ine

 Everyone is a special group and is the default group for any user not specific to the project that
accesses the project database. Group Everyone defaults to read only access.
te: ng

All Security Manager SQL Server seed databases have a single default user named Administrator. To
Da ing E

open the user list, select Users in the left hand tree view
ult
ns
Co
ata
r: T
me

Once the Security is enabled on the database, each AVEVA Instrumentation Module will automatically add
any users name that opens an AVEVA Instrumentation Project to the Users List in Security Manager and
sto

assign the Everyone group (read only) to them. The Project Administrator will then use Security Manager
to apply additional access permissions.
Cu

The default Administrator user is defined as a Security Manager Administrator, which enables the Security
Manager to login and edit the security settings for the current database.

Copyright © 2014. 20 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.3.1 Add a New Group

ril)
To add a new group select Groups from the left hand tree view, the group window is displayed (see image

Ap
above). Click the Add Group button from the tool bar menu.

8th
The Group window is displayed.

In the Name: text box type Technicians and in the

to
Description text box, type O&M Personnel.

il
pr
Click the Save button.

A
4-2 2nd
The new group is added to the list on the right hand side.

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

3.3.2 Edit Groups

The descriptions against Instrument Engineers will be edited to give a clearer description.
ult
ns

Open the groups list by selecting Groups from the left hand tree
window. Double click on the group Instrument Engineers
Co

Enter Instrument Design Engineers in the Description: text

box and click the Save button.
ata
r: T
me
sto
Cu

Copyright © 2014. 21 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.4 Authentication Type

ril)
The authentication type for a project controls how user access to project modules is validated. Three

Ap
authentication types are available:
 Windows Authentication

8th
 SQL Server Authentication
 AVEVA Project Authentication

to
By default, the Windows authentication type is selected when a project is created. If required, it can
subsequently be changed to either SQL Server authentication or AVEVA Project authentication.

il
pr
 The user login on the SQL Server must have a ‘sysadmin’ role in order to change the authentication

A
type.

4-2 2nd
To open the Authentication Type window, select Project > Authentication Type.

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult

Then Select the required type.

ns
Co
ata
r: T

 The SQL Server Database Engine must be installed in “Mixed Mode (SQL Server authentication and
Windows authentication) Authentication Mode to allow the “AVEVA Project Authentication” type.
me
sto
Cu

Copyright © 2014. 22 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.4.1 Windows Authentication Type

ril)
By enabling this authentication type within Security Manager, project administrators can add Windows users

Ap
to a particular project. Therefore, the users will not require any other password to log into the project.

This is the default Authentication Type, therefore there is no other additional setup. The administrator can

8th
proceed to add the users and define the right access.

to
3.4.1.1 Add a New User

il
To add a new user, select Users in the left hand tree view and click the Add User button on the toolbar

pr
menu.

A
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

The User form will be displayed. To add a new user, click the ellipsis button on the right of the User Name:
text box.
te: ng
Da ing E

This will open the Select User Name form and will
default to the current domain on the network that
computer is logged onto. The domain name can be
ult

typed in or selected from a drop down list box.

ns
Co
ata
r: T

The user name is then typed in or selected from the

pull down list box, and click the Save button on the
me

form.
sto
Cu

Copyright © 2014. 23 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The User form is displayed again. The Administrator can now complete the form giving additional details.

ril)
This new user can now be assigned as an Is Read Only or Administrator.

Ap
If neither of these options is checked then the user can be assigned to a group by double clicking on a group
name in the Not Member Of Group list.

8th
to
Double click the group Technicians available under
Not Member of Group section.

il
pr
A Pseudo user is now assigned to the group
Technicians.

A
To un-assign a user from a group, double click on the

4-2 2nd
group name in the Member Of Group list

Click the OK button.

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

The new user is now listed on the Users grid.

Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 24 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.4.2 AVEVA Project Authentication Type

ril)
By enabling this authentication type within Security Manager, project administrators can define project

Ap
specific usernames and passwords that will be required when attempting to open individual projects.

Irrespective of who is logged into Windows on a particular workstation, if the project level username and

8th
password requirements are not satisfied, access to the project will be denied.

The users are automatically logged into the SQL server using a single SQL user called IDOAdmin. A

to
password is required for this user.

il
Therefore, when the AVEVA Project Authentication type is

pr
selected, the Create AVEVA Project Authentication User
window is displayed.

A
4-2 2nd
8-0 d (
4
If a password was previously specified for the IDOAdmin

- 0 ite
user, the Verify AVEVA Project Authentication Password
window is displayed instead.
-24 Lim

The AVEVA Project Authentication Password can be modified selecting Tools > AVEVA Project
-04 ers

Authentication > Change Password.

02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T

Enter the current password, the new password, and the new
password again to confirm it in the fields provided in the
me

Change Password.
sto
Cu

 The user login on the SQL Server must have a ‘sysadmin’ role in order to change the Project
authentication password.

Copyright © 2014. 25 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.4.2.1 Add a New User

ril)
To add a new user, select Users and click the Add User button on the toolbar menu.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
The User form will be displayed.

4
- 0 ite
-24 Lim
The User Name and Password can be defined in the
fields provided.

A user can by marked as Is Read Only. This stops

-04 ers

the user from editing any data in all application

modules.
02 ine

Marking the user as Is Administrator enables the

user to run Security Manager as an Administrator.
te: ng

Every Administrator must have a Password. The

Password field is enabled if Is Administrator option
Da ing E

is checked.

If neither of these options is checked then the user

can be assigned to a group by double clicking on a
group name in the Not Member Of Group list.
ult
ns

Select the OK button to save the user.

Co
ata
r: T
me
sto
Cu

Copyright © 2014. 26 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.5 Objects

ril)
Objects enable the Project Administrator to set access rights to predefined Objects in AVEVA

Ap
Instrumentation using the Security Manager.

Access rights (Access Types) available are:

8th
 Full Access Permits a user to add, edit and delete data.
 Read Only The user is only permitted to read data and create reports but cannot edit data.

to
 No Access Prevents the user from viewing the object.

il
 Process Data Controls read-write access to Process Data.

pr
 No Create Prevents the user from creating instruments or loops

A
Top level Objects (Designer, Engineer, Wiring Manager and Process Engineer) are the AVEVA

4-2 2nd
Instrumentation Modules and Common Items are Objects that are common to all three Modules:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Each of the top level Objects has Objects below them specific to that particular top level Object. Below is
an Image of Objects specific to the Common Items. The administrator is encouraged to explore all of the
Objects in each of the top level Objects.
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 27 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.5.1 Applying Group Access Types to Objects

ril)
To apply Group Access Type, expand the top level object (Engineer) and select the Object. The image

Ap
below shows the Datasheet object under the Engineer top level Object:

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
When an object is selected the permissions window opens and displays the current Groups defined in the
-24 Lim
database and permissions assigned.

To add a group to the Permission Group, double click on the group.

-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

In the example above, the Technicians group was added to the Permission Group. The Access Type can
ata

be assigned by picking from a drop down list. Here, a Read Only Access Type is being assigned to the
Technicians group.
r: T

 To apply an Access Type to all of the objects within a top level object, select the top level object and
apply the Access Type to the group. All objects under the high level group will have that group and
me

Access Type applied to them.

To un-assign a particular permission Access Type from a group, double click on the group in the
sto

Permission Group list and that group will be removed from the permission group for that Object.
Cu

Copyright © 2014. 28 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.6 Area Access Control

ril)
Area Access Control enables the Project Administrator to set access rights to project plant areas in AVEVA

Ap
Instrumentation.

Access rights (Access Types) available are:

8th
 Full Access: Permits a user to add, edit and delete data in the area.
 Read Only: The user is only permitted to view the details of objects in the area, but not edit or

to
delete it; and create reports that include the object data.


il
Read Only (Allow Connections): The user is only permitted to view object data, create reports

pr
and make connections to objects in the area.
 No Access: Prevents the user from viewing the objects in the area, including disabling of editing

A
and reporting.

4-2 2nd
Click on the Areas node will populate all the plant areas and sub-areas:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult

When an object is selected the permissions window opens and displays the current Groups defined in the
database and access assigned. To add a group to the Permission Group, double click on the group.
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 29 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

In the example above, the Instrument Engineers group was added to the Permission Group. The Access

ril)
Type can be assigned by picking from a drop down list. Here, a Read Only Access Type is being assigned
to the Instrument Engineers group in the Area ’10’.

Ap
To Save the Access Type, click any sub area. A message will be displayed:

8th
to
il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

Select Yes to apply the same Access Type to the Child Areas.
02 ine

 By default all the Areas have the group Everyone with Full Access.
te: ng

To un-assign a particular permission Access Type from a group, double click on the group in the
Permission Group list and that group will be removed from the permission group for that Object.
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 30 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7 Options

ril)
On the menu bar of the AVEVA Instrumentation Security Manager Module, there are options to run

Ap
different administration activities as: Create New Project, Package Project, Create SQL Server Project From
Backup, Add New User To SQL Server Project, Set the Project Offline, Edit Projects and Set AIReports
Password.

8th
 This training guide will NOT explore all of the menu items available from the Security Manager menu
bar. For additional information please refer to the AVEVA Instrumentation Security User Guide.

to
3.7.1 Create a New Project

il
pr
Select Project > Create a New Project. It will open the Create a New AVEVA Instrumentation Project

A
form. The process is the same as above in section 3.1.

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

3.7.2 Package Project

Da ing E

A project can be saved as a single package (.pkg) file. This project package contains the data, data
structure, project folder structure, configuration and documents for the entire project.
ult

New projects can be created from these packages by selecting the appropriate options during project
creation (see section 3.1). Project Packager is a useful tool to help with back-ups, archiving, project hand-
ns

over, copying projects and creating new projects from template or seed projects.
Co

Select Project > Package Project.

ata
r: T
me
sto
Cu

Copyright © 2014. 31 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
The Project Packager window is displayed:

8-0 d (
4
- 0 ite
-24 Lim

Select the location that the package file is to be saved to by clicking the ... button. Enter the file name in the
-04 ers

File Name field and click Save.

02 ine
te: ng
Da ing E
ult

Select the location that the package file is to be saved to by clicking the ... button. Enter the file name in the
ns

File Name field and the selected location and file name are then displayed in the Project Packager window:
Co
ata
r: T
me

Click OK to start packaging the project. The process of the packaging is then displayed in the window:
sto
Cu

Copyright © 2014. 32 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
Select OK to close the Project Packager window.

8th
il to
 Packaging a project requires certain SQL Server Management Objects (SMO) to be installed and

pr
available. If any of these are not installed a message will be displayed and the administrator will be able
to download and installed the files. For detail information, please refer to Section 3.16 of AVEVA

A
Instrumentation Security Manager User Guide.

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 33 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.3 Create SQL Server Project from Backup

ril)
Projects can be restored from SQL Server database backups from within AVEVA Instrumentation Security

Ap
Manager. Select Project > Create a Project from Backup.

8th
il to
A pr
4-2 2nd
8-0 d (
4
The Restore Wizard window is displayed: - 0 ite
-24 Lim
-04 ers

The administrator can enter the full path of the

backup file to restore, or the administrator can
browse for the file to restore by selecting the
02 ine

Browse button to open the Select Backup File

window. Select the Backup file and click the Open
te: ng

button on the Select Backup File window.

Da ing E
ult
ns
Co
ata
r: T

Once the file is entered or selected, click the Next

button on the Restore Wizard window and this
will open the Choose Destination form.
me
sto
Cu

Copyright © 2014. 34 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
The administrator must specify the Server Name
and the name to be given to the database created

8th
from the restored SQL backup. The name of the
database is entered in the Database Name: text
box.

il to
A pr
4-2 2nd
8-0 d (


4
If the administrator selected Use SQL Server Authentication then the User Name and Password text


boxes will be available.
- 0 ite
If windows authentication is used, then the user that is logged onto the machine must be and
-24 Lim
Administrator on the SQL Server.

Click the Next > button on the Restore Wizard and this will open the Restore the database files as
-04 ers

window:
02 ine

Here the administrator enters or browses for the Data File

Path and the Log File Path.
te: ng

 If the path is the same for both fields, the administrator

Da ing E

can populate the Data File path text box and the Log
File path text box will be populated automatically.
ult

Click the Finish button on the Restore Wizard form.

ns
Co
ata

A Restore alert form is displayed once the restore is complete.

Click the OK button on the form and this returns the administrator to the
r: T

Restore Wizard.

A message is displayed in the bottom left corner of the wizard: Restore

me

Finished. Click the Close button to exit the Restore Wizard.

sto

 It is Important to note that this utility is designed to run on the same computer where SQL Server is
installed and all the paths provided should be to a physical drive on the computer and not mapped
Cu

drives.

Copyright © 2014. 35 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.4 Edit Projects

ril)
This option gives the administrator access to remove or add project listings to the Select an AVEVA

Ap
Instrumentation Project window. This utility does not delete or add databases from/to the SQL Server.

Select Project > Edit Projects.

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

Deleting a project listing is achieved by selecting the project or multiple projects by using a combination of
the left mouse button and the Ctrl Key. Once selected the administrator must press the Delete key on the
Da ing E

keyboard.
ult

A Delete Row alert form is displayed. Click the Yes button if the
administrator would like to delete the project listing.
ns
Co

To Edit the contents of a project listing, the administrator clicks into the cell that requires editing with the left
ata

mouse button and edits the text accordingly. An Exception to this is the Database Type column, this can be
edited by making a selection from a pick list in the cell.
r: T

To Add a project listing to the projects list, the administrator must click inside the text box: Click here to
add a new
me
sto

The text disappears, the star to the left is displayed with a flag attached, and blinking cursor appears where
Cu

the text was.

Copyright © 2014. 36 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

If the administrator types the data into the cells as required and then presses Enter key on the keyboard the

ril)
Projects view will look as below:

Ap
8th
il to
A pr
When the administrator has finished adding/editing the Project listing, the administrator must click the Close

4-2 2nd
button.

8-0 d (
Click the Yes button on the Save alert form.

4
- 0 ite
-24 Lim
-04 ers

 When adding a project listing to the list the administrator is to ensure that the database named in the
Database Name column exists on the SQL Server or the administrator will receive an error.
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 37 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.5 Unlock Excel Import

ril)
To prevent duplicated records been created in the database, simultaneous importing of data from Excel by

Ap
more than one user in the same grid is not allowed. The grid is locked while the import process is running
and it is automatically released once the process is finished.

8th
Select Project > Unlock Excel Import.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

The current import sessions are listed:

-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata

If the import fails because of a network outage, or power cut, the grid lock may remain in place. The unlock
Excel Import option gives the administrator access to release the lock.
r: T
me
sto
Cu

Copyright © 2014. 38 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.6 Add New User to SQL Server Project

ril)
Select Project > Add New User To SQL Server Project. This opens the SQL Server Login dialogue box.

Ap
Enter the instance of the SQL Server in the Server Name text box and click the Test Connection to test the
connectivity.

8th
to
Click the OK button on the

il
AVEVA Instrumentation alert

pr
form.

A
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

Click the OK button on the SQL Server Login dialogue box and this opens the Add User to SQL Server
-04 ers

Project(s) form:
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T

Enter (type) the name of the user to be added to the project(s) in the User Domain Login Name text box
and select the appropriate access rights from the Access Rights combo box. Projects that the user is to be
added to are selected using the check boxes on the form and click the Save button. Click the OK button on
me

the alert form.

sto
Cu

Copyright © 2014. 39 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.7 Import Security Settings

ril)
This option can be found on the Tools menu. Select Tools > Import Security Settings.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
Selecting this option will bring up an Import alert box advising the administrator that importing settings from
another project will overwrite the current settings.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

It is up to the administrator(s) to decide whether to change the security settings or not for the current project.
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 40 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3.7.8 Change Administrator Password

ril)
Start AVEVA Instrumentation Security Manager, select Users and double click on Administrator in the

Ap
UserName Column.

8th
il to
A pr
4-2 2nd
8-0 d (
4
This will open the User form:

- 0 ite
-24 Lim
-04 ers

Enter a new password and click the OK button to display

the Password Confirmation window.
02 ine
te: ng
Da ing E
ult
ns
Co

The administrator must re-enter the password to confirm the

ata

new password if the passwords do not match. The

administrator is informed:
r: T
me

If the passwords do match, the confirmation window closes, the

sto

User form closes and the administrator is returned to the Users

list.
Cu

Copyright © 2014. 41 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
This page is intentionally left blank.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 42 www.aveva.com

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

ril)
Ap
4 AVEVA Instrumentation Engineer

8th
4.1 Starting AVEVA Instrumentation Engineer

to
AVEVA Instrumentation Engineer can be started from the windows desktop:

Start Menu > All Programs > AVEVA > Engineer > AVEVA Instrumentation 12.1.4 > Instrumentation

il
Engineer 12.1.SP4.

A pr
4-2 2nd
Select Project TM6101_01_XX (where XX are
the trainee’s initials).

8-0 d (
Click Select

4
- 0 ite
-24 Lim

The AVEVA Instrumentation Engineer Application Window opens.

-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

 AVEVA Instrumentation Engineer can also be started by double clicking on the Plant Engineer icon on
ata

the windows desktop.

 Detail of all of the features available in AVEVA Instrumentation Engineer will not be given in this
training guide. For a detailed explanation of all of the features of AVEVA Instrumentation Engineer,
r: T

please consult the AVEVA Instrumentation Engineer user guide.

me
sto
Cu

Copyright © 2014. 43 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2 Project Setup

ril)
Regional standards/requirements and Company/Corporate standards are all set using the Setup menu

Ap
which can be accessed via the Projects Tab:

8th
il to
A pr
Selecting the Project Tab will open the AVEVA Instrumentation Engineer Backstage Menu.

4-2 2nd
Selecting Setup will give the administrator(s) access to the project setup menu items:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto

 This training guide will NOT explore all of the menu items available from the Setup Menu. For
Cu

additional information please refer to the AVEVA Instrumentation Engineer user guide.

Copyright © 2014. 44 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.1 Plant Area Types

ril)
Select the Project tab and under the Setup option select Add/Edit Plant Area Types.

Ap
8th
ilto
A pr
4-2 2nd
This opens the Area Types window: When first opened on a project, the grid will list the default area type
AREA:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers

Selecting the New or Edit button will open the following dialogue boxes:
02 ine
te: ng
Da ing E
ult
ns
Co

New Selected Edit Selected

ata

Four check boxes are present on the form:

 Path Delimiter: Area can will contain characters or text between Area Path.
r: T

 Can Contain Areas: When checked will permit the area type to contain other area types as might
be required when a project will contain sub-areas.
 Can be Root: Can be placed at the top of an area hierarchy with sub areas below it.
me

 Must be Root: The area type must be at the top of the area hierarchy with sub areas below it.
 Can Contain Equipment: Equipment items can be contained in the area type.
sto

Select OK when editing or creating an Area Type and then select Close to close the Area Type Form.
Cu

 For detailed information about Area Types, please refer to Section 5.1 of the AVEVA Instrumentation –
Common Functionality User Guide.

Copyright © 2014. 45 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 1 – Create Plant Area Type

ril)
Ap
Using the information in 4.2.1 above, create new Area Types:

 Plant Code

8th
 System Code

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

When completed, select Close.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 46 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.2 Plant Areas (Worked Example)

ril)
All objects in AVEVA Instrumentation are based on Area; therefore the next task the administrator will

Ap
perform is to add an Area(s) to the project database.

Select Project > Setup > Add/Edit Plant Areas to open the Areas grid window.

8th
il to
A pr
4-2 2nd
To create a new area, click the New button, this will open the Area Information dialogue box:

8-0 d (
4
- 0 ite To create a new area, the type information into
the text boxes, and, if required, select an Area
Type form a drop down pick list which will
-24 Lim
display a list of Area Types available to the
project:
-04 ers
02 ine
te: ng

For example:
Da ing E

AREA: 10

AREA Type: Plant Code

ult

Description: TRAINING
ns

Short Description: TRN

Co

When finished select OK

ata
r: T
me
sto

Select Close to close the form.


Cu

For detailed information on Areas, please refer to Section 5 of the AVEVA Instrumentation Common
Functionality User Guide.

Copyright © 2014. 47 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 2 – Create Plant Areas

ril)
Ap
Using the information described in the chapter above, create new areas using the information in the table
below:

8th
 The data listed below is suggested to maintain integrity between the training guide and the project that
will be created using this training guide. Administrator(s) are encouraged to go through this training
guide and setup a project using their own regional and corporate standards outside of this training

to
session.
 Descriptions and short descriptions are not required for this exercise, so if desired, the administrator

il
can omit filling in those details.

A pr
Area No. Area Type Parent Area Description Short Description

4-2 2nd
A01 System Code 10 STABILIZER UNIT SU-1
A02 System Code 10 BUILDINGS BLD
A03 System Code 10 PROCESS AREA PA

8-0 d (
A04 System Code 10 FIRE & GAS F&G

4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

When completed, select Close.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 48 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.3 Pick Lists (Worked Example)

ril)
AVEVA Instrumentation supports associating a field with a Pick list, which provides flexibility to the user by

Ap
populating the field (cell) with selected values (user defined) from a pull-down list.

To access the Pick lists option select Project > Setup > Edit Pick Lists which opens a Pick List (All)

8th
window.

to
il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

To create a new Pick List: Click the New button and a PickList Details form is displayed.
Da ing E

Enter the following details on the form:

PickList Name text box: Loop Function

ult

DataType combo box: Text

ns

Ignore the Locked check box and click the Save button.
Co
ata

 Checking the Locked checkbox will prevent

users from typing a value into the given
r: T

field.
me

The new Pick List (Loop Function) will appear on

the Pick List (All) form under Pick List Name.
sto

Click the command button next to the new

Cu

Pick List (Loop Function) to add items (values)

Copyright © 2014. 49 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
The Pick List (Loop Function) form opens: Click Add
Item to enter values (items) into the Pick List.

Ap
Enter the following values:

8th
FG Fire & Gas
A Analysis
F Flow

to
L Level
P Pressure
Q Quantity

il
pr
T Temperature

A
 Clicking the Add Item button several times will produce multiple blank rows. Select the top row, enter a

4-2 2nd
value and then select enter. This will move the administrator to the next row to enter an additional
value. Descriptions are optional.

8-0 d (
Select Save to save the list of values and then Close to close the Pick List (All) window.

4
- 0 ite
Pick lists can assigned to cells in Datasheet Templates, Property Definitions and Tag Codes.
-24 Lim
4.2.4 Tag Formats (Worked Example)
-04 ers

In AVEVA Instrumentation a Tag Format must be used to describe how an Instrument tag number and Loop
number is formatted. The project tag format for Instruments is set during project database creation and can
be changed at any time by selecting from a list of predefined tag formats or even the administrator(s) can
02 ine

create their own customized Tag formants for both Instruments & Loops.

To access the Tag Formats: Select Project > Setup > Tag Formats
te: ng
Da ing E
ult
ns
Co
ata
r: T
me

Four options are available on the form: New, Edit, Delete and Format for, pull down list for selecting
sto

between Instrument and Loop tag formats.


Cu

Unused tag formats can be deleted clicking the Delete button. Two conditions apply. Firstly the tag
format has not been used to create an existing project tag. Secondly, even if the tag format has not
been used to create a project tag, it must not be assigned to a project class.

Copyright © 2014. 50 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.4.1 Tag Format for Instruments

ril)
To add a New Instrument Tag Format, click New to display the Tag Format form:

Ap
8th
il to
pr
Complete the form as shown here to

A
the left.

4-2 2nd
To add a Tag Code to use in the tag
forma, click in the Click here to… text
box:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Selecting the down arrow will present a pick list

ult

of available fields to use in the tag format.

ns

Select Apply:
Co
ata

The administrator can add additional fields, or

r: T

create additional fields by selecting the Tag

Codes button at the bottom of the form.
me
sto
Cu

Copyright © 2014. 51 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
To add additional Tag
Codes to the available list,
place a check mark in the

8th
Select check box against
the code that you want to
use. To add additional

to
fields to the list select New

il
A pr
4-2 2nd
8-0 d (
In the Add New Tag Code form enter details

4
as shown to the right:

Click OK
- 0 ite
-24 Lim
The newly created Tag Code is added to the
list and a check mark is automatically placed
-04 ers

against it.

Close the Select Tag Codes for Instruments

02 ine

form.
te: ng
Da ing E
ult
ns

Add another Tag Code and select LoopFunc

Co

previously created.

Complete the form as shown on the left.

ata

Select OK and the close the Tag Format

r: T

form.
me
sto
Cu

Copyright © 2014. 52 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4

- 0 ite
-24 Lim
Only Tag Formats not used on an existing tag or assigned to an Instrument or Loop Class Definition
can be deleted.

4.2.4.2 Assigning Pick List to Tag Code Field

-04 ers

The pick list Loop Function that was created earlier is going to be used for the LoopFunc Code Tag part
02 ine

of the Instrument Tag Format.


te: ng

Pick Lists can be assigned directly to fields in the grids via the Grid Manager dialogue.
Da ing E

Close the Tag Formats form. In the main application window, open the Instruments grid (empty) and then
select the Home tab and then select Manage:
ult
ns
Co
ata
r: T
me
sto
Cu

When the Grid Views form opens, select the little arrow next to the New button, and then select Copy
Selected. This will create a copy of the AVEVADefault view.

Copyright © 2014. 53 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
Select the Fields tab. And then filter for the field
LoopFunc that was created earlier.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Place a check mark in the check box in the column Select, and then using the pick list in the PickList
te: ng

column; select the pick list Loop Function that was created earlier.
Da ing E

Select Save and then Close.

4.2.4.3 Tag Format for Loops

ult

Select Tag Formats from project setup and change the option from Instrument to Loop on the Format for:
ns

combo box.
Co
ata
r: T
me
sto

Similarly, click the New button and enter details on Tag Format form to create a new Tag format for process
Cu

Loops.

Copyright © 2014. 54 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The completed form should appear as below:

ril)
Ap
8th
il to
pr
Select OK and the close the Tag Format
form.

A
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

Tag Formats form should show the newly inserted format as shown.
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 55 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.5 Assigning Tag Formats (Worked Example)

ril)
Tag formats are assigned to Instruments and Loops Class Definitions. Different tag formats can be

Ap
assigned to different class definitions.

To open the Class Definitions select Project > Setup > Class Definitions.

8th
ilto
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Select the class INS and then Assign Tag Format

te: ng
Da ing E
ult
ns
Co
ata
r: T
me

The Instruments Tag Formats window opens. There are two check box columns: Assign and Primary.
sto

Each class can have many tag formats associated to them. The format that is selected as the primary tag
format is the default tag format that opens when creating new items of equipment of that class.
Cu

Clear the existing check marks, first assign the tag format ISA (delimiters) and then make the ISA
(delimiters) tag format the Primary.
Click Save.

Copyright © 2014. 56 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

In Class Definitions view, change the option from Instruments to Loops on the Format for: combo box.

ril)
Ap
8th
il to
pr
Similarly, select the class ILP and then Assign Tag Format. Assign the tag format ISA (delimiters) and
then make the ISA (delimiters) tag format the Primary.

A
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Click Save and close the Class Definitions window.

te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 57 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.6 Class Definitions (Worked Example)

ril)
The administrator can create new classes or delete the existing ones if not required to classify the object

Ap
types (Instruments and Loops). Select Project > Setup > Class Definitions:

8th
il to
A pr
4-2 2nd
8-0 d (
4
Select New.
- 0 ite
-24 Lim
-04 ers

In the Class Details form enter details as

shown to the left.
02 ine
te: ng

Click OK.
Da ing E
ult

Clicking the OK button will add the class to the list of Instruments Classes.
ns
Co
ata
r: T
me
sto
Cu

 Classes can also be imported and exported via Excel to enable exchange between projects. Please
refer to the AVEVA Instrumentation Engineer user guide.

Copyright © 2014. 58 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 3 – Class Definition and Assigning Tag Formats

ril)
Ap
Using the information in above:

 Assign the tag format instrument F&G Format previously created to the instrument F&G class.

8th
 Create a new class F&G Loops for Loops and assign to it the Fire & Gas Format tag format
previously created.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 59 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.7 Instrument Type Catalogue (Worked Example)

ril)
An “Instrument type” consists of the association of an instrument function with a class. Select Project >

Ap
Setup > Type Catalogue:

8th
ilto
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Wiring rule and operation principle are displayed in the Instrument Types Catalogue window.

To add a new Instrument type to the grid, click the New button:
ult
ns

To create a new instrument type, select the Class

Co

Name and the Class Description is completed

automatically. Enter the instrument Function and
its description. Finally, select the I/O Type,
ata

Location, Wiring Rule and Operating Principle.

r: T
me
sto
Cu

Copyright © 2014. 60 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

On the right hand side of the I/O Type, Location and Operating Principle lists are buttons with an arrow

ril)
pointing to the right. When pressed a Pick List window opens. This gives flexibility to the content of pick
lists. Items can be added or removed from the list.

Ap
For example:

8th
Class Name: INS

to
Function: ZSH

il
Description: Valve Open Position Indication

A pr
System: DCS

4-2 2nd
I/O Type: DI

Location: FLD

8-0 d (
4
Wiring Rule: 2 Wire Switch (NO) to JB
- 0 ite
-24 Lim
-04 ers

Pick the button to the right of the Operating Principle text box to open the Pick List window to add an item
to the list.
02 ine
te: ng
Da ing E

Click Add Item then type Limit

Switch into the box that appears
below PickList Value column.
ult
ns
Co
ata
r: T

Press the Save button. Now the Principle Limit Switch appears in the pick list.
me
sto
Cu

Copyright © 2014. 61 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
Select Operating Principle: Limit Switch

to
And then click OK

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult

 The administrator may Import and Export the Instrument Type Catalogue using Excel through the
ns

options available on the menu.

Co
ata
r: T
me
sto
Cu

Copyright © 2014. 62 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 4 – Instrument Type Catalogue

ril)
Ap
Using the information above, add the following instrument types listed below:

Class Name: F&G

8th
Function: FD

to
Description: Flame Detector

il
System: DCS

A pr
I/O Type: AI

4-2 2nd
Location: FLD

Wiring Rule: 2 Wire Tx To JB

8-0 d (
4
Operation Principle: F&G
- 0 ite
-24 Lim
Class Name: F&G
-04 ers

Function: HORN

Description: Emergency Horn

02 ine

System: DCS
te: ng

I/O Type: DO
Da ing E

Location: FLD
ult

Wiring Rule: 2 Wire Solenoid To JB

ns

Operation Principle: F&G

Co
ata
r: T
me
sto
Cu

Copyright © 2014. 63 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.8 Loop Type Catalogue (Worked Example)

ril)
By default, the Instrument Types Catalogue window is displayed when the above option is selected. To

Ap
open the Loop Type Catalogue view, select Loops from the Catalogue for list.

8th
il to
A pr
4-2 2nd
8-0 d (
4
A “loop type” consists of the association of a loop code with a class. Click New button.
- 0 ite
To create a new loop type, select the Class Name and the Class Description is completed automatically.
-24 Lim
Enter the Loop Code and its description. Finally, enter the Order value.
-04 ers

 The entry in the Order field defines the position

02 ine

in which a loop type will appear in the list of

values. The lower the order number, the higher
the position. Loop types with the same number
te: ng

will be listed in alphabetically order.

Da ing E
ult
ns
Co

For example:

Class Name: ILP

ata

Loop Code: A
r: T

Description: Alarm
me

Order: 99
sto

When finished select OK

Cu

Copyright © 2014. 64 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
Select Import from Excel.

4-2 2nd
Browse to the location where the files supplied by your trainer are located:

C:\AVEVA_InstrumentationTraining\ExcelFiles\Loop Type Catalogue.xls

8-0 d (
4
Click the Open button on the Select Import File form.


- 0 ite
Ensure that the Excel columns names mapped for data import do not contain leading or trailing spaces.
-24 Lim
-04 ers

Complete the mappings as shown to

the left and then select Import and
02 ine

then Batch Process all

te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Check Accept All and then Save.

Copyright © 2014. 65 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

A log file (.csv) is created and opened automatically in Microsoft Excel which contains the imported status

ril)
for all the items.

Ap
 The log file is created with time and date file name, and saved in the same imported file folder.
 After an import finishes AVEVA Instrumentation just delegates the responsibility of opening .csv file to

8th
the Operating System and as in most cases .csv file is attached to Microsoft Excel, so Excel starts up.
If user associates another software with .csv files then OS will always open csv file in that software.

to
Close the file and return to the Loop Type Catalogue window.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns

Now you will notice that a loop type can have more than one type code assigned to it.
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 66 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.9 Process Units

ril)
The user can add, edit and delete Process Units and Process Properties (type of process units). One

Ap
process unit can be assigned the default for a particular process property within a project.

Select Project >Setup > Edit Process Units to access the process units of the project.

8th
A Process Units (ALL) window will appear with three columns: Process Property, Unit and Default.

il to
A pr
Select the process property Pressure from the pull

4-2 2nd
down list.

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

Uncheck the bar and Select kPa to make it the

pressure default unit.
Da ing E
ult
ns
Co
ata
r: T

Click the Save button to exit Process Unit window.

 For detailed information on Process Units, please refer Section 3.5 of AVEVA Instrumentation Engineer
me

User Guide.
sto
Cu

Copyright © 2014. 67 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.10 Project Voltages

ril)
Project voltages can be added to the Instrumentation project so that power supply can be assigned to the

Ap
active Instruments (Transmitters, Actuators, etc.).

Select Project > Setup > Project Voltages to access the project voltages for the project. A Voltages

8th
window will appear.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Click the New button and Project Voltage option, the following dialogue box will be open:
te: ng

The text box Volts is where the new project voltages are
entered. Enter 24
Da ing E

The No. of Phase pull down list has the following

options available: 1, 2, & 3: Select 1
ult

The Frequency pull down list has the following options

available:
ns

50, 60 & DC Select DC

Co

Select Apply
ata

Pressing the OK button will add the voltage to the list of project voltages.
r: T
me
sto
Cu

Copyright © 2014. 68 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 5 – Create Project Voltages

ril)
Ap
Using the information in 4.2.10 above, add a Project Voltage using listed below:

 Volts: 230

8th
 No. of Phase: 1
 Frequency: 50

ilto
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

When completed, select OK.

Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 69 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.2.11 Property Definitions (Worked Example)

ril)
AVEVA Instrumentation supports user defined properties to aid the user while creating Datasheet

Ap
Templates, defining Instruments, Process Lines and Process Equipment. These properties enable users to
create meaningful attribute names for data that has no other logical property or field within the project
database. The Properties are defined on the basis of an Instrument Class Type which contains Instrument

8th
Data and Process Data as its two Object Types.

A new property can be created and assigned to an Instrument or Catalogue Datasheet Template.

to
Properties can be assigned to an instrument either through the instrument window or assigning the
instrument datasheets to a catalogue datasheet template containing the property. Data can be assigned to

il
that property which then updates the database.

pr
New properties can be displayed in the following grids within the Instrumentation Engineer module:

A
 Instruments
 Process Data

4-2 2nd
 Instrument Catalogue

 If the user has a Catalogue Datasheet Template open at the same time as creating a new field, the new

8-0 d (
field does not display until the datasheet is closed and then re-opened.

4
- 0 ite
To access the Property Definitions option select Project > Setup > Property Definitions
-24 Lim
This opens the Property Definitions window and by default the window displays the Class Type
Instrument and Object Type Instrument Data.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 70 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
The greyed out Property Names are system defined and the user cannot edit or delete these
properties.
Some of the properties included within AVEVA Instrumentation have a prefix before them in order to

Ap
categorise them based on their Object Type.

8th
Class Type Object Type Prefix Description
Properties used on the
Instrument Sizing form
INSTRUMENT - Process Data ‘sz’

to
specific to Instrument Class
Type.

il
pr
With Instrument as the Class Type, select Instrument Data as the Object Type, click the New button to

A
add a Property.

4-2 2nd
A Property Definition form is displayed.

8-0 d (
4
Enter the following information on the form:

- 0 ite Property Name text box: TrnProperty

-24 Lim
Caption text box: Training Property

Check Available for Custom Reports check

-04 ers

box.


02 ine

The Available for Custom Reports

option will add the property to the SQL
Query Maker interface when
te: ng

creating/editing Custom Reports.

Da ing E
ult

The new property ‘TrnProperty’ is now listed on the Property Definitions window. Click the Close button
to exit.
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 71 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.3 Options

ril)
To setup the project options: Select Project tab > Options

Ap
Three tabs available for the administrator are: Instruments, Process Data and Datasheets.

8th
On the Instruments tab, administrator(s) have the option to either select the process properties from the
Process Data grid by activating the Instrument Process Properties radio button or the process properties
from Process Lines and Process Equipment grid by activating the Process Item Properties radio button.

il to
A pr
The administrator may

4-2 2nd
change the text/combo field
label captions on the Edit
Instrument dialog form by

8-0 d (
checking the Use Gridview

4
Captions for Instruments

- 0 ite Edit Dialog check box.

-24 Lim
-04 ers
02 ine
te: ng

Check the Allow Duplicate Instrument Tags in Different Project Locations checkbox to allow an
Instrument Tag to be duplicated in a different location.
Da ing E
ult
ns

On Process Data tab, the

administrator may change the
Co

text/combo field label captions

on the Edit Process Line and
Edit Process Equipment
ata

dialogue form by checking the

Use Gridview Captions for
r: T

Process Data Edit dialog

check box.
me
sto
Cu

Copyright © 2014. 72 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
On the Datasheets tab, the
administrator may set the

8th
Datasheet revision history
and also what revision
details are to be displayed on

to
datasheets.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
Enter the following information on the form:
-24 Lim
Max. No. of Revisions: 5
By text box: BY
-04 ers

Checked text box: CHKD.

Approved text box: APPR.
02 ine
te: ng

 The Revision entry form for datasheets will not include the By, Checked or Approved fields if the
appropriate check boxes are not checked.
Da ing E

 If the maximum No. of revisions is set to Zero, revisions entered will not display on the datasheets.

By default, the check box under Sheet of Calculation is unchecked, and the Tag Assignment check box is
checked.
ult

Tick the checkbox under Sheet of Calculation and click Save.

ns

Click Yes to confirm the Datasheets SheetOf value.

Co
ata
r: T
me
sto

This closes the form.

Cu

Copyright © 2014. 73 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.4 Instruments Catalogue (Worked Example)

ril)
The Instrument Catalogue in AVEVA Instrumentation is used to allows the creation and definition of

Ap
instruments properties such as Instrument name, Location, Description, Manufacturer, Model number, Size,
Datasheet number, Operating principal, Wiring configuration, etc.

8th
The user can create specific instrument attributes to be used in populating property field of any instrument in
a particular project. This catalogue can be imported and exported from one project of the application to
another.

to
To access the Instrument Catalogues: Select Home > Select > Instruments (under Catalogues). The

il
Instruments Catalogue grid is displayed:

A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

To add a new Instrument to the Instrument Catalogue, click the New button under the Records pane. This
Da ing E

brings up the Add New Catalogue Instruments form.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 74 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Enter the following information in:

ril)
Name: Temperature Transmitter

Ap
Location Code: FLD
Description: Temperature Transmitter

8th
Enter the following information in the General tab:

Select the Detail Tab:

to
Loop Dwg Code: 11

il
pr
Select the Datasheet Tab:

A
4-2 2nd
Manufacturer: Rosemount
Model No: 3144P
Supplier: Emerson Process Management

8-0 d (
4
Select the Properties Tab:

- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Click OK to close the window and save an item in the Catalogue.

ult

The user is encouraged to view the contents of the other tabs: DCS System, PLC/ESD System, User, and
ns

Alarm/Settings.
Co

 Instruments Catalogue can be imported from other projects. Select From Other Project in the Import
section of the Manage tab to display the Select an AVEVA Instrumentation Project window. Select the
ata

project from which the Instruments Catalogue are to be imported.

r: T
me
sto
Cu

Copyright © 2014. 75 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5 Datasheet Catalogue

ril)
AVEVA Instrumentation is equipped with a catalogue of sample (template) Datasheets. This catalogue is

Ap
sufficient for the user to get started with creating Instrument datasheets (specification sheets). Datasheets
can be imported from Microsoft® Excel and mapped to AVEVA Instrumentation fields, assisting the user to
customize their own datasheets.

8th
To access the Datasheets Catalogue: Select Home > Select > Datasheet Forms (under Catalogues).

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

This will open the datasheet catalogue, and a contextual Datasheet Catalogue tab.
02 ine
te: ng
Da ing E

There are two options on the Actions pane: Open and Open in Excel. To edit the layout or captions on the
ult

Datasheet template, the user should use the Open in Excel option and make the necessary modifications
and save the Datasheet.
ns

To add additional data link mappings or to change existing mappings, the user should use the Open option
Co

on the datasheet.
ata
r: T
me
sto
Cu

Copyright © 2014. 76 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.1 Modify Datasheet Template (Worked Example)

ril)
Select the Form Name S20.40 datasheet template and click the Open in Excel button from the Actions

Ap
pane.

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

The user can now add new cells on excel spread sheet, and then map these fields to the new cells.
-04 ers

Under the heading ELEMENT add a field called Body Rating and under heading OPTIONS add a field
called Purchase Order.
02 ine

 The user would have to edit the cells on the excel spread sheet to include the new fields.
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 77 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Save and close the excel spread sheet. Select the S20.40 datasheet template again and click the Open

ril)
button from the Actions pane.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
This opens the catalogue datasheet S20.40. Observe that the fields added in excel are now included.
-04 ers
02 ine

To the right of the datasheet template is

a list of fields. Clear all filters, and then
te: ng

filter on the Table column for Instrument

List.
Da ing E
ult
ns
Co
ata

On the Datasheet, some cells are shaded grey, which indicates that these cells have been mapped to
Datalinks. Cells without any fill (white) are available for mapping. For example: Click on the P&ID No: cell of
r: T

the datasheet and note how the mapped field P&IDNo is highlighted.
me
sto
Cu

Mapping a field to a cell in the datasheet is achieved by dragging the required field from the fields list, into
the required cell in the datasheet.

Copyright © 2014. 78 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 6 – Datasheet Configuration

ril)
Ap
Open in Excel and modify the Datasheet Template for Orifice Plate (S20.21). Include the fields (left) below
on the last row under the heading ORIFICE PLATE and map them to the fields (right).

8th
 Discharge Coefficient szDischargeCoeff
 Reynolds Number szReynoldsNo

il to
A pr
4-2 2nd
8-0 d (
4
Save and Close the datasheet template.
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 79 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.2 Create an User Defined Datasheet Template (Worked Example)

ril)
Users can create their own customized Datasheet templates using Microsoft Excel® in either xls or xlsx

Ap
format, which can then be imported into AVEVA Instrumentation Engineer. The user must map the AVEVA
Instrumentation Data links onto the required cells on the Datasheet template.

8th
AVEVA Instrumentation can also create properties automatically using captions that describe what data is
held in an adjacent cell. This is a very time efficient tool which means that users can import their existing
datasheets into AVEVA Instrumentation quickly and effortlessly.

to
To add the Datasheet Template: Open the Datasheet Catalogue grid by selecting the Home > Select >

il
Datasheets Forms (under Catalogues):

A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

This adds a contextual tab Datasheet Forms Catalogue. Click the New button under the Records pane.
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 80 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

This will open the Select Catalogue Type dialogue box.

ril)
Ap
8th
Select the Datasheet radio button and click the Save button.

il to
A pr
4-2 2nd
The Form Information form is displayed. Enter the following details on the form:

8-0 d (
4
Form Name text box: PG-MultiTag
- 0 ite Description text box: Pressure Gauge
-24 Lim
– Multiple Tags

Max No. of Tags: 4

-04 ers

Max No. of Plant

Connections: 1
02 ine

File Name text box: MT_PG001

te: ng

Principle of Operation combo box:

Pressure Gage
Da ing E

Click the (Browse) command button.

ult

A Catalogue alert form is displayed which informs the user that the file was not found, and asks if the user
would like to locate and copy the file into the Datasheet Template folder.
ns
Co
ata

Click the Yes button on the form.

r: T
me
sto

Browse and select the file PG-MultiTag.xls provided by the Trainer and click the Open button on the Select
existing Template spread sheet to copy to project browser window.
Cu

Copyright © 2014. 81 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

A Catalogue alert form appears to confirm that the file was copied successfully.

ril)
Ap
Click the OK button.

8th
to
Click the Save button on the Form Information form. A Catalogue alert form is displayed.

il
A pr
4-2 2nd
Click the Yes button.

8-0 d (
4
- 0 ite
The Datasheet template PG-MultiTag is now added to the Datasheet Form Catalogue.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 82 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.3 Create an User Defined Front SheetTemplate (Worked Example)

ril)
To add a new front sheet definition to the project catalogue click the New button under the Records pane.

Ap
This will open the Select Catalogue Type dialogue box.

8th
to
Select the Front Sheet radio button and click the Save button.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
The Form Information form is displayed. Enter the following details on the form:
-24 Lim

Form Name text box: Front Sheet

-04 ers

Description text box: Front Sheet for

Documents
02 ine

File Name text box: Front Sheet

te: ng
Da ing E
ult

Click the (Browse) command button.

ns

A Catalogue alert form is displayed which informs the user that the file was not found, and asks if the user
Co

would like to locate and copy the file into the Datasheet Template folder. Click the Yes button on the form.

Browse and select the file Front.xls provided by the Trainer.

ata

Click the Open button on the Select existing Template spread sheet to copy to project browser window.
r: T

Click the OK button on the Catalogue alert form displayed.

Click Save button on the Form Information form and then Yes on the Catalogue alert
me
sto
Cu

Copyright © 2014. 83 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.4 Auto Create Properties (Worked Example)

ril)
Select the datasheet template PG-MultiTag from the Datasheet Catalogue grid and click the Open button

Ap
from the Actions pane.

This opens an empty and unmapped datasheet which is typical of a user defined (customised) datasheet.

8th
 This worked example will not create all the Properties in this Datasheet. Only a few will be created to
demonstrate the auto creation of properties.

to
Using the mouse cursor, drag the fields split screen so that all the columns on the right hand side are visible.

il
A pr
4-2 2nd
8-0 d (
4
Clear the filter on the Used column.
- 0 ite
-24 Lim
-04 ers

Also, click the Auto Hide option above the Cell column.
02 ine

On the tool bar menu, click the New Property button and select the Auto Create Properties option from the
te: ng

context sensitive menu.

Da ing E
ult
ns

This will open the Auto Create Properties window:

Co
ata
r: T
me
sto
Cu

Copyright © 2014. 84 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Arrange the Auto Create Properties window adjacent to the group heading GAUGE on the Datasheet

ril)
Template.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
Select the caption Pressure Measurement Type and a red rectangle will surround the caption cell and the

- 0 ite
property to be created is listed (appears) in the Auto Create Properties window.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me

Similarly, select the remaining captions till ‘Pointer’, available under the heading GAUGE.
sto
Cu

Copyright © 2014. 85 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
The updated Auto Create Properties window should appear as below:

Ap
8th
il to
A pr
4-2 2nd
Click the Create button.

8-0 d (
4
- 0 ite
-24 Lim
An Export Report form is displayed, where the user can export to
excel, print or close.
-04 ers

Click the Close button.

02 ine

 The user is notified if the properties already exist or created in

the project database.
te: ng
Da ing E
ult

4.5.5 Auto Create Mappings for Multiple Tags (Worked Example)

ns

AVEVA Instrumentation supports copying of data link mappings for multiple tags on a Datasheet template.
This is an enormous time saving tool and means that user can copy mappings for multiple tags on a
Co

datasheet template and into AVEVA Instrumentation quickly and effortlessly.

 This worked example will not map all the fields in this Datasheet. Only a few will be mapped to
ata

demonstrate the auto copy data link mapping feature for multiple tags.

Click the Fields tab on the right hand corner of the datasheet template.
r: T
me
sto
Cu

Copyright © 2014. 86 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
This displays the list of all the Fields (datalinks) which will now be mapped to the datasheet template.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

From the pull down list under column Table, select InstrumentList and select TagNo from the pull down list
under column Field.
ult
ns
Co
ata

Using the mouse cursor, drag and adjust the fields split screen so that all the columns on the datasheet are
r: T

visible.

Click the Auto Hide button to pin the fields list and check the Auto Copy Multiple Tags check box.
me
sto
Cu

Copyright © 2014. 87 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Click and hold (mouse click) on the record Tag1 under the column Tag and drag it across and release the

ril)
click next to the caption Tag No. on the datasheet template.

Ap
8th
il to
The colour changes to grey once the datalink is mapped to the cell.

A pr
The Cell and Used columns are updated for the record Tag1.

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
Now try mapping the record Tag2 adjacent to Tag1 onto the datasheet template.
-04 ers

Click and hold (mouse click) on the record Tag2 under the column Tag and drag it across and release the
click adjacent to the data link mapping for Tag1 and AVEVA Instrumentation will copy the mappings for
Tag3 & Tag4 onto the cells consecutively after Tag2 on the datasheet template. Once mapped, the colour of
02 ine

the cell changes from orange to grey.

te: ng
Da ing E
ult

The Cell and Used columns are updated on the Fields grid.
ns
Co
ata
r: T

Select IService1 (Instrument Service) from the pull down list under column Field.
me
sto
Cu

Copyright © 2014. 88 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Drag and drop the Instrument Service mappings across for Tag1 onto the Datasheet Template.

Ap
8th
to
AVEVA Instrumentation copies the mappings for Tag2, Tag3 & Tag4. Once mapped, the colour of the cell
changes from orange to grey.

il
A pr
4-2 2nd
8-0 d (
Similarly, drag and drop the mappings for P&IDNo and PlantConnection for the four Tags.

4
The Fields grid should appear as below:
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 89 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 7 – Copy Mappings

ril)
Ap
1. Create a new Datasheet form type Other with the file CalibrationSheet.xls provided by the Trainer.

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

2. Open the Datasheet template PG-MultiTag and map the Datalinks using the Auto Copy Multiple
Tags feature for four Tags.
-04 ers
02 ine

 Pressure Measurement
Type
te: ng

 Min
 Max
Da ing E

 Figure Interval
 Minor Graduation
 Case Design
 Size
ult

 Case Material
 Lens Material
ns

 Movement Material
 Ring Construction
Co

 Ring Material
 Type

ata

Matl
 Dial Material
 Colour
r: T

 Pointer
me
sto
Cu

Copyright © 2014. 90 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
The Datasheet template should appear as below:

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

Click the Save & Exit button on the datasheet template.

-04 ers
02 ine

3. Open the Datasheet template Front Sheet and map the Datalinks manually without checking the
Auto Copy Multiple Tags check box.
te: ng
Da ing E

 Project Number
 Plant Name
 Client Name
ult

 Title1
 User Field 1
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 91 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
The Datasheet template should appear as below:

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Click the Save & Exit button on the datasheet template.

te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 92 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

4.5.6 Export Datasheets to Pre-defined Folder

ril)
User may define the folder(s) to which the datasheets will be exported and also the format of the

Ap
Datasheets.

To specify the folder(s) and sub-folder(s), select the Project > Setup > Set Datasheet Export File

8th
Name/Folders

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult

This opens the File Export Settings form.

ns
Co
ata
r: T
me
sto

In the Root Folder: text box enter the folder where the datasheets will be located.
Cu

Use the button to browse for the required folder.

Copyright © 2014. 93 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Users must create a folder in C:\ Drive called AI Datasheets to maintain consistency with the
screenshots.

Ap
To specify the folder structure, select the check box for each attribute under the lists Sub Folder and File
Name.

8th
Under each list, select the following check boxes and if required enter text and delimiters in the text box.

to
Sub Folder File Name

il
{ProjectNo} {AreaNo}

pr
{AreaNo} {DocNo}

A
{Sheet}
{Rev}

4-2 2nd
{ProjectNo}-Area{AreaNo} {AreaNo}-{DocNo}-{Sheet}-{Rev}

The completed File Export Settings form should appear as below:

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

Click the Save button to exit the form.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 94 www.aveva.com

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

ril)
Ap
5 AVEVA Instrumentation Wiring Manager

8th
5.1 Starting AVEVA Instrumentation Wiring Manager

to
AVEVA Instrumentation Wiring Manager can be started from the windows desktop:

Start Menu > All Programs > AVEVA > Engineer > AVEVA Instrumentation 12.1.4 > Instrumentation

il
Wiring Manager 12.1.SP4.

A pr
4-2 2nd
Select Project TM6101_01_XX (where XX are
the trainee’s initials).

8-0 d (
4
- 0 ite Click Select
-24 Lim
The AVEVA Instrumentation Wiring Manager Application Window opens.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

Before getting started with AVEVA Instrumentation Wiring Manager, some preparation and checks are
required for example:
ata

 Project Cables
 Create Devices
 Create Wiring Rules
r: T

 Create Ferrule Rules

 Enhanced Cable Block Diagrams User Defined Symbols and Preferences
me

 Create Cable Drum Definition

The user has the flexibility to manipulate the Plant Areas, Area Types and Pick Lists even within the Wiring
sto

Manager Module.
Cu

Copyright © 2014. 95 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.2 Options (Worked Example)

ril)
AVEVA Instrumentation Wiring Manager permits the user to set the preferences for I/O Modules, Project

Ap
Cables and their termination details under the Options window.

To access the Options window: Select Project tab > Options. This opens the Options window displaying

8th
the General tab:

to
On the General tab, the user may change the
Earth Core marking for all Cables by typing the

il
required value in the Cable Earth Core Code text

pr
box.

A
Change the measuring units from ‘m’ (meters) to
‘ft.’ (feet) by using the pull down list for Cable

4-2 2nd
Length Units field.

Check: Use Auto Ferrule Numbering Rules

8-0 d (
check box to allow and update the Ferrule

4
numbering for each core during terminations,

- 0 ite following the user defined Ferrule Rules.

Check: Copy Instrument Service to Field

-24 Lim
Device description check box, copies the field
Instrument service from Instrument list to
Equipment list. If unchecked, uses Instrument
-04 ers

description from Instrument list.

02 ine

Click the Cores button. The Cores Group Type form opens.
te: ng
Da ing E

The existing values can be modified or the user may

ult

add new items if required clicking Add Item.

ns
Co
ata
r: T
me

Click the Cancel and Save buttons to exit.

 For detail information about Options, please refer to the AVEVA Instrumentation Wiring Manager User
sto

Guide.
Cu

Copyright © 2014. 96 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.3 Cable Catalogue

ril)
The Cable Catalogue is used to view all catalogue cables and allows definition of manufacturers cable

Ap
properties such as Catalogue number, manufacturer, cable type (cores, pairs, triads, quads), number of
cores, pairs or triads, core markings, core size, whether the cable has screens/shields, earth core, armoured
etc., its outer diameter, weight, etc.

8th
In AVEVA Instrumentation all project cables must be based on a catalogue cable. This ensures the project
cable attributes (size, number of cores, type etc.) are consistent with a 'real' cable. The user can reassign

to
another catalogue cable to any project cable at any time. This changes the project cable to have the
properties (size, number of cores, type, core markings etc.) of the newly assigned catalogue cable, keeping

il
current terminations for the original cable.

pr
The user can select (Allow) specific cables for a particular project from the Cable Catalogue. The cable

A
catalogues can be imported from a spread sheet or imported from another project within the application.

4-2 2nd
To access the Cable Catalogues: Select Home > Select > Cables (under Catalogues). The Cables
Catalogue grid is displayed.

8-0 d (
5.3.1 Add Cable to the Catalogue (Worked Example)

4
- 0 ite
To add a new cable to the Cable Catalogue: Click the New button under the Records pane. This brings up
the Catalogue Cable Details form.
-24 Lim
The Catalogue Cable Details form consists of four tabs: Cable Data, Design Data, View Cores and User
Fields. Enter the following details on the Cable
Data tab to add a typical individually and
-04 ers

collectively screened, armoured cable:

Class combo box: Instrument

02 ine

Manufacturer text box: AVEVA

Catalogue Number text box: AVEVA001
te: ng

Group Type combo box: Pairs

Da ing E

No. of Pairs text box: 10

Units combo box: mm²
Core Size combo box: 1
ult

Check OAS/Coll check box

ns

Check Group/Indiv check box

Check Armoured check box
Co

Voltage Range combo box: 300/500V

ata

Insulation Type combo box: PVC

Insulation Temperature
combo box: 70 degC
r: T

Colour combo box: BLACK

me

Description combo box: PVC/SWA/PVC

sto

 Cable Catalogue Users Fields are available on

the User Fields tab. These can also be
Cu

populated on the cable catalogue grid.

Copyright © 2014. 97 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Select the Design Data tab, and enter these details:

ril)
Ap
Wire Size combo box: 1/0.8mm
Outside Diameter text box: 24.2

8th
Minimum Bending Radius text box: 145.2
Mass text box: 890

to
Conductor Material combo box: Cu
Impedance Units combo box: ohm/km

il
pr
Core Resistance text box: 9.8

A
Drum Length text box: 500

4-2 2nd
Drum Length value will be used to create
automatically cable drums when the option
Auto Cable Drum selected Cables is

8-0 d (
selected.

4
- 0 ite Enhanced Cable Block Diagram:
Line Style combo box: Dashed
-24 Lim
Line Width combo box: 2
Line Colour combo box:
-04 ers

RoyalBlue
Arrow Head combo box:
02 ine

 User can control how cables appear on the

cable block diagrams. Each cable catalogue
te: ng

entry has these graphical properties.

Da ing E

Press - Apply
Select the View Cores tab to view the cores of the new cable.
Click the OK button to save the information and close the Catalogue Cable Details form.
ult

 The Apply button on the form saves the information to the database while keeping the form open and
ns

the OK button will save the information to the database and immediately closes the form.
Co

5.3.2 Select Cables (Worked Example)

ata

Use the pull down list under Class and select Instrument, which displays all cables under the Instrument
class.
r: T
me

Furthermore, under the field Catalogue No. type 23501 and the specific cable (1Pr x 16AWG) is filtered out.
Check the Allow Use check box on the first column of the Cable Catalogue grid.
sto
Cu

Similarly, filter out and check the Allow Use check box for Control Cable with Catalogue No: 29017.

Copyright © 2014. 98 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 8 – Cable Catalogue

ril)
Ap
Create a cable with the following parameters:

Cable Data Tab:

8th
Class combo box: Instrument
Manufacturer text box: AVEVA
Catalogue Number text box: AVEVA006

to
Group Type combo box: Pairs

il
No. of Pairs text box: 10

pr
Units combo box: mm²

A
Core Size combo box: 1

4-2 2nd
Check OAS/Coll check box
Check Group/Indiv check box
Check Armoured check box

8-0 d (
4
Voltage Range combo box: 300/500V
Insulation Type combo box:
Insulation Temperature
PVC
- 0 ite
-24 Lim
combo box: 70 degC

Colour combo box: BLACK

-04 ers

Description combo box: PVC/SWA/PVC

02 ine

Design Data:
te: ng

Wire Size combo box: 1/0.8mm

Outside Diameter text box: 24.2
Da ing E

Minimum Bending Radius text box: 145.2

Mass text box: 890
Conductor Material combo box: Cu
ult

Impedance Units combo box: ohm/km

ns

Core Resistance text box: 9.8

Co

Line Style combo box: Chained

ata

Line Width combo box: 2

Line Color combo box: FireBrick
r: T

Arrow Head combo box:

me
sto
Cu

Copyright © 2014. 99 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.3.3 Import Cables into the Catalogue

ril)
AVEVA Instrumentation Wiring Manager supports importing catalogue cables from an Excel spread sheet

Ap
and can also import catalogue cables from another AVEVA Instrumentation project.

The user must make sure that the Excel spread sheet at least contains the following columns (fields):

8th
 Catalogue No
 Group Type
 No of Groups

to
 Group Screen Required = GroupScr
 Overall Screen Required = OAScr

il
 Earth Core

pr
Enhanced Cable Block Diagram Cable Properties:

A
 Line Style = LineType
 Line Width = LineTypeWidth

4-2 2nd
 Line Color = LineTypeColor
 Arrow Head = LineTypeArrowHead

8-0 d (
To access the Import tool, open the Cable Catalogue grid and select the Manage tab. Click the From Excel

4
button under the Import pane.
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

This opens the Cable Catalogue Import

Da ing E

Wizard. Select the Excel spread sheet

Import Cable Catalogue.xls provided by
the Trainer and click the Next > button on
the wizard.
ult

Click the TRAINING link label on the

ns

Worksheets form.
Co
ata
r: T

This opens the Select Mappings section on the wizard. The user must map each Excel column name
me

(heading) to an AVEVA Instrumentation database field and data can then be imported into AVEVA
Instrumentation. AVEVA Instrumentation Wiring Manager will scan the first row of the Excel file and list the
sto

headings of the columns on the left hand side of the Equipment Import window as Excel Column Name.
The right hand side column will list the AVEVA Instrumentation Field which will be mapped with the fields
on Excel Column Name.
Cu

AVEVA Instrumentation Wiring Manager will attempt to automatically map the first row of the Excel column
headers to AVEVA Instrumentation Field Names if the names appear to be a logical match.

Copyright © 2014. 100 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Use the pull-down list for each field under AVEVA Instrumentation Field column, and map them with

ril)
suitable fields on Excel Column Name column.

Ap
Once the mappings have been setup the user can save theses mappings if require. Click the New button on
the Equipment Import Wizard and enter the details as below:

8th
Click the Save button.

to
And the mappings configuration is saved under the
Saved Mappings combo box.

il
A pr
4-2 2nd
8-0 d (
4

- 0 ite Most of the AVEVA Instrumentation
Fields were mapped automatically
-24 Lim
to each field on Excel Column
Name only Colour1 and Colour2
were mapped manually.
-04 ers

 The user can save the mappings

while using the import functionality
02 ine

within any module of AVEVA

Instrumentation.
te: ng

 Ensure that the Excel columns

Da ing E

names mapped for data import do

not contain leading or trailing
spaces.
ult

Once the fields have been mapped,

ns

click the Next > button on the Import

wizard.
Co
ata
r: T
me
sto

 Arrow Head values are:

NoArrow
Cu

StartArrow
EndArrow
Both

Copyright © 2014. 101 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Check the Select All check box to accept the import of the two records (AVEVA002 & AVEVA003) and click

ril)
the Next > button on the wizard.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
The Cable Catalogue Import Wizard lists the cables with the valid data.
-24 Lim
-04 ers
02 ine

Click the Import button to proceed.

te: ng
Da ing E
ult
ns
Co
ata

An Import alert form is displayed to confirm the import function.

r: T
me

Click the OK button on the form.

sto
Cu

Copyright © 2014. 102 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

A log file (.csv) is created and opened automatically in Microsoft Excel which contains the imported status

ril)
for all the items.

Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4

 - 0 ite
The log file is created with time and date file name, and saved in the same imported file folder.
After an import finishes AVEVA Instrumentation just delegates the responsibility of opening .csv file to
-24 Lim
the Operating System and as in most cases .csv file is attached to Microsoft Excel, so Excel starts up.
If user associates another software with .csv files then OS will always open csv file in that software.
-04 ers

Close the file and return to the Cables Catalogue grid.

02 ine

5.4 Field Devices

The Field Devices Catalogue within AVEVA Instrumentation Wiring Manager is used to define Field
te: ng

Devices and their terminals arrangements.

Da ing E
ult
ns
Co
ata
r: T
me
sto

To access the Field Device Catalogue: Click Home > Select > Field Devices (under Catalogues).

This displays the Field Devices Catalogue grid. To assist the user, few basic Field Devices are available
Cu

and can be used while creating Wiring Rules for Instruments.

The user can delete or uncheck the Allow Use check box if any Field Device is not relevant to the project.

Copyright © 2014. 103 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.4.1 Add a Field Device (Worked Example)

ril)
1. Motor Auxillary Contacts

Ap
To add a new Field Device: Click the New button under the Records pane.

8th
This displays the Field Device Definition form.

to
Enter the following details on the form:

il
Check the Allow Use check box

pr
Catalogue Name text box: Motor

A
Auxiliary Contacts

4-2 2nd
Description text box: Pump Running
Status
Right Quantity text box: 2

8-0 d (
4
- 0 ite
-24 Lim
Click and enter the Terminal Numbers X1 & X2 into the terminal graphics (white box).

Click the OK button to save and exit the Field Device Definition form.
-04 ers

The new Field Device is now listed on the Field Devices Catalogue grid.
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me

 For detailed information about Field Device Catalogues, please refer to Section 5.15.2 of AVEVA
Instrumentation Wiring Manager User Guide.
sto
Cu

Copyright © 2014. 104 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.5 Major Equipment Catalogue (Worked Example)

ril)
Another method of adding equipment (Junction Boxes, Cabinets, Panel, etc.) to the project database is by

Ap
using the Major Equipment Catalogue.

This feature allows the user to copy and create a standard equipment configuration from the Major

8th
Equipment Catalogue, complete with terminal strips and terminal markings.

To access the Major Equipment Catalogue: Select Home > Select > Major Equipment (under

to
Catalogues).

il
This opens the Major Equipment Catalogue tab displaying an empty Major Equipment Catalogue grid.

A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

To add equipment to the Major Equipment Catalogue grid: While under the Home tab, Click the New button
te: ng

from the Records pane.

Da ing E

The Equipment Information form is then displayed.

Enter the following details:

ult

Catalogue Name text box: 30T-JB-WP

ns

Equipment Type pull-down list: Junction

Co

box
ata

Description text box: 30 Terminal

Junction Box, Weatherproof
r: T
me

Click the Save button to add the equipment to the Major Equipment Catalogue grid.
sto
Cu

Copyright © 2014. 105 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
To add Terminal Strip & Terminals (including

8th
terminal markings) to the Catalogue item, right
click and select the Edit option from the menu or
click the Edit button from the Records pane.

il to
A pr
4-2 2nd
8-0 d (
4
An Options window is displayed.
- 0 ite
-24 Lim
-04 ers

Click on the Edit Detail link label.

02 ine
te: ng
Da ing E

This opens the Equipment Layout window for the Catalogue item.
ult
ns
Co

Right Click within the layout

(white dotted line) and select Add
ata

Terminal Strip on the context

sensitive menu.
r: T
me
sto
Cu

Copyright © 2014. 106 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Click the More Information button. Fill the form as shown below:

ril)
Ap
8th
Certain fields impose design constraints
 No. of Holes/Cables (max.):

to
Limits no. of cables that can be
connected
 No. of Terminal Strips (max.):

il
pr
Limits no. of terminal strips that
can be created

A
 No. of Terminals per Terminal
Strip (max.): Limits no. of

4-2 2nd
terminals per terminal strip

Leaving any of these values blank

8-0 d (
removes the constraints i.e. no checks

4
- 0 ite Click the OK button to close the form.
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

The Terminal Strip Information form is then displayed. Enter the details for Terminal Strip and Number or
ult

Terminals and the completed form shall appear as below:

ns
Co

Terminal Strip No text box: TS1

ata

No. of Terminals text box: 30

First Terminal No. text box: 1

r: T
me
sto

Click the Save button on Terminal Strip Information form to add the Terminal strip, Terminals and a Din
Rail for the Catalogue Equipment 30T-JB-WP.
Cu

Copyright © 2014. 107 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Enter the following details on the Layout form:

ril)
Termination Drawing check box: Checked

Ap
Signal Class Applies check box: Checked
Digital check box: Checked

8th
Non I.S check box: Checked

Signal Serv. Applies check box: Checked

to
Control check box: Checked

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns

Click the Save and Exit option on the Equipment Layout form.
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 108 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.6 Setup

ril)
The Setup menu under the Project tab provides the user access to the project setup menu items in Wiring

Ap
Manager:

8th
il to
pr
 The user has the

A
flexibility to

4-2 2nd
manipulate the Plant
Areas, Area Types
and Pick Lists even
within the Wiring

8-0 d (
Manager Module.

4
- 0 ite
-24 Lim
-04 ers

5.6.1 Wiring Rules

02 ine

AVEVA Instrumentation uses Wiring Rules to auto generate the creation of Field Device (including
terminals), field cable(s), wire/signal numbers and termination details.
te: ng

To access Wiring Rules: Select Project > Setup > Wiring Rule Definitions. This opens the Wiring Rule
Da ing E

Definitions window.
ult
ns
Co
ata
r: T
me
sto
Cu

The above window lists all the Wiring Rules defined in the project database.
By selecting a wiring rule on the left column will display the graphical representation of that particular Wiring
Rule on the right.

Copyright © 2014. 109 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.6.1.1 Create a Wiring Rule (Worked Example)

ril)
1. Motor Alarm Status

Ap
The user can create a new Wiring Rule by following these steps:

8th
Click New and a new Graphical
Wiring Editor appears.

to
Enter the Wiring Rule name as

il
Motor Alarm Status in the text box

pr
Wiring Rule Name.

A
Next, Right Click in the middle of
the graphics area and a context

4-2 2nd
sensitive menu appears with two
options Add Cable and Add
Equipment.

8-0 d (
4
- 0 ite
A sub menu is available under Add Equipment. Select Field Device and an Equipment dialog box opens
with Equipment No. and Type text boxes.
-24 Lim
Using the pull down list under text
box Equipment No: Select {TAG}
-04 ers

Type: Click the button, and

Select a Field Device Terminal
02 ine

Configuration window opens. Use

the Graphic tab to view the Field
Devices using the scroll bar. Double
te: ng

Click to select Pump Running

Status Field Device.
Da ing E

The completed Equipment form

should appear as below.
ult
ns

Click the Save button and the Field Device will be displayed on the Graphical Wiring Rules Editor with its
terminals X1 & X2.
Co

Similarly, Right Click in the middle of the graphics editor and from the context sensitive menu select
Junction Box from the submenu of
ata

Add Equipment field

r: T

This opens an Equipment dialog box

with Equipment No. and No. of
me

Terminals text boxes.

Equipment No pull down list: {JB1}

sto

No. of Terminals text box: 3

Cu

Click the Save button and Equipment

(JB1) with three terminals is
displayed on the graphical area.

Copyright © 2014. 110 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
The number of terminals on the Junction Box depicts only the termination sequence and not the actual
terminals of the Junction Box.

Ap
8th
To add a cable between the
equipment:

to
Right Click in the middle of the
graphics area and select Add Cable

il
from the context sensitive menu.

pr
This opens a Cable form.

A
4-2 2nd
8-0 d (
4
- 0 ite Select {TAGNo-NoDelimiter} under
-24 Lim
the combo box for Cable No:

Click the command button to the

right of the Catalogue No combo
-04 ers

box, and this opens the Cable

Catalogue.
02 ine
te: ng
Da ing E

Using the filters, select a cable by typing 29017 in the filter for Catalogue No. field. To select the cable for
the Wiring Rule double click on the record.
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 111 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The completed form should appear as below:

ril)
Ap
Click on the Save button and the

8th
Cable will appear on the Graphical
Wiring Editor.

il to
A pr
4-2 2nd
Select the Cable (by their label) and drag it to a suitable location on the graphical editor.

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

The user must now terminate the cores of the Cable at each end (Field Device & Equipment).

At the end (Left) of the Cable: Right Click > Connect Wire (From) > 1BK
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 112 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Drag the core (1BK) and Click to terminate the core at terminal X1 of Field Device (TAG).

ril)
Ap
8th
il to
A pr
4-2 2nd
Follow the same steps to terminate core 2BK at terminal X2 of the Field Device. Similarly, at the other end

8-0 d (
(Right) of the Cable: Right Click > Connect Wire (To) > 1BK

4
- 0 ite
Drag the core (1BK) and Click to terminate the core at terminal 1 of Equipment (JB). The user must follow
same instructions for cores 2BK and Earth core.
-24 Lim
Once terminated, the cores of both sides of the cable on the Wiring Rule should appear as below:
-04 ers
02 ine
te: ng
Da ing E
ult
ns

To add wire/signal number to the core: Right click on Terminal X1 and select Edit Signal No. from the
menu.
Co

 Signal Numbers are inherited by all wires or cable cores that are connected directly to a terminal
ata

containing a Signal Number.

r: T
me
sto
Cu

Copyright © 2014. 113 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
This opens the Terminal form.

4-2 2nd
Select {TAG} from Signal No combo box and add ‘+’ outside the parenthesis (right).

8-0 d (
The Terminal form should appear as below:

4
- 0 ite
Click the Save button and similarly right click on Terminal X2
and select Edit Signal No. from the menu.
-24 Lim
Select {TAG} from Signal No combo box and add ‘-’ outside the
parenthesis (right).
-04 ers

The Terminal form should appear as below:

02 ine

Click the Save button.

te: ng
Da ing E

By adding the Signal Numbers, the colour of Terminals X1 & X2 changes from black to blue.
ult
ns
Co
ata
r: T
me
sto

Click the Save button and click the Close button on the Wiring Rule Definitions window to exit.
Cu

 For detailed information about Wiring Rules, please refer Section 11 of AVEVA Instrumentation Wiring
Manager User Guide.

Copyright © 2014. 114 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.6.2 Ferrule Rules

ril)
AVEVA Instrumentation Wiring Manager supports Ferrule Numbers, which may be different at each end of

Ap
the core (wire) for Field Devices and Equipment. A Ferrule Number is stored for each wire end, where its
default value is empty (blank).

8th
While using Ferrule Numbering Rules, AVEVA Instrumentation Wiring Manager dynamically creates and
updates the signal numbers as terminations are managed.

il to
A pr
4-2 2nd
The user can create (define) a customised Ferrule Rule for each equipment whether Field Device or
Cabinets/Junction Box etc.

8-0 d (
To access the Ferrule Rules: Select Project > Setup > Ferrule Rule Definitions

4
This opens the Ferrule Rules grid window.
- 0 ite
-24 Lim
5.6.2.1 Create a Ferrule Rule (Worked Example)
-04 ers

To add a Ferrule Rule: Click New and a Ferrule Rule dialog box appears.

Enter the following information into the text boxes both by typing manually and by using the pull down lists.
02 ine

Ferrule Rule Name: LEFT HAND SIDE

te: ng

Example: +/00-FT-100/JB-101/TS1/1
Da ing E

(Proposed Ferrule rule format)

Datalink: Using the pull-down list, Check the

suitable check boxes for selecting Datalinks
ult

and delimiters (/, \, -, _, etc.) as below

ns

{TNo-OtherEnd}/{EqNo-OtherEnd}/
{EqNo}/{TSNo}/{TNo}
Co
ata
r: T

 If the same delimiter is used more than once then the user must enter or type them manually in the
Datalink combo box.
me

Default check box: Unchecked (If checked the current Ferrule Rule will be default for all terminations of the
project).
sto

Apply by Equipment Type check box: Checked. This will activate the Add & Remove buttons on the
Cu

Ferrule Rule form.

Copyright © 2014. 115 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
Click Add and select Junction Box from the
pull down list under Equipment Type and

8th
select Left from the pull down list under Side(s).

il to
A pr
4-2 2nd
Similarly, assign the Ferrule Rule (LEFT HAND SIDE) on the Left side of the following equipment:

8-0 d (
 Cabinet/Panel

4

- 0 ite
DCS Cabinet
 Field Device
 MCC
-24 Lim
The completed form should appear as below.
-04 ers
02 ine

Click Save to assign the new user defined

Ferrule Rules on Left side of all the selected
Equipment under the field Equipment Type.
te: ng
Da ing E
ult
ns
Co

The new user defined Ferrule Rule is displayed on the Ferrule Rules grid window.
ata
r: T
me
sto

Click the Close button to exit the form.

Cu

 For detailed information about Ferrule Rule Definition, please refer to Section 8.2 of AVEVA
Instrumentation – Wiring Manager User Guide.

Copyright © 2014. 116 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 9 – Setup Wiring Manager

ril)
Ap
Using the worked example above as a guide create the following setup:

1) Select and Import Project Cables

8th
Filter the Cable Catalogue and check the Allow Use check box for the below cables:

to
Class Catalogue No. Cores x Size
Instrument IEH184AA010 10Pr x 1.5mm²

il
Control 29008 30C+E x 16AWG

pr
Using the Excel spread sheet (Import Cable Catalogue.xls) import the cable catalogue from

A
the EXERCISE Worksheets:

4-2 2nd
 AVEVA004
 AVEVA005

8-0 d (
4
2) Create new Field Devices - 0 ite
-24 Lim
Create the following Field Devices in the Field Devices Catalogues.

a. Local Level Indication Display

-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

b. Transmitter with Ext Display

ata
r: T
me
sto
Cu

Copyright © 2014. 117 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

3) Create a Wiring Rule

ril)
a. Create a Wiring Rule between Local Level Indication Display and Transmitter

Ap
with Ext Display
Include the following SignalNumbers:

8th
Terminal 1: {TAG}+
Terminal 2: {TAG}-

il to
A pr
4-2 2nd
b. Create a Wiring Rule between Level Transmitter to JB

8-0 d (
Include the following Signal Numbers:

4
Terminal +: {TAG}+
Terminal -:
- 0 ite
{TAG}-
-24 Lim
-04 ers
02 ine
te: ng

4) Create a Ferrule Rule for the Right Hand Side

Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 118 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
5.7 Cable Drums (Worked Example)

Ap
AVEVA Instrumentation Wiring Manager allows the assignments of Cables to Cable drums. This feature
allows the defining of cable drums to any cable created in the application. The Cable Drum Schedule is
available to create, edit and view all project cable drums.

8th
To access the Cable Drum Schedule: Select Home > Select > Cable Drum Schedule (under Lists)

to
To create a cable drum definition Select New

il
Enter the following details in the Cable Drum Detail form.

A pr
Drum Number text box: ICD001

4-2 2nd
Drum Length text box: 500

8-0 d (
Drum Locked check box: Unchecked

4
- 0 ite Catalogue No combo box: Click the
command button, type IEH184AA010 in the filter
-24 Lim
for Catalogue No. and double click the record
on the Select a Cable from Catalogue window.

Click the Apply button.

-04 ers

Click the OK button to save the information and

02 ine

exit the Cable Drum Detail form.

te: ng
Da ing E
ult

The user will be able to assign a project cable to a specific drum.

ns


Co

Cable drums can also be created automatically, using the Auto-Cable Drum facility
ata
r: T
me
sto
Cu

Copyright © 2014. 119 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 10 – Setup Wiring Manager

ril)
Ap
Using the worked example above as a guide create the following Cable Drum:

8th
Drum Name: ICD002
Description: PVC, 1 Pr Cable
Catalogue No: IEF184AA001

to
Drum Length: 1000

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 120 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.8 Cable Block Diagrams

ril)
A Cable Block Diagram provides the user a pictorial view of the project's cabling for easier navigation and

Ap
visualisation for complex interconnections. The Cable Block Diagram within Wiring Manager allows full
interactive access to all underlying objects for editing purposes. For example, changing a cable type, length
or cable number is saved to the project cable schedule, editing terminations and equipment numbers,

8th
adding cables and equipment etc.

The Cable Block Diagram application includes auto-layout capabilities and allows printing to hard-copy and

to
also supports the ability to 'Export to AutoCAD' DWG format.

il
Users can view and edit Cable properties as if they were using Wiring Manager's Cable Schedule data grid,

pr
view and edit Equipment, including terminations as if they were using Wiring Manager's – Equipment View.

A
There are two types of Cable Block Diagram, Basic and Enhanced:

4-2 2nd
 Basic Cable Block Diagrams are constructed from a simple set of symbols supplied with the
product.
 Enhanced Cable Block Diagrams are constructed from user-defined symbols created for the

8-0 d (
project.

4
 The type is selected when a diagram is created.
- 0 ite
-24 Lim
User-defined symbols and diagram preferences must be setup before to start creating the Enhanced Cable
Block Diagrams.

To access the Cable Block Diagram application: Home > Select > Cable Block Diagrams (under Lists)
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata

The Cable Block Diagram list will open and a contextual tab Diagrams will appear and will have the focus.
r: T

5.8.1 Enhanced Cable Block Diagram Options

me

The user can view and edit the options for Enhanced Cable Block drawings generated by Instrumentation
Wiring Manager.
sto

To access the Enhanced Cable Block Diagram Options select the Enhanced Cable Block Diagram
Options option in the Diagrams tab.
Cu

The Options window with four tabs: Visualisation, Printing, Export and Grid Settings are displayed.
The visualisation preferences effect how basic cable block diagrams are drawn.

Copyright © 2014. 121 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Symbol Standard: This enables the
selection of a defined Symbol standard

Ap
type. It controls the library/palette loaded
each time an ECBD opened.

8th
Drawing Styles. If the Draw Orthogonal
checkbox is checked, cables will be
drawn at right angles (at 0 or 180 degrees

to
only). The Curved Bends checkbox
adds a small curve to all cable corners.

il
pr
Equipment Spacing controls the vertical
and horizontal spacings of automatically

A
added interconnections and layouts.

4-2 2nd
Cable No – Equipment Offset is the
distance between the labels of cables and
equipment.

8-0 d (
Assignment (Link) determines the

4
thickness of links between symbols that
- 0 ite have not been converted into cables
-24 Lim
-04 ers

Diagram Grid. This is where the grid and snap is set. Objects will snap to the grid height and width that is
set. Cell height and width can have different aspect ratios, for example, a height of 30 could be set and a
width of 90 could be set.
02 ine

Grid display and Snap are controlled from within

te: ng

the graphics application by selecting Show Grid to

display the grid, and Snap to Grid to have objects
Da ing E

snap to the grid when dragged around the

graphics application.
ult
ns
Co

Auto Add Interconnected Equip checkbox allows that all interconnected cables and equipment are
ata

automatically added when existing equipment is added. Field devices can be excluded if the Exclude Field
Device is checked.
r: T

Show Instrumentation Cables option is disabled in Instrumentation.

Show Electrical Cables controls whether or not cables created in AVEVA Electrical for the project can
me

added to the diagrams. This option is available if the project is shared with Electrical.
sto
Cu

Copyright © 2014. 122 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
Printing preferences are used to define
printing settings including Header and

8th
Footer text.

Change Default Paper Size from A4 to

to
A3 using the pull down list and change
the Default Orientation from Portrait to
Landscape.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
The Export tab is used to define Cable Block Diagram scaling settings for exports to AutoCAD. The default
scaling is suitable for metric AutoCAD drawings.
-04 ers
02 ine

Grid Settings Tab is used to control

which user-defined fields are displayed in
te: ng

the Cable Block Diagrams grid (if any)

and what they are to be called in the grid.
Da ing E

There are ten user-defined fields. By

default, none of them are displayed in
the Cable Block Diagrams grid. To add a
ult

user-defined field to the grid, uncheck its

Hidden checkbox. To remove a field
ns

from the grid, re-check the checkbox.

Co

Unchecked UserField1, UserField2 and

Userfield3. Type Other Document No
in the Userfield1 Caption field.
ata

The grid will look as shown below.

r: T
me
sto
Cu

Click the OK button to close the window and save the settings.

Copyright © 2014. 123 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.8.2 Enhanced Cable Block Diagram – User Defined Symbols

ril)
AVEVA Instrumentation is very flexible in the way that symbols can be employed in the application. AVEVA

Ap
Instrumentation Wiring Manager is supplied with an example set of symbols. Users can create their own
symbols using the symbol editor (limited), or AutoCAD *.dwg files can be imported from a folder containing
the users own symbol libraries.

8th
To access the user defined symbols, select: Project > Setup > User Defined Symbols.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

The User Defined Symbol List will open.

te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Using the scroll bars, and the Library Pull down list box, users will be able to see what is available in the
application for use.

Copyright © 2014. 124 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.8.2.1 Equipment Type Symbols

ril)
Ap
8th
The Equipment Type is selected from the toolbar menu Type.
This is done clicking on the down arrow, user can filter the
symbols by equipment type

il to
A pr
4-2 2nd
5.8.2.2 Import from another Project

Select Import symbols from other project on the tool

8-0 d (
bar. This will open the Select an AVEVA
Instrumentation Project… window.

4
- 0 ite
-24 Lim

Select the project to import the symbols from;

this will open the Symbol List From Other
-04 ers

Project Window.
02 ine
te: ng
Da ing E
ult
ns

Expand the window and check to see that

the Multi-Select check box is checked.
Co

The user can select the symbols for the

import. When finished selecting, press the
Import button.
ata

The selected symbols will be imported into

r: T

the current project.

me
sto
Cu

Copyright © 2014. 125 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
5.8.2.3 Create a New Symbol (Worked Example)

Ap
Select New from the tool bar, this will open the Enhanced Cable Block Diagram Symbol Detail window
(below).

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Name: This is the name of the symbol.

te: ng

Library: This is where the relevant library is selected or created. If a library is not available for selection
Da ing E

from the list, the user can create a standard by typing the name of the standard directly into the text box. It
will then be made available for selection the next time that the Enhanced Cable Block Diagram Symbol
Detail window is opened.
ult

Default Symbol: If this box is checked, the symbol will be the default symbol of that equipment type.
ns
Co

Object type: This is a pull down list of the equipment types

in AVEVA Instrumentation that are available to apply
symbols to.
ata
r: T
me

Type in or select the following:

sto

Name: Detector
Library: F&G
Cu

Object Type: Field Device

Default Symbol: Checked

Copyright © 2014. 126 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Select Open Symbol Editor, and the Symbol Editor will open. This

ril)
editor has basic graphic capabilities and can used when creating
simple symbols or adding simple detail to imported symbols.

Ap
To initiate the import process, press the Import from .dwg file button.
A Windows file open dialogue will appear, browse for the symbol,

8th
C:\AVEVA_InstrumentationTraining\CAD_Files\CBD
Files\Detector.dwg

to
Select Open and the selected symbol will appear in the Symbol
Editor.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim

Users can modify the symbol further if required using the basic
-04 ers

graphics tools provided.

When finished with the imported symbol, press the OK button

02 ine

to return to the Symbol Detail window.

te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 127 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The Enhanced Cable Block Diagram Symbol Detail window now displays the symbol that was imported.

ril)
Datalinks available to the Object type are displayed in the scrollable list to the left of the graphics area.

Ap
These are added to the symbol by selecting a datalink, and then dragging and positioning it in the graphics
area.

8th
Click the next to the Fields Datalinks. This reveals the Datalinks associated with the object.

Drag the datalinks TagNo and AreaNo onto the graphic area and position as shown in the next image:

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

Datalinks are shown with the table name are contained. For example: Area Fields.AreaNo.
Da ing E

 When inspected closely, it is noticeable that the symbol is enclosed by a grey shaded box. This
represents the limits of the symbol. The symbol can be dragged anywhere within the graphics area by
placing the mouse cursor within this grey box, holding down the left mouse button and dragging to a
new position. In this way, the symbol can be positioned so that datalinks can be positioned anywhere
ult

around the symbol.

ns

The red lines that are visible on the datalinks

represent the justification of the datalinks. The view
Co

above shows that the datalinks are left justified.

To change the justification of the datalinks, place the

ata

cursor over the datalink and then Right Click with

the mouse. A context menu will appear offering
r: T

some options: Selecting Anchor offers three

justifications for the datalinks. Click anywhere in the
graphics area to cancel.
me

The user can add dumb text to the data link. For
example the word ‘Area:’ can be added to the beginning
of the data link AreaNo.
sto

Right click on the datalink AreaNo select Edit Text and

Type [Area: ] as shown opposite.
Cu

Click anywhere in the graphics area to exit Edit Text

mode.

Copyright © 2014. 128 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

To change the font used for the datalink text, click Font. The Select Font window is then displayed:

ril)
Ap
Select the values

8th
according to the screen
on the left and click OK.

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
Change the Font values for the Instrument List Fields.TagNo and adjust the elements as shown below:
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T

Select OK to exit.

A Message informing that the Default Symbol for Field Device already exist. Select Yes to accept.
me

 Existing Symbols can also be copied and edited to create another symbol. In the User Defined
sto

Symbol List select the symbol with the left mouse button and then select Copy Selected from the tool
bar. This will open the Enhanced Cable Block Diagram Symbol Detail window where the symbol
can be defined as shown above.
Cu

Copyright © 2014. 129 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 11 – Symbols Creation

ril)
Ap
Using the symbol library provided on the electronic media supplied by the trainer, create the following
symbols listed below into AVEVA Instrumentation Wiring Manager:

8th
AutoCAD dwg Symbol View

il to
A pr
Horn.dwg

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

JunctionBox.dwg
te: ng
Da ing E
ult
ns
Co
ata
r: T

Panel.dwg
me
sto
Cu

Copyright © 2014. 130 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

5.8.2.4 Cable Label Symbols (Worked Example)

ril)
In the case of cables, the Enhanced Cable Block Diagram Symbol Detail window is used to define the labels

Ap
of cables only, by placing the required datalinks.

Select New from the tool bar to open the Enhanced Cable Block Diagram Symbol Detail window. Using

8th
the information described in the chapter above, create a new cable symbol using the information in the
screen below:

il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

When a box or any graphic is included as a cable label, the Default

Da ing E

Anchor option is available on the tool bar.

This option controls the position of connection between the cable and
its label.
ult
ns
Co
ata

Bottom Left representation.

r: T
me
sto

Bottom Middle representation.

If a cable label symbol has already been set as the one which will be used in diagrams, a message will be
Cu

displayed: To make the new cable label symbol the default for the diagrams click Yes.

Select OK to save the symbol and close the window..

Copyright © 2014. 131 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
This page is intentionally left blank.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 132 www.aveva.com

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

ril)
Ap
6 AVEVA Instrumentation Designer

8th
The AVEVA Instrumentation Designer module uses data created by other modules i.e. AVEVA
Instrumentation Engineer and AVEVA Instrumentation Wiring Manager to generate CAD drawing files
automatically from the AVEVA Instrumentation project database.

to
Generally, this is the last AVEVA Instrumentation module used by an Engineer/Designer during a project life

il
cycle as the AVEVA Instrumentation Engineer is used to create Instrument tags and assign tags to Loops

pr
and AVEVA Instrumentation Wiring Manager is used to create equipment, cables and wiring including
terminations.

A
The AVEVA Instrumentation Designer module cannot generate the deliverables (drawing files) without this

4-2 2nd
data from the other modules.

AVEVA Instrumentation Designer can be used to generate:

8-0 d (
 Loop Diagrams

4
 Termination Diagrams
 Installation Detail Drawings.
 Enhanced Cable Block Diagrams - 0 ite
-24 Lim
6.1 Starting AVEVA Instrumentation Designer
-04 ers

AVEVA Instrumentation Designer can be started from the windows desktop:

Start Menu > All Programs > AVEVA > Engineer > AVEVA Instrumentation 12.1.4 > Instrumentation
02 ine

Designer 12.1.SP4
te: ng
Da ing E

Select Project TM6101_01_XX (where XX are

the trainee’s initials).

Click Select
ult
ns
Co

The AVEVA Instrumentation Designer Application Window opens.

ata
r: T
me
sto
Cu

Copyright © 2014. 133 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.2 Options

ril)
The user can view and edit the options for drawings generated by Instrumentation Designer.

Ap
To access the project options: Select Project tab > Options.

8th
The Options window with five tabs: General, Revisions, Rev Clouds, Terminations and Enhanced Cable
Block Diagrams are displayed.

to
6.2.1 General

il
Keep the default settings on the tab and check the Cloud Changes check box only.

A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers

6.2.2 Revisions
02 ine

Select the Revisions tab and enter the following details into each field/caption:
te: ng

Field Name: Caption:

Da ing E

By Drw By

Checked Chk By
ult

Approved App By
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 134 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.2.3 Rev Clouds

ril)
Ap
8th
Select the Rev Clouds tab, and select
Yellow from the Color for Clouds

to
combo box while keeping the default
settings.

il
pr
 Templates must have any layer

A
referred already in the AutoCAD
file, i.e. REVCLOUDS.

4-2 2nd
 Changes to drawings are

8-0 d (
automatically highlighted using

4
revision clouds if the Cloud

- 0 ite Changes checkbox on the

General tab (see above) is
-24 Lim
checked.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 135 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.2.4 Terminations

ril)
Select the Terminations tab, Check the Use DwgNo. References for Wires box and change the Core

Ap
Length and Wire Length.

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

 The “Show Ferrule Numbers on Termination Diagrams” check-box allows to display the signal number
or ferrule number of cables and wires in Terminations Drawings. If ferrule data does not exist, the signal
number will be displayed irrespective of the check-box state.
ult

 The “Show Ferrule Numbers on Termination Diagram” check-box has been added to the Drawing
Information dialogue as well as to control the “Show Ferrule Number” state for individual AutoCAD
ns

drawings.
 The “Draw Looping Wire with Bend” check-box controls how looping wires are drawn on Termination
Co

diagrams. If the checkbox is checked, looping wires will be drawn with an extra bend.
 The “Show Intermediate Junction Box Connections on Termination Diagrams:” check-box allows the
ata

inclusion of any intermidate connected junction box on the Termination Diagram. This can also be
overridden on individual diagrams
 The “Cable Connector Gap (prevent overlap):” box is the horizontal distance that the software will
r: T

manage between 2 parallel cables while drawing terminations to prevent overlaps.

 The “Show Loop Diagram No” check-box displays the loop diagram numbers on Termination diagrams
me

if checked.
sto
Cu

Copyright © 2014. 136 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.2.5 Enhanced Cable Block Diagrams

ril)
Select the Enhanced Cable Block Diagrams tab and keep the default settings.

Ap
8th
 If the User Layers check box is

to
checked, the Equipment Layer and
Link(s)/Cable(s)/Cable Lable
Symbol(s) Layer text boxes become

il
available. Here the user is to enter

pr
the names of the layers that the
user would like to place equipment

A
items and cable data on.

4-2 2nd
 The layer options in this dialogue
will NOT create the layers, the
layers should already exist in the

8-0 d (
SEED file. When layers are

4
specified, the KOL/SLD drawings

- 0 ite
will adopt the colour properties of
that layer.
-24 Lim
-04 ers
02 ine

Click the OK button to save and exit the Options window.

te: ng

6.3 Project Setup

Da ing E

The Setup menu under the Project tab provides the user access to the project setup menu items in
Instrumentation Designer.
ult
ns

The user has the flexibility to

manipulate the Plant Areas, Area
Co

Types and Pick Lists even within the

Designer Module.
ata

 This training guide will NOT

r: T

explore all of the menu items

available from the Setup Menu.
For additional information please
me

refer to the AVEVA

Instrumentation Designer User
Guide.
sto
Cu

Copyright © 2014. 137 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.3.1 Drawing Titles (Worked Example)

ril)
AVEVA Instrumentation Designer will automatically populate the drawing title information Title1, Title2 and

Ap
Title3 in the Drawings grid list if the user sets; Loop Titles (Import Format), Termination Titles (Import
Format) and Enhanced Cable Block Diagram Titles (Import Format) dialogues using the project Setup
backstage menu.

8th
 Import is probably not a good name for this feature. Import in this context means that the selected

to
project information will be Imported into the drawing list title data in the Drawing list grid.

The following example uses the Loop Titles (Import Format):

il
A pr
4-2 2nd
8-0 d (
4
Select the Project > Setup > Loop
Titles (Import Format)
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult

This will open the Schematic Import

ns

Drawing Title Settings dialogue.

Co

Enter the following details on the Loop

ata

Import Drawing Title Settings form:

Title 1 combo box: INSTRUMENT LOOP

r: T

DIAGRAM
me

Title 2 combo box: {LoopNo} -

{LoopService1}
sto

Check the Update existing drawing Titles

on ‘Check’ for new drawings check box.
Cu

Click the Save button on the Loop Import

Drawing Title Settings form.

Copyright © 2014. 138 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 12 – Drawing Titles

ril)
Ap
Using the knowledge gained in 6.3.1 above, configure the drawing title according to the following window:

 Termination Import Drawing Title

8th
il to
A pr
4-2 2nd
 Enhanced Cable Block Diagram Import Drawing Title

8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng

 ECBD Diagram Number, Description and the user fields defined in AVEVA Instrumentation Wiring
Da ing E

Manager are available to be included in the drawing title.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 139 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.4 Termination Diagram Seeds

ril)
A Termination Diagram (Drawing) is used to show all field Instruments and their wiring details specific to an

Ap
equipment (Junction Box, Cabinet/Panel, etc.) within the project.

Termination diagrams are created automatically and use SEED drawings (Drawing Borders) to create them.

8th
A SEED drawing essentially is an empty AutoCAD drawing with a border and title block (drawing border with
attributes). These attributes will be linked to the project database using Datalinks.

to
The user can configure several different types of Seeds to display one row of terminals, three rows of
terminals etc.

il
pr
First, from the training supporting material, copy the AutoCAD drawing Termination_1TB.dwg to the
folder: C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds.

A
On the Home tab select Seeds. This will open the Seeds grid and a contextual action tab Seeds.

4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E

On the Seeds tab select New to open the Seed File Parameters.

Select the Ellipses button to the right of Seed File Name Box and browse for the seed file:
ult

C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds\Termination_1TB.dwg
ns

Complete the remainder of the form so that it matches the image below. When completed select OK.
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 140 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The Seed is now listed in the grid. Selecting Open on the Seeds tab will open the Seed drawing:

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Close and exit the Termination_1TB.dwg drawing.

te: ng

 Assigning and editing Datalinks of the Seed file is an Administrator Activity, but for this training it will be
Da ing E

cover in the AVEVA Instrumentation Designer Training Manual.

ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 141 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 13 – Generate a Termination Diagram:

ril)
Ap
Using the ‘A1’ size create a SEED file called Termination_3TB.dwg as shown below

8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 142 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.5 CBD Seeds

ril)
On the Home tab select CBD Seeds. This will open the CBD Seeds grid and a contextual action tab

Ap
Seeds.

First, from the training supporting material, copy the AutoCAD drawing ECBDA3.dwg to the folder:

8th
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds

il to
A pr
4-2 2nd
8-0 d (
4
On the Seeds tab select New. - 0 ite
Using the image below as a guide, complete the CBD Seed File
-24 Lim
Parameters.
-04 ers
02 ine
te: ng
Da ing E
ult
ns

 If the Scale to fit checkbox is selected, the enhanced cable block diagram contents (as defined in
Co

Wiring Manager) are to be scaled to fit within the extents of the seed drawing border.
ata

When finished, select OK. The seed file is added to the CBD Seeds list.

On the Seeds tab select Open. This will open the AutoCAD file.
r: T

Type in the Command window: LWDISPLAY and set ON as a value. After that, type in the Command
window LTSCALE and set 8.0 as a value.
me

 In order for line weights and dashed lines to be displayed correctly in the Enhanced Cable Block
sto

Drawings the LWDISPLAY command must be set to ON and the LTSCALE may need to be adjusted in
the CBD Seed.

Cu

AutoCAD Drawing Window Color must be White as well. Type in the Command window: OPTIONS,
select the Display tab and select Color: White in the Window Elements Colours… option.

Copyright © 2014. 143 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.6 Loop Templates

ril)
Loop Drawings are created using AutoCAD loop diagram templates. A Template is an AutoCAD drawing

Ap
that contains blocks with attributes attached. Instrumentation Designer uses Datalinks to establish a link
between a value in the AVEVA Instrumentation project database and a drawing block attribute and once a
drawing is generated by Instrumentation Designer the CAD attributes are automatically updated with the

8th
data from the Instrumentation project database.

Datalinks can be attached to data such as project name or description from Project data, or drawing name or

to
title from Drawing List or other engineering data from Instrumentation Engineer or wiring data from Wiring
Manager. Once these Datalinks are included on a drawing AVEVA Instrumentation will ensure that the

il
engineering data is always updated on the drawings and reflect the project database.

pr
First, from the training material issued at the beginning of this training session, copy the AutoCAD drawings

A
FL001.dwg and LV001.dwg to the folder:

4-2 2nd
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Templates\AI (where XX are
the trainee’s initials).

8-0 d (
Select Home > Select > Templates the templates grid is opened displaying a list of templates.

4
- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

This window lists all the drawing files in the project template folder. Times Used shows the number of
drawings in the Drawing list that use each template.
ata

 Assigning and editing Datalinks is an Administrator Activity, but for this training it will be cover in the
r: T

AVEVA Instrumentation Designer Training Manual.

me
sto
Cu

Copyright © 2014. 144 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

6.7 Hookup Drawings

ril)
Hookup Details define the requirements to correctly install an instrumentation and control component i.e. an

Ap
Instrument or Control valve. These details establish requirements for supporting an instrument and
mechanically connecting it with the process. The Hookup details refer to the actual physical requirements of
an installation; it may detail the very nuts and bolts needed and even show where the connection will be

8th
made on the piping, tank or vessel, and the relative position of the instrument to the process connection.

In AVEVA Instrumentation, Hookup drawings are created by assigning a pre-defined Hookup Template to

to
each project Hookup drawing. The Hookup Template is made up of two parts: An AutoCAD drawing that
contains the graphics representation of the installation detail and a Bill of Materials or Parts List that is

il
assigned from Instrumentation Designer Hookup parts catalogue.

pr
When the project Hookup Drawing is created AVEVA Instrumentation updates the Hookup Template

A
drawing with all parts and all tags assigned to the drawing. The Hookup Drawing List is the main Designer
Hookup module window for adding/editing and accessing Hookup drawings.

4-2 2nd
6.7.1 Hookup Item Catalogue (Worked Example)

8-0 d (
4
The first step in creating an Installation Detail Drawing is to create or import an Installation Detail Items

- 0 ite
catalogue. This catalogue contains items of equipment that will be used to create a Bill Of Materials (BOM)
or a Material Take Off list (MTO).
-24 Lim
On the Home tab select Hookup Items (under catalogues). This will open the catalogue.
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T

This grid can be populated manually or data can be imported from Excel.
me

Click the New button to add a new Hookup Item (manually).

sto
Cu

Copyright © 2014. 145 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

This opens a blank Hookup Item Detail form. Enter the details as below.

ril)
Ap
8th
Click the OK button to save the data and
exit the form.

to
The new item is now listed on the
Hookup Item Catalogue grid.

il
A pr
4-2 2nd
8-0 d (
4
- 0 ite
-24 Lim
-04 ers
02 ine

Select the Manage tab; on the Import pane select From Excel. In the browsing window that opens, browse
to the folder:
te: ng

C:\AVEVA_InstrumentationTraining\ExcelFiles\HookupItemCatalogue.xls. Select Open.

Da ing E

The Import Fields form opens.

ult

AVEVA Instrumentation Designer will

attempt to automatically map the first row
ns

of the Excel column headers to AVEVA

Instrumentation Field names if the names
Co

correspond to AVEVA Instrumentation

Field names.
ata

Select Import from the toolbar menu.

r: T
me

Select Batch Process all Records…

The Import Differences window opens, select

sto

Accept All > Save. The Import Log window opens

informing the user of how many records failed to
Cu

import, and how many records were imported

successfully.
Select Close

Copyright © 2014. 146 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

The Installation Detail Item Catalogue is populated and the grid is opened to display the contents.

ril)
Ap
8th
il to
A pr
4-2 2nd
 Ensure that the Excel columns names mapped for data import do not contain leading or trailing spaces.

8-0 d (
4
6.7.2 Hookup Catalogue
- 0 ite
The Hookup Catalogue contains a list of templates that can be assigned to produce Installation Detail
-24 Lim
Drawings.

Create the Hookup template drawings in AutoCAD and include attributed blocks. Instrumentation Designer
-04 ers

uses Datalinks to establish a link between a value in the AVEVA Instrumentation project database and a
drawing block attribute and when a drawing is generated by Instrumentation Designer the CAD attributes are
automatically updated with the data from the Instrumentation project database.
02 ine

Datalinks can be attached to data such as project name or description from Project data, or drawing name or
title from Drawing List. Once these Datalinks are included on a drawing, AVEVA Instrumentation will ensure
te: ng

that the engineering data is always updated on the drawings and reflect the project database.

First, from the training supporting material, copy the AutoCAD drawing CV001.dwg and PS001.dwg to the
Da ing E

folder:
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Templates\AI\Hookups

To access the Hookup Catalogues: Home > Select > Hookup (under Catalogues). The Hookup
ult

Catalogue grid opens:

ns
Co
ata
r: T
me
sto

 The Hookup Catalogue grid is empty when working with a fresh new project database.
Cu

Copyright © 2014. 147 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Select New from the Records pane on the Home tab, the Hookup Template Details is displayed.

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
- 0 ite
Enter the following details on the Hookup Template Details form:
-24 Lim
Category text box: Flow

Template text box: PS001

-04 ers

Remarks text box: Typical Hook Up

02 ine

Description text box: Orifice & D/P Transmitter – Long Mounting – Gas Service
te: ng

No. of Tags text box: 20

Da ing E

To add items on the Bill of Materials grid: click the New Item button on the form and the Find a
Component window is displayed.

Select union from the pull down list under the Description filter:
ult
ns
Co
ata
r: T
me

Double-click the record with Size 1/2" OD - 1/2" NPTM and Material SS 316L. Click the Close button to exit
the window.
sto
Cu

Copyright © 2014. 148 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

ril)
Ap
8th
il to
A pr
4-2 2nd
8-0 d (
4
Complete the list as shown below:

- 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co

Select OK.

An Installation Detail template has now been added to the Hookup Catalogue list.
ata

 The Administrator should apply the appropriate Datalinks to the template drawing attributes to map the
r: T

title block information, drawing revision history, tags assigned and bill of materials. For this training it
will be cover in the AVEVA Instrumentation Designer Training Manual.
me
sto
Cu

Copyright © 2014. 149 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)

Exercise 14 – Generate a Hookup Template

ril)
Ap
Using the Hookup template CV001.dwg provided, generate a Hookup Template with the following details:

8th
il to
A pr
4-2 2nd
8-0 d (
4
. - 0 ite
-24 Lim
-04 ers
02 ine
te: ng
Da ing E
ult
ns
Co
ata
r: T
me
sto
Cu

Copyright © 2014. 150 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.