TM-6101 AVEVA Instrumentation (12.1) Administration Rev 6.0 PDF

AVEVA Instrumentation
(12.1)
TRAINING GUIDE
Administration
TM-6101
www.aveva.com
AVEVA Instrumentation™ (12.1)
Instrumentation Administration (TM-6101)
Copyright © 2014. 2 www.aveva.com

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Revision Log
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
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
Training 12.1.SP3.Fix4
30/03/2016 6.0 FF/TG GO GC
Training 12.1.SP4
Updates
All headings containing updated or new material will be highlighted.
Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers please report it to the AVEVA
Group Solutions Centre at tps@aveva.com
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Visit our website at http://www.aveva.com
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar
losses; loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of
data or information; any special, indirect, consequential or pure economic loss, costs, damages,
charges or expenses which may be suffered by the user, including any loss suffered by the user
resulting from the inaccuracy or invalidity of any data created by the AVEVA software, irrespective of
whether such losses are suffered directly or indirectly, or arise in contract, tort (including negligence)
or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with
the performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year
in which the user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall
take precedence.

Copyright Notice
All intellectual property rights, including but not limited to, copyright in this Training Guide and the associated
documentation belongs to or is licensed to AVEVA Solutions Limited or its affiliates.
All rights are reserved to AVEVA Solutions Limited and its affiliates companies. The information contained in
this Training Guide and associated documentation is commercially sensitive, and shall not be adapted,
copied, reproduced, stored in a retrieval system, or transmitted in any form or medium by any means
(including photocopying or electronic means) without the prior written permission of AVEVA Solutions
Limited. Where such permission is granted, AVEVA Solutions Limited expressly requires that the Disclaimer
included in this Training Guide and this Copyright notice is prominently displayed at the beginning of every
copy that is made.
Licenses issued by the Copyright Licensing Agency or any other reproduction rights organisation do not
apply. If any unauthorised acts are carried out in relation to this copyright work, a civil claim for damages
may be made and or criminal prosecution may result.
AVEVA Solutions Limited and its affiliate companies shall not be liable for any breach or infringement of a
third party's intellectual property rights arising from the use of this Training Guide and associated
documentation.
@AVEVA Solutions Limited 2016
Trademark Notice
AVEVA™, AVEVA Instrumentation™, Tribon and all AVEVA product and service names are trademarks of
AVEVA Group plc or its subsidiaries.
Use of these trademarks, product and service names belonging to AVEVA Group plc or its subsidiaries is
strictly forbidden, without the prior written permission of AVEVA Group plc or AVEVA Solutions Limited. Any
unauthorised use may result in a legal claim being made against you.
Fluent is a trade mark of Microsoft Corporation. The Fluent user interface is licensed from Microsoft
Corporation by AVEVA and use of the Fluent trademark is strictly forbidden.
All other trademarks belong to their respective owners and cannot be used without the permission of the
owner.

Contents
1 Introduction .............................................................................................................................................. 7
1.1 Aim..................................................................................................................................................... 7
1.2 Objectives ......................................................................................................................................... 7
1.3 Prerequisites .................................................................................................................................... 7
1.4 Course Structure .............................................................................................................................. 8
1.5 Using this guide ............................................................................................................................... 8
2 AVEVA Instrumentation Training Workflow .......................................................................................... 9
2.1 AVEVA Instrumentation Administration Training Guide Workflow .......................................... 10
2.2 AVEVA Instrumentation Engineer Training Guide Workflow .................................................... 11
2.3 AVEVA Instrumentation Wiring Manager Training Guide Workflow ........................................ 11
2.4 AVEVA Instrumentation Designer Training Guide Workflow .................................................... 11
2.5 AVEVA Instrumentation Process Engineer Training Guide Workflow ..................................... 11
3 AVEVA Instrumentation Security Manager ......................................................................................... 13
3.1 Create a New Project ..................................................................................................................... 13
3.2 Enable Security Settings ............................................................................................................... 19
3.3 Groups and Users .......................................................................................................................... 20
3.3.1 Add a New Group ..................................................................................................................... 21
3.3.2 Edit Groups .............................................................................................................................. 21
3.4 Authentication Type....................................................................................................................... 22
3.4.1 Windows Authentication Type .................................................................................................. 23
3.4.2 AVEVA Project Authentication Type ........................................................................................ 25
3.5 Objects ............................................................................................................................................ 27
3.5.1 Applying Group Access Types to Objects ................................................................................ 28
3.6 Area Access Control ...................................................................................................................... 29
3.7 Options ............................................................................................................................................ 31
3.7.1 Create a New Project ............................................................................................................... 31
3.7.2 Package Project ....................................................................................................................... 31
3.7.3 Create SQL Server Project from Backup ................................................................................. 34
3.7.4 Edit Projects ............................................................................................................................. 36
3.7.5 Unlock Excel Import ................................................................................................................. 38
3.7.6 Add New User to SQL Server Project ...................................................................................... 39
3.7.7 Import Security Settings ........................................................................................................... 40
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
Exercise 1 – Create Plant Area Type ........................................................................................................... 46
4.2.2 Plant Areas (Worked Example) ................................................................................................ 47
Exercise 2 – Create Plant Areas ................................................................................................................... 48
4.2.3 Pick Lists (Worked Example) ................................................................................................... 49
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
Exercise 3 – Class Definition and Assigning Tag Formats ....................................................................... 59
4.2.7 Instrument Type Catalogue (Worked Example) ....................................................................... 60
Exercise 4 – Instrument Type Catalogue .................................................................................................... 63
4.2.8 Loop Type Catalogue (Worked Example) ................................................................................ 64
4.2.9 Process Units ........................................................................................................................... 67
4.2.10 Project Voltages ....................................................................................................................... 68
Exercise 5 – Create Project Voltages .......................................................................................................... 69
4.2.11 Property Definitions (Worked Example) ................................................................................... 70
4.3 Options ............................................................................................................................................ 72
4.4 Instruments Catalogue (Worked Example) ................................................................................. 74
4.5 Datasheet Catalogue...................................................................................................................... 76
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

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

4.5.4 Auto Create Properties (Worked Example) .............................................................................. 84
4.5.5 Auto Create Mappings for Multiple Tags (Worked Example) ................................................... 86
Exercise 7 – Copy Mappings ........................................................................................................................ 90
4.5.6 Export Datasheets to Pre-defined Folder ................................................................................. 93
5 AVEVA Instrumentation Wiring Manager ............................................................................................ 95
5.1 Starting AVEVA Instrumentation Wiring Manager ...................................................................... 95
5.2 Options (Worked Example) ........................................................................................................... 96
5.3 Cable Catalogue ............................................................................................................................. 97
5.3.1 Add Cable to the Catalogue (Worked Example) ...................................................................... 97
5.3.2 Select Cables (Worked Example) ............................................................................................ 98
Exercise 8 – Cable Catalogue ....................................................................................................................... 99
5.3.3 Import Cables into the Catalogue ........................................................................................... 100
5.4 Field Devices ................................................................................................................................ 103
5.4.1 Add a Field Device (Worked Example) .................................................................................. 104
5.5 Major Equipment Catalogue (Worked Example) ....................................................................... 105
5.6 Setup ............................................................................................................................................. 109
5.6.1 Wiring Rules ........................................................................................................................... 109
5.6.2 Ferrule Rules .......................................................................................................................... 115
Exercise 9 – Setup Wiring Manager ........................................................................................................... 117
5.7 Cable Drums (Worked Example) ................................................................................................ 119
Exercise 10 – Setup Wiring Manager ......................................................................................................... 120
5.8 Cable Block Diagrams ................................................................................................................. 121
5.8.1 Enhanced Cable Block Diagram Options ............................................................................... 121
5.8.2 Enhanced Cable Block Diagram – User Defined Symbols .................................................... 124
Exercise 11 – Symbols Creation ................................................................................................................ 130
6 AVEVA Instrumentation Designer ...................................................................................................... 133
6.1 Starting AVEVA Instrumentation Designer ............................................................................... 133
6.2 Options .......................................................................................................................................... 134
6.2.1 General ................................................................................................................................... 134
6.2.2 Revisions ................................................................................................................................ 134
6.2.3 Rev Clouds ............................................................................................................................. 135
6.2.4 Terminations ........................................................................................................................... 136
6.2.5 Enhanced Cable Block Diagrams .......................................................................................... 137
6.3 Project Setup ................................................................................................................................ 137
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
6.5 CBD Seeds .................................................................................................................................... 143
6.6 Loop Templates ............................................................................................................................ 144
6.7 Hookup Drawings......................................................................................................................... 145
6.7.1 Hookup Item Catalogue (Worked Example) .......................................................................... 145
6.7.2 Hookup Catalogue.................................................................................................................. 147
Exercise 14 – Generate a Hookup Template ............................................................................................. 150

CHAPTER 1
1 Introduction
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
project.
1.1 Aim
This guide aims to be a source of the administrative knowledge necessary for the administration of an
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
project. The contents of this guide can also be referenced during maintenance activities.
1.2 Objectives
At the end of this training course, the administrator(s) will be able to:
 Create and setup an AVEVA Instrumentation Project.
 Define access and security rights.
 Create equipment catalogues
 Create customized Datasheet templates, drawing templates and seeds.
1.3 Prerequisites
The following are some basic prerequisites for Trainees attending the Training Course in AVEVA
Instrumentation 12.1:
 Familiar with Instrumentation and Process engineering data.
 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.
 Refer the AVEVA Instrumentation Installation User Guide for the system requirements both
hardware and software.
AVEVA Instrumentation has been installed on the Trainee’s computers that they will be using for the duration
of this training course.
Microsoft Office 2007, 2010, 2013 and 365 (Excel) has been installed on the Trainee’s computers that they
will be using for the duration of this training course.
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.
The name of the instance of Microsoft SQL Server that the Trainee has access to must be known to each
Trainee.
AutoCAD 2014, 2015 or 2016 is a prerequisite for this training course.

 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
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
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.
 For any details about the hardware and software requirement and assistance with SQL Server
installation please refer to the AVEVA Instrumentation Installation guide.
1.4 Course Structure
Training will consist of oral and visual presentations, demonstrations and set exercises. Each workstation will
have a training project and supporting material. These will be used by the trainees to practice their methods,
and complete the set exercises.
1.5 Using this guide
Certain text styles are used to indicate special situations throughout this document, here is a summary;
Menu pull downs and button press actions are indicated by bold dark turquoise text.
Information the trainee has to key-in will be in bold, red text.
Annotation for trainees benefit:

 Additional information
 Refer to other documentation
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.

CHAPTER 2
2 AVEVA Instrumentation Training Workflow
The AVEVA Instrumentation product suite consists of five modules:

 AVEVA Instrumentation Engineer
 AVEVA Instrumentation Process Engineer
 AVEVA Instrumentation Wiring Manager
 AVEVA Instrumentation Designer
 AVEVA Instrumentation Security Manager
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
using AVEVA Instrumentation.
AVEVA Instrumentation (12.1) training has been designed to be presented to four different groups and
follows the workflow shown below:
 AVEVA Instrumentation Administration (TM-6101): Project Administrators
 AVEVA Instrumentation Engineer (TM-6102): Instrumentation Engineers
 AVEVA Instrumentation Wiring Manager (TM-6103): Instrumentation Designers
 AVEVA Instrumentation Designer (TM-6104): Instrumentation Designers and CAD operators
 AVEVA Instrumentation Process Engineer (TM-6106): Process Engineers
 The AVEVA Instrumentation Process Engineer Training can be run after AVEVA Instrumentation
Administrator Training if it is required.
 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
main training project.
The Trainee is recommended to refer the flowchart while working through the Training Manual(s).

2.1 AVEVA Instrumentation Administration Training Guide Workflow

2.2 AVEVA Instrumentation Engineer Training Guide Workflow
2.3 AVEVA Instrumentation Wiring Manager Training Guide Workflow
2.4 AVEVA Instrumentation Designer Training Guide Workflow
2.5 AVEVA Instrumentation Process Engineer Training Guide Workflow

This page is intentionally left blank.

CHAPTER 3
3 AVEVA Instrumentation Security Manager
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.
3.1 Create a New Project
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
Manager Module.
AVEVA Instrumentation Security Manager

can be started from the start menu:
Start Menu > All Programs > AVEVA >

Engineer > AVEVA Instrumentation 12.1.4
> Instrumentation Security Manager
12.1.SP4.
Or, AVEVA Instrumentation Security

Manager can be started from the AVEVA
Instrumentation 12.1.4 Icon on the
desktop.
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

When AVEVA Instrumentation is first initiated after an installation then the user will be presented with this
Browse for Folder Window to select a folder for Project Workgroup.
If this window does appear then browse to or make

new folders to create the folder:
C:\AVEVA_InstrumentationTraining\Projects
And then select it and then pick OK.
 AvevaInstProjects.mdb a Microsoft Access

database file will be saved to that location. The
AvevaInstProjects.mdb file holds the list of all
of the projects created using AVEVA
Instrumentation; this list is displayed in the
Select an AVEVA Instrumentation Project list
window.
 inst.ini is a pointer that AVEVA Instrumentation looks at to display the AvevaInstProjects.mdb list of
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
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.
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
Create a New AVEVA Instrumentation
Project… form (below) will be displayed.
If an existing project does not already exist,

then the Create a New AVEVA
Instrumentation Project… form will be
displayed as the AVEVA Instrumentation
Security Manager module is started using
any one of the methods described above
(an image of this form is given below).

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:
C:\AVEVA_InstrumentationTraining\Projects
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
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
Project changes to File Locations/Folders.
Click the Yes button to continue.

The remaining folder location text boxes are now populated with the correct project folder paths:
Type: TM6101_01_XX (where XX are the initials of the user) into the Project Name or No: text box.
As soon as the focus is moved away from the Project Name or No: text box, the project name is added to
the project folder path in the Project folder: text box.
To the right of the SQL Server Name:

text box is a button. Select it.
When selected, a login window will

open.

The instance of the SQL Server that

the user will login to is to be typed
into the text box. (What is shown here
is the writers instance; the users will
be different).
It is advisable to test the connection

by pressing the Test Connection
Button.
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.
Copy options:
 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.
 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.
Project setting and data are copied from the packaged project.
Continue to populate the form with the following data:
Check “Empty Project”. Do not check “Share with Electrical”.
Project Description text box: My 1st AVEVA Instrumentation Project
Plant Name text box: My Plant
Plant Location text box: My Location
Client Name text box: AVEVA Solutions Ltd
Client Project No text box: TM6101
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
folders location.
Check that project path is correct: C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX (where

XX are the trainee’s initials), select Yes.
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).
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.
 A project database once shared between AVEVA Instrumentation and AVEVA Electrical cannot be
unshared later during the course of the project.

The form will look similar to the following:
Select Save.
AVEVA Instrumentation will then build the database for the project:
When complete, an alert form appears informing the administrator(s) that the project was created
successfully:
Select OK

The Project Selection Form containing the

New Project is Displayed, Select Project
TM6101_01_XX (where XX are the trainee’s
initials), and click Select
The Login form appears. Type Password into the Password

text box and then select Login.
The AVEVA Instrumentation Security Manager Module opens.
3.2 Enable Security Settings
To enable Security Manager on the current project, click Settings in the left-hand pane and then check the
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.
Once the Security Manager Security is enabled, the Grid Locks check box becomes available. Once
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
 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.

3.3 Groups and Users
AVEVA Instrumentation Security Manager has four default groups pre-created to cover the common user
types on any project:
 Everyone
 Process Engineers
 Instrument Engineers
 Instrument Designers.
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.
 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.
All Security Manager SQL Server seed databases have a single default user named Administrator. To
open the user list, select Users in the left hand tree view
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
assign the Everyone group (read only) to them. The Project Administrator will then use Security Manager
to apply additional access permissions.
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.

3.3.1 Add a New Group
To add a new group select Groups from the left hand tree view, the group window is displayed (see image
above). Click the Add Group button from the tool bar menu.
The Group window is displayed.
In the Name: text box type Technicians and in the

Description text box, type O&M Personnel.
Click the Save button.
The new group is added to the list on the right hand side.
3.3.2 Edit Groups
The descriptions against Instrument Engineers will be edited to give a clearer description.
Open the groups list by selecting Groups from the left hand tree
window. Double click on the group Instrument Engineers
Enter Instrument Design Engineers in the Description: text

box and click the Save button.

3.4 Authentication Type
The authentication type for a project controls how user access to project modules is validated. Three
authentication types are available:
 Windows Authentication
 SQL Server Authentication
 AVEVA Project Authentication
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.
 The user login on the SQL Server must have a ‘sysadmin’ role in order to change the authentication
type.
To open the Authentication Type window, select Project > Authentication Type.
Then Select the required type.
 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.

3.4.1 Windows Authentication Type
By enabling this authentication type within Security Manager, project administrators can add Windows users
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
proceed to add the users and define the right access.
3.4.1.1 Add a New User
To add a new user, select Users in the left hand tree view and click the Add User button on the toolbar
menu.
The User form will be displayed. To add a new user, click the ellipsis button on the right of the User Name:
text box.
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
typed in or selected from a drop down list box.
The user name is then typed in or selected from the

pull down list box, and click the Save button on the
form.

The User form is displayed again. The Administrator can now complete the form giving additional details.
This new user can now be assigned as an Is Read Only or Administrator.
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.
Double click the group Technicians available under

Not Member of Group section.
A Pseudo user is now assigned to the group

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

group name in the Member Of Group list
Click the OK button.
The new user is now listed on the Users grid.

3.4.2 AVEVA Project Authentication Type
By enabling this authentication type within Security Manager, project administrators can define project
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
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
password is required for this user.
Therefore, when the AVEVA Project Authentication type is

selected, the Create AVEVA Project Authentication User
window is displayed.
If a password was previously specified for the IDOAdmin

user, the Verify AVEVA Project Authentication Password
window is displayed instead.
The AVEVA Project Authentication Password can be modified selecting Tools > AVEVA Project
Authentication > Change Password.
Enter the current password, the new password, and the new
password again to confirm it in the fields provided in the
Change Password.
 The user login on the SQL Server must have a ‘sysadmin’ role in order to change the Project
authentication password.

3.4.2.1 Add a New User
To add a new user, select Users and click the Add User button on the toolbar menu.
The User form will be displayed.
The User Name and Password can be defined in the

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

the user from editing any data in all application
modules.
Marking the user as Is Administrator enables the

user to run Security Manager as an Administrator.
Every Administrator must have a Password. The
Password field is enabled if Is Administrator option
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.
Select the OK button to save the user.

3.5 Objects
Objects enable the Project Administrator to set access rights to predefined Objects in AVEVA
Instrumentation using the Security Manager.
Access rights (Access Types) available are:

 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.
 No Access Prevents the user from viewing the object.
 Process Data Controls read-write access to Process Data.
 No Create Prevents the user from creating instruments or loops
Top level Objects (Designer, Engineer, Wiring Manager and Process Engineer) are the AVEVA
Instrumentation Modules and Common Items are Objects that are common to all three Modules:
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.

3.5.1 Applying Group Access Types to Objects
To apply Group Access Type, expand the top level object (Engineer) and select the Object. The image
below shows the Datasheet object under the Engineer top level Object:
When an object is selected the permissions window opens and displays the current Groups defined in the
database and permissions assigned.
To add a group to the Permission Group, double click on the group.
In the example above, the Technicians group was added to the Permission Group. The Access Type can
be assigned by picking from a drop down list. Here, a Read Only Access Type is being assigned to the
Technicians group.
 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
Access Type applied to them.
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.

3.6 Area Access Control
Area Access Control enables the Project Administrator to set access rights to project plant areas in AVEVA
Instrumentation.
Access rights (Access Types) available are:

 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
delete it; and create reports that include the object data.
 Read Only (Allow Connections): The user is only permitted to view object data, create reports
and make connections to objects in the area.
 No Access: Prevents the user from viewing the objects in the area, including disabling of editing
and reporting.
Click on the Areas node will populate all the plant areas and sub-areas:
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.

In the example above, the Instrument Engineers group was added to the Permission Group. The Access
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’.
To Save the Access Type, click any sub area. A message will be displayed:
Select Yes to apply the same Access Type to the Child Areas.
 By default all the Areas have the group Everyone with Full Access.
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.

3.7 Options
On the menu bar of the AVEVA Instrumentation Security Manager Module, there are options to run
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.
 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.
3.7.1 Create a New Project
Select Project > Create a New Project. It will open the Create a New AVEVA Instrumentation Project
form. The process is the same as above in section 3.1.
3.7.2 Package Project
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.
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-
over, copying projects and creating new projects from template or seed projects.
Select Project > Package Project.

The Project Packager window is displayed:
Select the location that the package file is to be saved to by clicking the ... button. Enter the file name in the
File Name field and click Save.
Select the location that the package file is to be saved to by clicking the ... button. Enter the file name in the
File Name field and the selected location and file name are then displayed in the Project Packager window:
Click OK to start packaging the project. The process of the packaging is then displayed in the window:

Select OK to close the Project Packager window.
 Packaging a project requires certain SQL Server Management Objects (SMO) to be installed and
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
Instrumentation Security Manager User Guide.

3.7.3 Create SQL Server Project from Backup
Projects can be restored from SQL Server database backups from within AVEVA Instrumentation Security
Manager. Select Project > Create a Project from Backup.
The Restore Wizard window is displayed:
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
Browse button to open the Select Backup File
window. Select the Backup file and click the Open
button on the Select Backup File window.
Once the file is entered or selected, click the Next

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

The administrator must specify the Server Name

and the name to be given to the database created
from the restored SQL backup. The name of the
database is entered in the Database Name: text
box.
 If the administrator selected Use SQL Server Authentication then the User Name and Password text
boxes will be available.
 If windows authentication is used, then the user that is logged onto the machine must be and
Administrator on the SQL Server.
Click the Next > button on the Restore Wizard and this will open the Restore the database files as
window:
Here the administrator enters or browses for the Data File

Path and the Log File Path.
 If the path is the same for both fields, the administrator

can populate the Data File path text box and the Log
File path text box will be populated automatically.
Click the Finish button on the Restore Wizard form.
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
Restore Wizard.
A message is displayed in the bottom left corner of the wizard: Restore

Finished. Click the Close button to exit the Restore Wizard.
 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
drives.

3.7.4 Edit Projects
This option gives the administrator access to remove or add project listings to the Select an AVEVA
Instrumentation Project window. This utility does not delete or add databases from/to the SQL Server.
Select Project > Edit Projects.
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
keyboard.
A Delete Row alert form is displayed. Click the Yes button if the
administrator would like to delete the project listing.
To Edit the contents of a project listing, the administrator clicks into the cell that requires editing with the left
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.
To Add a project listing to the projects list, the administrator must click inside the text box: Click here to
add a new
The text disappears, the star to the left is displayed with a flag attached, and blinking cursor appears where
the text was.

If the administrator types the data into the cells as required and then presses Enter key on the keyboard the
Projects view will look as below:
When the administrator has finished adding/editing the Project listing, the administrator must click the Close
button.
Click the Yes button on the Save alert form.
 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.

3.7.5 Unlock Excel Import
To prevent duplicated records been created in the database, simultaneous importing of data from Excel by
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.
Select Project > Unlock Excel Import.
The current import sessions are listed:
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.

3.7.6 Add New User to SQL Server Project
Select Project > Add New User To SQL Server Project. This opens the SQL Server Login dialogue box.
Enter the instance of the SQL Server in the Server Name text box and click the Test Connection to test the
connectivity.
Click the OK button on the

AVEVA Instrumentation alert
form.
Click the OK button on the SQL Server Login dialogue box and this opens the Add User to SQL Server
Project(s) form:
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
the alert form.

3.7.7 Import Security Settings
This option can be found on the Tools menu. Select Tools > Import Security Settings.
Selecting this option will bring up an Import alert box advising the administrator that importing settings from
another project will overwrite the current settings.
It is up to the administrator(s) to decide whether to change the security settings or not for the current project.

3.7.8 Change Administrator Password
Start AVEVA Instrumentation Security Manager, select Users and double click on Administrator in the
UserName Column.
This will open the User form:
Enter a new password and click the OK button to display

the Password Confirmation window.
The administrator must re-enter the password to confirm the

new password if the passwords do not match. The
administrator is informed:
If the passwords do match, the confirmation window closes, the

User form closes and the administrator is returned to the Users
list.


CHAPTER 4
4 AVEVA Instrumentation Engineer
4.1 Starting AVEVA Instrumentation Engineer
AVEVA Instrumentation Engineer can be started from the windows desktop:
Start Menu > All Programs > AVEVA > Engineer > AVEVA Instrumentation 12.1.4 > Instrumentation
Engineer 12.1.SP4.
Select Project TM6101_01_XX (where XX are

the trainee’s initials).
Click Select
The AVEVA Instrumentation Engineer Application Window opens.
 AVEVA Instrumentation Engineer can also be started by double clicking on the Plant Engineer icon on
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,
please consult the AVEVA Instrumentation Engineer user guide.

4.2 Project Setup
Regional standards/requirements and Company/Corporate standards are all set using the Setup menu
which can be accessed via the Projects Tab:
Selecting the Project Tab will open the AVEVA Instrumentation Engineer Backstage Menu.
Selecting Setup will give the administrator(s) access to the project setup menu items:
 This training guide will NOT explore all of the menu items available from the Setup Menu. For
additional information please refer to the AVEVA Instrumentation Engineer user guide.

4.2.1 Plant Area Types
Select the Project tab and under the Setup option select Add/Edit Plant Area Types.
This opens the Area Types window: When first opened on a project, the grid will list the default area type
AREA:
Selecting the New or Edit button will open the following dialogue boxes:
New Selected Edit Selected

Four check boxes are present on the form:
 Path Delimiter: Area can will contain characters or text between Area Path.
 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.
 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.
Select OK when editing or creating an Area Type and then select Close to close the Area Type Form.
 For detailed information about Area Types, please refer to Section 5.1 of the AVEVA Instrumentation –
Common Functionality User Guide.

Exercise 1 – Create Plant Area Type
Using the information in 4.2.1 above, create new Area Types:
 Plant Code
 System Code
When completed, select Close.

4.2.2 Plant Areas (Worked Example)
All objects in AVEVA Instrumentation are based on Area; therefore the next task the administrator will
perform is to add an Area(s) to the project database.
Select Project > Setup > Add/Edit Plant Areas to open the Areas grid window.
To create a new area, click the New button, this will open the Area Information dialogue box:
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
display a list of Area Types available to the
project:
For example:
AREA: 10
AREA Type: Plant Code
Description: TRAINING
Short Description: TRN
When finished select OK
Select Close to close the form.
 For detailed information on Areas, please refer to Section 5 of the AVEVA Instrumentation Common
Functionality User Guide.

Exercise 2 – Create Plant Areas
Using the information described in the chapter above, create new areas using the information in the table
below:
 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
session.
 Descriptions and short descriptions are not required for this exercise, so if desired, the administrator
can omit filling in those details.
Area No. Area Type Parent Area Description Short Description

A01 System Code 10 STABILIZER UNIT SU-1
A02 System Code 10 BUILDINGS BLD
A03 System Code 10 PROCESS AREA PA
A04 System Code 10 FIRE & GAS F&G
When completed, select Close.

4.2.3 Pick Lists (Worked Example)
AVEVA Instrumentation supports associating a field with a Pick list, which provides flexibility to the user by
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)
window.
To create a new Pick List: Click the New button and a PickList Details form is displayed.
Enter the following details on the form:
PickList Name text box: Loop Function
DataType combo box: Text
Ignore the Locked check box and click the Save button.
 Checking the Locked checkbox will prevent

users from typing a value into the given
field.
The new Pick List (Loop Function) will appear on

the Pick List (All) form under Pick List Name.
Click the command button next to the new

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

The Pick List (Loop Function) form opens: Click Add

Item to enter values (items) into the Pick List.
Enter the following values:
FG Fire & Gas

A Analysis
F Flow
L Level
P Pressure
Q Quantity
T Temperature
 Clicking the Add Item button several times will produce multiple blank rows. Select the top row, enter a
value and then select enter. This will move the administrator to the next row to enter an additional
value. Descriptions are optional.
Select Save to save the list of values and then Close to close the Pick List (All) window.
Pick lists can assigned to cells in Datasheet Templates, Property Definitions and Tag Codes.
4.2.4 Tag Formats (Worked Example)
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
create their own customized Tag formants for both Instruments & Loops.
To access the Tag Formats: Select Project > Setup > Tag Formats
Four options are available on the form: New, Edit, Delete and Format for, pull down list for selecting
between Instrument and Loop tag formats.
 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.

4.2.4.1 Tag Format for Instruments
To add a New Instrument Tag Format, click New to display the Tag Format form:
Complete the form as shown here to

the left.
To add a Tag Code to use in the tag

forma, click in the Click here to… text
box:
Selecting the down arrow will present a pick list

of available fields to use in the tag format.
Select Apply:
The administrator can add additional fields, or

create additional fields by selecting the Tag
Codes button at the bottom of the form.

To add additional Tag

Codes to the available list,
place a check mark in the
Select check box against
the code that you want to
use. To add additional
fields to the list select New
In the Add New Tag Code form enter details

as shown to the right:
Click OK
The newly created Tag Code is added to the

list and a check mark is automatically placed
against it.
Close the Select Tag Codes for Instruments

form.
Add another Tag Code and select LoopFunc

previously created.
Complete the form as shown on the left.
Select OK and the close the Tag Format

form.

 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
The pick list Loop Function that was created earlier is going to be used for the LoopFunc Code Tag part
of the Instrument Tag Format.
 Pick Lists can be assigned directly to fields in the grids via the Grid Manager dialogue.
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:
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.

Select the Fields tab. And then filter for the field
LoopFunc that was created earlier.
Place a check mark in the check box in the column Select, and then using the pick list in the PickList
column; select the pick list Loop Function that was created earlier.
Select Save and then Close.
4.2.4.3 Tag Format for Loops
Select Tag Formats from project setup and change the option from Instrument to Loop on the Format for:
combo box.
Similarly, click the New button and enter details on Tag Format form to create a new Tag format for process
Loops.

The completed form should appear as below:
Select OK and the close the Tag Format

form.
Tag Formats form should show the newly inserted format as shown.

4.2.5 Assigning Tag Formats (Worked Example)
Tag formats are assigned to Instruments and Loops Class Definitions. Different tag formats can be
assigned to different class definitions.
To open the Class Definitions select Project > Setup > Class Definitions.
Select the class INS and then Assign Tag Format
The Instruments Tag Formats window opens. There are two check box columns: Assign and Primary.
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.
Clear the existing check marks, first assign the tag format ISA (delimiters) and then make the ISA
(delimiters) tag format the Primary.
Click Save.

In Class Definitions view, change the option from Instruments to Loops on the Format for: combo box.
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.
Click Save and close the Class Definitions window.

4.2.6 Class Definitions (Worked Example)
The administrator can create new classes or delete the existing ones if not required to classify the object
types (Instruments and Loops). Select Project > Setup > Class Definitions:
Select New.
In the Class Details form enter details as

shown to the left.
Click OK.
Clicking the OK button will add the class to the list of Instruments Classes.
 Classes can also be imported and exported via Excel to enable exchange between projects. Please
refer to the AVEVA Instrumentation Engineer user guide.

Exercise 3 – Class Definition and Assigning Tag Formats
Using the information in above:
 Assign the tag format instrument F&G Format previously created to the instrument F&G class.
 Create a new class F&G Loops for Loops and assign to it the Fire & Gas Format tag format
previously created.

4.2.7 Instrument Type Catalogue (Worked Example)
An “Instrument type” consists of the association of an instrument function with a class. Select Project >
Setup > Type Catalogue:
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:
To create a new instrument type, select the Class

Name and the Class Description is completed
automatically. Enter the instrument Function and
its description. Finally, select the I/O Type,
Location, Wiring Rule and Operating Principle.

On the right hand side of the I/O Type, Location and Operating Principle lists are buttons with an arrow
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.
For example:
Class Name: INS
Function: ZSH
Description: Valve Open Position Indication
System: DCS
I/O Type: DI
Location: FLD
Wiring Rule: 2 Wire Switch (NO) to JB
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.
Click Add Item then type Limit

Switch into the box that appears
below PickList Value column.
Press the Save button. Now the Principle Limit Switch appears in the pick list.

Select Operating Principle: Limit Switch
And then click OK
 The administrator may Import and Export the Instrument Type Catalogue using Excel through the
options available on the menu.

Exercise 4 – Instrument Type Catalogue
Using the information above, add the following instrument types listed below:
Class Name: F&G
Function: FD
Description: Flame Detector
System: DCS
I/O Type: AI
Location: FLD
Wiring Rule: 2 Wire Tx To JB
Operation Principle: F&G
Class Name: F&G
Function: HORN
Description: Emergency Horn
System: DCS
I/O Type: DO
Location: FLD
Wiring Rule: 2 Wire Solenoid To JB
Operation Principle: F&G

4.2.8 Loop Type Catalogue (Worked Example)
By default, the Instrument Types Catalogue window is displayed when the above option is selected. To
open the Loop Type Catalogue view, select Loops from the Catalogue for list.
A “loop type” consists of the association of a loop code with a class. Click New button.
To create a new loop type, select the Class Name and the Class Description is completed automatically.
Enter the Loop Code and its description. Finally, enter the Order value.
 The entry in the Order field defines the position

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
will be listed in alphabetically order.
For example:
Class Name: ILP
Loop Code: A
Description: Alarm
Order: 99
When finished select OK

Select Import from Excel.
Browse to the location where the files supplied by your trainer are located:
C:\AVEVA_InstrumentationTraining\ExcelFiles\Loop Type Catalogue.xls
Click the Open button on the Select Import File form.
 Ensure that the Excel columns names mapped for data import do not contain leading or trailing spaces.
Complete the mappings as shown to

the left and then select Import and
then Batch Process all
Check Accept All and then Save.

A log file (.csv) is created and opened automatically in Microsoft Excel which contains the imported status
for all the items.
 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
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.
Close the file and return to the Loop Type Catalogue window.
Now you will notice that a loop type can have more than one type code assigned to it.

4.2.9 Process Units
The user can add, edit and delete Process Units and Process Properties (type of process units). One
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.
A Process Units (ALL) window will appear with three columns: Process Property, Unit and Default.
Select the process property Pressure from the pull

down list.
Uncheck the bar and Select kPa to make it the

pressure default unit.
Click the Save button to exit Process Unit window.
 For detailed information on Process Units, please refer Section 3.5 of AVEVA Instrumentation Engineer
User Guide.

4.2.10 Project Voltages
Project voltages can be added to the Instrumentation project so that power supply can be assigned to the
active Instruments (Transmitters, Actuators, etc.).
Select Project > Setup > Project Voltages to access the project voltages for the project. A Voltages
window will appear.
Click the New button and Project Voltage option, the following dialogue box will be open:
The text box Volts is where the new project voltages are
entered. Enter 24
The No. of Phase pull down list has the following

options available: 1, 2, & 3: Select 1
The Frequency pull down list has the following options

available:
50, 60 & DC Select DC
Select Apply
Pressing the OK button will add the voltage to the list of project voltages.

Exercise 5 – Create Project Voltages
Using the information in 4.2.10 above, add a Project Voltage using listed below:
 Volts: 230
 No. of Phase: 1
 Frequency: 50
When completed, select OK.

4.2.11 Property Definitions (Worked Example)
AVEVA Instrumentation supports user defined properties to aid the user while creating Datasheet
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
Data and Process Data as its two Object Types.
A new property can be created and assigned to an Instrument or Catalogue Datasheet Template.
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
that property which then updates the database.
New properties can be displayed in the following grids within the Instrumentation Engineer module:
 Instruments
 Process Data
 Instrument Catalogue
 If the user has a Catalogue Datasheet Template open at the same time as creating a new field, the new
field does not display until the datasheet is closed and then re-opened.
To access the Property Definitions option select Project > Setup > Property Definitions
This opens the Property Definitions window and by default the window displays the Class Type
Instrument and Object Type Instrument Data.

 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
categorise them based on their Object Type.
Class Type Object Type Prefix Description

Properties used on the
Instrument Sizing form
INSTRUMENT - Process Data ‘sz’
specific to Instrument Class
Type.
With Instrument as the Class Type, select Instrument Data as the Object Type, click the New button to
add a Property.
A Property Definition form is displayed.
Enter the following information on the form:
Property Name text box: TrnProperty
Caption text box: Training Property
Check Available for Custom Reports check

box.
 The Available for Custom Reports

option will add the property to the SQL
Query Maker interface when
creating/editing Custom Reports.
The new property ‘TrnProperty’ is now listed on the Property Definitions window. Click the Close button
to exit.

4.3 Options
To setup the project options: Select Project tab > Options
Three tabs available for the administrator are: Instruments, Process Data and Datasheets.
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.
The administrator may

change the text/combo field
label captions on the Edit
Instrument dialog form by
checking the Use Gridview
Captions for Instruments
Edit Dialog check box.
Check the Allow Duplicate Instrument Tags in Different Project Locations checkbox to allow an
Instrument Tag to be duplicated in a different location.
On Process Data tab, the

administrator may change the
text/combo field label captions
on the Edit Process Line and
Edit Process Equipment
dialogue form by checking the
Use Gridview Captions for
Process Data Edit dialog
check box.

On the Datasheets tab, the

administrator may set the
Datasheet revision history
and also what revision
details are to be displayed on
datasheets.
Enter the following information on the form:
Max. No. of Revisions: 5

By text box: BY
Checked text box: CHKD.
Approved text box: APPR.
 The Revision entry form for datasheets will not include the By, Checked or Approved fields if the
appropriate check boxes are not checked.
 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.
Tick the checkbox under Sheet of Calculation and click Save.
Click Yes to confirm the Datasheets SheetOf value.
This closes the form.

4.4 Instruments Catalogue (Worked Example)
The Instrument Catalogue in AVEVA Instrumentation is used to allows the creation and definition of
instruments properties such as Instrument name, Location, Description, Manufacturer, Model number, Size,
Datasheet number, Operating principal, Wiring configuration, etc.
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 access the Instrument Catalogues: Select Home > Select > Instruments (under Catalogues). The
Instruments Catalogue grid is displayed:
To add a new Instrument to the Instrument Catalogue, click the New button under the Records pane. This
brings up the Add New Catalogue Instruments form.

Enter the following information in:
Name: Temperature Transmitter

Location Code: FLD
Description: Temperature Transmitter
Enter the following information in the General tab:
Select the Detail Tab:
Loop Dwg Code: 11
Select the Datasheet Tab:
Manufacturer: Rosemount
Model No: 3144P
Supplier: Emerson Process Management
Select the Properties Tab:
Click OK to close the window and save an item in the Catalogue.
The user is encouraged to view the contents of the other tabs: DCS System, PLC/ESD System, User, and
Alarm/Settings.
 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
project from which the Instruments Catalogue are to be imported.

4.5 Datasheet Catalogue
AVEVA Instrumentation is equipped with a catalogue of sample (template) Datasheets. This catalogue is
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.
To access the Datasheets Catalogue: Select Home > Select > Datasheet Forms (under Catalogues).
This will open the datasheet catalogue, and a contextual Datasheet Catalogue tab.
There are two options on the Actions pane: Open and Open in Excel. To edit the layout or captions on the
Datasheet template, the user should use the Open in Excel option and make the necessary modifications
and save the Datasheet.
To add additional data link mappings or to change existing mappings, the user should use the Open option
on the datasheet.

4.5.1 Modify Datasheet Template (Worked Example)
Select the Form Name S20.40 datasheet template and click the Open in Excel button from the Actions
pane.
The user can now add new cells on excel spread sheet, and then map these fields to the new cells.
Under the heading ELEMENT add a field called Body Rating and under heading OPTIONS add a field
called Purchase Order.
 The user would have to edit the cells on the excel spread sheet to include the new fields.

Save and close the excel spread sheet. Select the S20.40 datasheet template again and click the Open
button from the Actions pane.
This opens the catalogue datasheet S20.40. Observe that the fields added in excel are now included.
To the right of the datasheet template is

a list of fields. Clear all filters, and then
filter on the Table column for Instrument
List.
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
the datasheet and note how the mapped field P&IDNo is highlighted.
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.

Exercise 6 – Datasheet Configuration
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).
 Discharge Coefficient szDischargeCoeff

 Reynolds Number szReynoldsNo
Save and Close the datasheet template.

4.5.2 Create an User Defined Datasheet Template (Worked Example)
Users can create their own customized Datasheet templates using Microsoft Excel® in either xls or xlsx
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.
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 add the Datasheet Template: Open the Datasheet Catalogue grid by selecting the Home > Select >
Datasheets Forms (under Catalogues):
This adds a contextual tab Datasheet Forms Catalogue. Click the New button under the Records pane.

This will open the Select Catalogue Type dialogue box.
Select the Datasheet radio button and click the Save button.
The Form Information form is displayed. Enter the following details on the form:
Form Name text box: PG-MultiTag
Description text box: Pressure Gauge

– Multiple Tags
Max No. of Tags: 4
Max No. of Plant

Connections: 1
File Name text box: MT_PG001
Principle of Operation combo box:

Pressure Gage
Click the (Browse) command button.
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.
Click the Yes button on the form.
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.

A Catalogue alert form appears to confirm that the file was copied successfully.
Click the OK button.
Click the Save button on the Form Information form. A Catalogue alert form is displayed.
Click the Yes button.
The Datasheet template PG-MultiTag is now added to the Datasheet Form Catalogue.

4.5.3 Create an User Defined Front SheetTemplate (Worked Example)
To add a new front sheet definition to the project catalogue click the New button under the Records pane.
This will open the Select Catalogue Type dialogue box.
Select the Front Sheet radio button and click the Save button.
The Form Information form is displayed. Enter the following details on the form:
Form Name text box: Front Sheet
Description text box: Front Sheet for

Documents
File Name text box: Front Sheet
Click the (Browse) command button.
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. Click the Yes button on the form.
Browse and select the file Front.xls provided by the Trainer.
Click the Open button on the Select existing Template spread sheet to copy to project browser window.
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

4.5.4 Auto Create Properties (Worked Example)
Select the datasheet template PG-MultiTag from the Datasheet Catalogue grid and click the Open button
from the Actions pane.
This opens an empty and unmapped datasheet which is typical of a user defined (customised) datasheet.
 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.
Using the mouse cursor, drag the fields split screen so that all the columns on the right hand side are visible.
Clear the filter on the Used column.
Also, click the Auto Hide option above the Cell column.
On the tool bar menu, click the New Property button and select the Auto Create Properties option from the
context sensitive menu.
This will open the Auto Create Properties window:

Arrange the Auto Create Properties window adjacent to the group heading GAUGE on the Datasheet
Template.
Select the caption Pressure Measurement Type and a red rectangle will surround the caption cell and the
property to be created is listed (appears) in the Auto Create Properties window.
Similarly, select the remaining captions till ‘Pointer’, available under the heading GAUGE.

The updated Auto Create Properties window should appear as below:
Click the Create button.
An Export Report form is displayed, where the user can export to

excel, print or close.
Click the Close button.
 The user is notified if the properties already exist or created in

the project database.
4.5.5 Auto Create Mappings for Multiple Tags (Worked Example)
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
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
demonstrate the auto copy data link mapping feature for multiple tags.
Click the Fields tab on the right hand corner of the datasheet template.

This displays the list of all the Fields (datalinks) which will now be mapped to the datasheet template.
From the pull down list under column Table, select InstrumentList and select TagNo from the pull down list
under column Field.
Using the mouse cursor, drag and adjust the fields split screen so that all the columns on the datasheet are
visible.
Click the Auto Hide button to pin the fields list and check the Auto Copy Multiple Tags check box.

Click and hold (mouse click) on the record Tag1 under the column Tag and drag it across and release the
click next to the caption Tag No. on the datasheet template.
The colour changes to grey once the datalink is mapped to the cell.
The Cell and Used columns are updated for the record Tag1.
Now try mapping the record Tag2 adjacent to Tag1 onto the datasheet template.
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
the cell changes from orange to grey.
The Cell and Used columns are updated on the Fields grid.
Select IService1 (Instrument Service) from the pull down list under column Field.

Drag and drop the Instrument Service mappings across for Tag1 onto the Datasheet Template.
AVEVA Instrumentation copies the mappings for Tag2, Tag3 & Tag4. Once mapped, the colour of the cell
changes from orange to grey.
Similarly, drag and drop the mappings for P&IDNo and PlantConnection for the four Tags.
The Fields grid should appear as below:

Exercise 7 – Copy Mappings
1. Create a new Datasheet form type Other with the file CalibrationSheet.xls provided by the Trainer.
2. Open the Datasheet template PG-MultiTag and map the Datalinks using the Auto Copy Multiple
Tags feature for four Tags.
 Pressure Measurement
Type
 Min
 Max
 Figure Interval
 Minor Graduation
 Case Design
 Size
 Case Material
 Lens Material
 Movement Material
 Ring Construction
 Ring Material
 Type
 Matl
 Dial Material
 Colour
 Pointer

The Datasheet template should appear as below:
Click the Save & Exit button on the datasheet template.
3. Open the Datasheet template Front Sheet and map the Datalinks manually without checking the
Auto Copy Multiple Tags check box.
 Project Number
 Plant Name
 Client Name
 Title1
 User Field 1

The Datasheet template should appear as below:
Click the Save & Exit button on the datasheet template.

4.5.6 Export Datasheets to Pre-defined Folder
User may define the folder(s) to which the datasheets will be exported and also the format of the
Datasheets.
To specify the folder(s) and sub-folder(s), select the Project > Setup > Set Datasheet Export File
Name/Folders
This opens the File Export Settings form.
In the Root Folder: text box enter the folder where the datasheets will be located.
Use the button to browse for the required folder.

 Users must create a folder in C:\ Drive called AI Datasheets to maintain consistency with the
screenshots.
To specify the folder structure, select the check box for each attribute under the lists Sub Folder and File
Name.
Under each list, select the following check boxes and if required enter text and delimiters in the text box.
Sub Folder File Name
{ProjectNo} {AreaNo}
{AreaNo} {DocNo}
{Sheet}
{Rev}
{ProjectNo}-Area{AreaNo} {AreaNo}-{DocNo}-{Sheet}-{Rev}
The completed File Export Settings form should appear as below:
Click the Save button to exit the form.

CHAPTER 5
5 AVEVA Instrumentation Wiring Manager
5.1 Starting AVEVA Instrumentation Wiring Manager
AVEVA Instrumentation Wiring Manager can be started from the windows desktop:
Wiring Manager 12.1.SP4.

Click Select
The AVEVA Instrumentation Wiring Manager Application Window opens.
Before getting started with AVEVA Instrumentation Wiring Manager, some preparation and checks are
required for example:
 Project Cables
 Create Devices
 Create Wiring Rules
 Create Ferrule Rules
 Enhanced Cable Block Diagrams User Defined Symbols and Preferences
 Create Cable Drum Definition
The user has the flexibility to manipulate the Plant Areas, Area Types and Pick Lists even within the Wiring
Manager Module.

5.2 Options (Worked Example)
AVEVA Instrumentation Wiring Manager permits the user to set the preferences for I/O Modules, Project
Cables and their termination details under the Options window.
To access the Options window: Select Project tab > Options. This opens the Options window displaying
the General tab:
On the General tab, the user may change the

Earth Core marking for all Cables by typing the
required value in the Cable Earth Core Code text
box.
Change the measuring units from ‘m’ (meters) to

‘ft.’ (feet) by using the pull down list for Cable
Length Units field.
Check: Use Auto Ferrule Numbering Rules

check box to allow and update the Ferrule
numbering for each core during terminations,
following the user defined Ferrule Rules.
Check: Copy Instrument Service to Field

Device description check box, copies the field
Instrument service from Instrument list to
Equipment list. If unchecked, uses Instrument
description from Instrument list.
Click the Cores button. The Cores Group Type form opens.
The existing values can be modified or the user may

add new items if required clicking Add Item.
Click the Cancel and Save buttons to exit.
 For detail information about Options, please refer to the AVEVA Instrumentation Wiring Manager User
Guide.

5.3 Cable Catalogue
The Cable Catalogue is used to view all catalogue cables and allows definition of manufacturers cable
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.
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
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
current terminations for the original cable.
The user can select (Allow) specific cables for a particular project from the Cable Catalogue. The cable
catalogues can be imported from a spread sheet or imported from another project within the application.
To access the Cable Catalogues: Select Home > Select > Cables (under Catalogues). The Cables
Catalogue grid is displayed.
5.3.1 Add Cable to the Catalogue (Worked Example)
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.
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
collectively screened, armoured cable:
Class combo box: Instrument

Manufacturer text box: AVEVA
Catalogue Number text box: AVEVA001
Group Type combo box: Pairs

No. of Pairs text box: 10
Units combo box: mm²
Core Size combo box: 1
Check OAS/Coll check box

Check Group/Indiv check box
Check Armoured check box
Voltage Range combo box: 300/500V

Insulation Type combo box: PVC
Insulation Temperature
combo box: 70 degC
Colour combo box: BLACK

Description combo box: PVC/SWA/PVC
 Cable Catalogue Users Fields are available on

the User Fields tab. These can also be
populated on the cable catalogue grid.

Select the Design Data tab, and enter these details:
Wire Size combo box: 1/0.8mm

Outside Diameter text box: 24.2
Minimum Bending Radius text box: 145.2
Mass text box: 890
Conductor Material combo box: Cu
Impedance Units combo box: ohm/km
Core Resistance text box: 9.8
Drum Length text box: 500
 Drum Length value will be used to create

automatically cable drums when the option
Auto Cable Drum selected Cables is
selected.
Enhanced Cable Block Diagram:

Line Style combo box: Dashed
Line Width combo box: 2
Line Colour combo box:
RoyalBlue
Arrow Head combo box:
 User can control how cables appear on the

cable block diagrams. Each cable catalogue
entry has these graphical properties.
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.
 The Apply button on the form saves the information to the database while keeping the form open and
the OK button will save the information to the database and immediately closes the form.
5.3.2 Select Cables (Worked Example)
Use the pull down list under Class and select Instrument, which displays all cables under the Instrument
class.
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.
Similarly, filter out and check the Allow Use check box for Control Cable with Catalogue No: 29017.

Exercise 8 – Cable Catalogue
Create a cable with the following parameters:
Cable Data Tab:

Class combo box: Instrument
Manufacturer text box: AVEVA
Catalogue Number text box: AVEVA006
Group Type combo box: Pairs

No. of Pairs text box: 10
Units combo box: mm²
Core Size combo box: 1
Check OAS/Coll check box

Check Group/Indiv check box
Check Armoured check box
Voltage Range combo box: 300/500V

Insulation Type combo box: PVC
Insulation Temperature
combo box: 70 degC
Colour combo box: BLACK

Description combo box: PVC/SWA/PVC
Design Data:
Wire Size combo box: 1/0.8mm
Outside Diameter text box: 24.2
Minimum Bending Radius text box: 145.2
Mass text box: 890
Conductor Material combo box: Cu
Impedance Units combo box: ohm/km
Core Resistance text box: 9.8
Line Style combo box: Chained

Line Width combo box: 2
Line Color combo box: FireBrick
Arrow Head combo box:

5.3.3 Import Cables into the Catalogue
AVEVA Instrumentation Wiring Manager supports importing catalogue cables from an Excel spread sheet
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):
 Catalogue No
 Group Type
 No of Groups
 Group Screen Required = GroupScr
 Overall Screen Required = OAScr
 Earth Core
Enhanced Cable Block Diagram Cable Properties:

 Line Style = LineType
 Line Width = LineTypeWidth
 Line Color = LineTypeColor
 Arrow Head = LineTypeArrowHead
To access the Import tool, open the Cable Catalogue grid and select the Manage tab. Click the From Excel
button under the Import pane.
This opens the Cable Catalogue Import

Wizard. Select the Excel spread sheet
Import Cable Catalogue.xls provided by
the Trainer and click the Next > button on
the wizard.
Click the TRAINING link label on the

Worksheets form.
This opens the Select Mappings section on the wizard. The user must map each Excel column name
(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
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.
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.

Use the pull-down list for each field under AVEVA Instrumentation Field column, and map them with
suitable fields on Excel Column Name column.
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:
And the mappings configuration is saved under the

Saved Mappings combo box.
 Most of the AVEVA Instrumentation

Fields were mapped automatically
to each field on Excel Column
Name only Colour1 and Colour2
were mapped manually.
 The user can save the mappings

while using the import functionality
within any module of AVEVA
Instrumentation.
 Ensure that the Excel columns

names mapped for data import do
not contain leading or trailing
spaces.
Once the fields have been mapped,

click the Next > button on the Import
wizard.
 Arrow Head values are:

NoArrow
StartArrow
EndArrow
Both

Check the Select All check box to accept the import of the two records (AVEVA002 & AVEVA003) and click
the Next > button on the wizard.
The Cable Catalogue Import Wizard lists the cables with the valid data.
Click the Import button to proceed.
An Import alert form is displayed to confirm the import function.
Click the OK button on the form.

A log file (.csv) is created and opened automatically in Microsoft Excel which contains the imported status
for all the items.
 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
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.
Close the file and return to the Cables Catalogue grid.
5.4 Field Devices
The Field Devices Catalogue within AVEVA Instrumentation Wiring Manager is used to define Field
Devices and their terminals arrangements.
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
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.

5.4.1 Add a Field Device (Worked Example)
1. Motor Auxillary Contacts
To add a new Field Device: Click the New button under the Records pane.
This displays the Field Device Definition form.
Enter the following details on the form:
Check the Allow Use check box

Catalogue Name text box: Motor
Auxiliary Contacts
Description text box: Pump Running
Status
Right Quantity text box: 2
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.
The new Field Device is now listed on the Field Devices Catalogue grid.
 For detailed information about Field Device Catalogues, please refer to Section 5.15.2 of AVEVA
Instrumentation Wiring Manager User Guide.

5.5 Major Equipment Catalogue (Worked Example)
Another method of adding equipment (Junction Boxes, Cabinets, Panel, etc.) to the project database is by
using the Major Equipment Catalogue.
This feature allows the user to copy and create a standard equipment configuration from the Major
Equipment Catalogue, complete with terminal strips and terminal markings.
To access the Major Equipment Catalogue: Select Home > Select > Major Equipment (under
Catalogues).
This opens the Major Equipment Catalogue tab displaying an empty Major Equipment Catalogue grid.
To add equipment to the Major Equipment Catalogue grid: While under the Home tab, Click the New button
from the Records pane.
The Equipment Information form is then displayed.
Enter the following details:
Catalogue Name text box: 30T-JB-WP
Equipment Type pull-down list: Junction

box
Description text box: 30 Terminal

Junction Box, Weatherproof
Click the Save button to add the equipment to the Major Equipment Catalogue grid.

To add Terminal Strip & Terminals (including

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.
An Options window is displayed.
Click on the Edit Detail link label.
This opens the Equipment Layout window for the Catalogue item.
Right Click within the layout

(white dotted line) and select Add
Terminal Strip on the context
sensitive menu.

Click the More Information button. Fill the form as shown below:
Certain fields impose design constraints

 No. of Holes/Cables (max.):
Limits no. of cables that can be
connected
 No. of Terminal Strips (max.):
Limits no. of terminal strips that
can be created
 No. of Terminals per Terminal
Strip (max.): Limits no. of
terminals per terminal strip
Leaving any of these values blank

removes the constraints i.e. no checks
Click the OK button to close the form.
The Terminal Strip Information form is then displayed. Enter the details for Terminal Strip and Number or
Terminals and the completed form shall appear as below:
Terminal Strip No text box: TS1
No. of Terminals text box: 30
First Terminal No. text box: 1
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.

Enter the following details on the Layout form:
Termination Drawing check box: Checked
Signal Class Applies check box: Checked

Digital check box: Checked
Non I.S check box: Checked
Signal Serv. Applies check box: Checked

Control check box: Checked
Click the Save and Exit option on the Equipment Layout form.

5.6 Setup
The Setup menu under the Project tab provides the user access to the project setup menu items in Wiring
Manager:
 The user has the

flexibility to
manipulate the Plant
Areas, Area Types
and Pick Lists even
within the Wiring
Manager Module.
5.6.1 Wiring Rules
AVEVA Instrumentation uses Wiring Rules to auto generate the creation of Field Device (including
terminals), field cable(s), wire/signal numbers and termination details.
To access Wiring Rules: Select Project > Setup > Wiring Rule Definitions. This opens the Wiring Rule
Definitions window.
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.

5.6.1.1 Create a Wiring Rule (Worked Example)
1. Motor Alarm Status
The user can create a new Wiring Rule by following these steps:
Click New and a new Graphical

Wiring Editor appears.
Enter the Wiring Rule name as

Motor Alarm Status in the text box
Wiring Rule Name.
Next, Right Click in the middle of

the graphics area and a context
sensitive menu appears with two
options Add Cable and Add
Equipment.
A sub menu is available under Add Equipment. Select Field Device and an Equipment dialog box opens
with Equipment No. and Type text boxes.
Using the pull down list under text

box Equipment No: Select {TAG}
Type: Click the button, and

Select a Field Device Terminal
Configuration window opens. Use
the Graphic tab to view the Field
Devices using the scroll bar. Double
Click to select Pump Running
Status Field Device.
The completed Equipment form

should appear as below.
Click the Save button and the Field Device will be displayed on the Graphical Wiring Rules Editor with its
terminals X1 & X2.
Similarly, Right Click in the middle of the graphics editor and from the context sensitive menu select
Junction Box from the submenu of
Add Equipment field
This opens an Equipment dialog box

with Equipment No. and No. of
Terminals text boxes.
Equipment No pull down list: {JB1}
No. of Terminals text box: 3
Click the Save button and Equipment

(JB1) with three terminals is
displayed on the graphical area.

 The number of terminals on the Junction Box depicts only the termination sequence and not the actual
terminals of the Junction Box.
To add a cable between the

equipment:
Right Click in the middle of the

graphics area and select Add Cable
from the context sensitive menu.
This opens a Cable form.
Select {TAGNo-NoDelimiter} under

the combo box for Cable No:
Click the command button to the

right of the Catalogue No combo
box, and this opens the Cable
Catalogue.
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.

The completed form should appear as below:
Click on the Save button and the

Cable will appear on the Graphical
Wiring Editor.
Select the Cable (by their label) and drag it to a suitable location on the graphical editor.
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

Drag the core (1BK) and Click to terminate the core at terminal X1 of Field Device (TAG).
Follow the same steps to terminate core 2BK at terminal X2 of the Field Device. Similarly, at the other end
(Right) of the Cable: Right Click > Connect Wire (To) > 1BK
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.
Once terminated, the cores of both sides of the cable on the Wiring Rule should appear as below:
To add wire/signal number to the core: Right click on Terminal X1 and select Edit Signal No. from the
menu.
 Signal Numbers are inherited by all wires or cable cores that are connected directly to a terminal
containing a Signal Number.

This opens the Terminal form.
Select {TAG} from Signal No combo box and add ‘+’ outside the parenthesis (right).
The Terminal form should appear as below:
Click the Save button and similarly right click on Terminal X2

and select Edit Signal No. from the menu.
Select {TAG} from Signal No combo box and add ‘-’ outside the
parenthesis (right).
The Terminal form should appear as below:
By adding the Signal Numbers, the colour of Terminals X1 & X2 changes from black to blue.
Click the Save button and click the Close button on the Wiring Rule Definitions window to exit.
 For detailed information about Wiring Rules, please refer Section 11 of AVEVA Instrumentation Wiring
Manager User Guide.

5.6.2 Ferrule Rules
AVEVA Instrumentation Wiring Manager supports Ferrule Numbers, which may be different at each end of
the core (wire) for Field Devices and Equipment. A Ferrule Number is stored for each wire end, where its
default value is empty (blank).
While using Ferrule Numbering Rules, AVEVA Instrumentation Wiring Manager dynamically creates and
updates the signal numbers as terminations are managed.
The user can create (define) a customised Ferrule Rule for each equipment whether Field Device or
Cabinets/Junction Box etc.
To access the Ferrule Rules: Select Project > Setup > Ferrule Rule Definitions
This opens the Ferrule Rules grid window.
5.6.2.1 Create a Ferrule Rule (Worked Example)
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.
Ferrule Rule Name: LEFT HAND SIDE
Example: +/00-FT-100/JB-101/TS1/1
(Proposed Ferrule rule format)
Datalink: Using the pull-down list, Check the

suitable check boxes for selecting Datalinks
and delimiters (/, \, -, _, etc.) as below
{TNo-OtherEnd}/{EqNo-OtherEnd}/
{EqNo}/{TSNo}/{TNo}
 If the same delimiter is used more than once then the user must enter or type them manually in the
Datalink combo box.
Default check box: Unchecked (If checked the current Ferrule Rule will be default for all terminations of the
project).
Apply by Equipment Type check box: Checked. This will activate the Add & Remove buttons on the
Ferrule Rule form.

Click Add and select Junction Box from the

pull down list under Equipment Type and
select Left from the pull down list under Side(s).
Similarly, assign the Ferrule Rule (LEFT HAND SIDE) on the Left side of the following equipment:
 Cabinet/Panel
 DCS Cabinet
 Field Device
 MCC
The completed form should appear as below.
Click Save to assign the new user defined

Ferrule Rules on Left side of all the selected
Equipment under the field Equipment Type.
The new user defined Ferrule Rule is displayed on the Ferrule Rules grid window.
Click the Close button to exit the form.
 For detailed information about Ferrule Rule Definition, please refer to Section 8.2 of AVEVA
Instrumentation – Wiring Manager User Guide.

Exercise 9 – Setup Wiring Manager
Using the worked example above as a guide create the following setup:
1) Select and Import Project Cables
Filter the Cable Catalogue and check the Allow Use check box for the below cables:
Class Catalogue No. Cores x Size

Instrument IEH184AA010 10Pr x 1.5mm²
Control 29008 30C+E x 16AWG
Using the Excel spread sheet (Import Cable Catalogue.xls) import the cable catalogue from
the EXERCISE Worksheets:
 AVEVA004
 AVEVA005
2) Create new Field Devices
Create the following Field Devices in the Field Devices Catalogues.
a. Local Level Indication Display
b. Transmitter with Ext Display

3) Create a Wiring Rule
a. Create a Wiring Rule between Local Level Indication Display and Transmitter
with Ext Display
Include the following SignalNumbers:
Terminal 1: {TAG}+
Terminal 2: {TAG}-
b. Create a Wiring Rule between Level Transmitter to JB
Include the following Signal Numbers:
Terminal +: {TAG}+
Terminal -: {TAG}-
4) Create a Ferrule Rule for the Right Hand Side

5.7 Cable Drums (Worked Example)
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.
To access the Cable Drum Schedule: Select Home > Select > Cable Drum Schedule (under Lists)
To create a cable drum definition Select New
Enter the following details in the Cable Drum Detail form.
Drum Number text box: ICD001
Drum Length text box: 500
Drum Locked check box: Unchecked
Catalogue No combo box: Click the

command button, type IEH184AA010 in the filter
for Catalogue No. and double click the record
on the Select a Cable from Catalogue window.
Click the Apply button.
Click the OK button to save the information and

exit the Cable Drum Detail form.
The user will be able to assign a project cable to a specific drum.
 Cable drums can also be created automatically, using the Auto-Cable Drum facility

Exercise 10 – Setup Wiring Manager
Using the worked example above as a guide create the following Cable Drum:
Drum Name: ICD002

Description: PVC, 1 Pr Cable
Catalogue No: IEF184AA001
Drum Length: 1000

5.8 Cable Block Diagrams
A Cable Block Diagram provides the user a pictorial view of the project's cabling for easier navigation and
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,
adding cables and equipment etc.
The Cable Block Diagram application includes auto-layout capabilities and allows printing to hard-copy and
also supports the ability to 'Export to AutoCAD' DWG format.
Users can view and edit Cable properties as if they were using Wiring Manager's Cable Schedule data grid,
view and edit Equipment, including terminations as if they were using Wiring Manager's – Equipment View.
There are two types of Cable Block Diagram, Basic and Enhanced:
 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
project.
 The type is selected when a diagram is created.
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)
The Cable Block Diagram list will open and a contextual tab Diagrams will appear and will have the focus.
5.8.1 Enhanced Cable Block Diagram Options
The user can view and edit the options for Enhanced Cable Block drawings generated by Instrumentation
Wiring Manager.
To access the Enhanced Cable Block Diagram Options select the Enhanced Cable Block Diagram
Options option in the Diagrams tab.
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.

Symbol Standard: This enables the

selection of a defined Symbol standard
type. It controls the library/palette loaded
each time an ECBD opened.
Drawing Styles. If the Draw Orthogonal

checkbox is checked, cables will be
drawn at right angles (at 0 or 180 degrees
only). The Curved Bends checkbox
adds a small curve to all cable corners.
Equipment Spacing controls the vertical

and horizontal spacings of automatically
added interconnections and layouts.
Cable No – Equipment Offset is the

distance between the labels of cables and
equipment.
Assignment (Link) determines the

thickness of links between symbols that
have not been converted into cables
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.
Grid display and Snap are controlled from within

the graphics application by selecting Show Grid to
display the grid, and Snap to Grid to have objects
snap to the grid when dragged around the
graphics application.
Auto Add Interconnected Equip checkbox allows that all interconnected cables and equipment are
automatically added when existing equipment is added. Field devices can be excluded if the Exclude Field
Device is checked.
Show Instrumentation Cables option is disabled in Instrumentation.
Show Electrical Cables controls whether or not cables created in AVEVA Electrical for the project can
added to the diagrams. This option is available if the project is shared with Electrical.

Printing preferences are used to define

printing settings including Header and
Footer text.
Change Default Paper Size from A4 to

A3 using the pull down list and change
the Default Orientation from Portrait to
Landscape.
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.
Grid Settings Tab is used to control

which user-defined fields are displayed in
the Cable Block Diagrams grid (if any)
and what they are to be called in the grid.
There are ten user-defined fields. By

default, none of them are displayed in
the Cable Block Diagrams grid. To add a
user-defined field to the grid, uncheck its
Hidden checkbox. To remove a field
from the grid, re-check the checkbox.
Unchecked UserField1, UserField2 and

Userfield3. Type Other Document No
in the Userfield1 Caption field.
The grid will look as shown below.
Click the OK button to close the window and save the settings.

5.8.2 Enhanced Cable Block Diagram – User Defined Symbols
AVEVA Instrumentation is very flexible in the way that symbols can be employed in the application. AVEVA
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.
To access the user defined symbols, select: Project > Setup > User Defined Symbols.
The User Defined Symbol List will open.
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.

5.8.2.1 Equipment Type Symbols
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
5.8.2.2 Import from another Project
Select Import symbols from other project on the tool

bar. This will open the Select an AVEVA
Instrumentation Project… window.
Select the project to import the symbols from;

this will open the Symbol List From Other
Project Window.
Expand the window and check to see that

the Multi-Select check box is checked.
The user can select the symbols for the
import. When finished selecting, press the
Import button.
The selected symbols will be imported into

the current project.

5.8.2.3 Create a New Symbol (Worked Example)
Select New from the tool bar, this will open the Enhanced Cable Block Diagram Symbol Detail window
(below).
Name: This is the name of the symbol.
Library: This is where the relevant library is selected or created. If a library is not available for selection
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.
Default Symbol: If this box is checked, the symbol will be the default symbol of that equipment type.
Object type: This is a pull down list of the equipment types

in AVEVA Instrumentation that are available to apply
symbols to.
Type in or select the following:
Name: Detector
Library: F&G
Object Type: Field Device
Default Symbol: Checked

Select Open Symbol Editor, and the Symbol Editor will open. This
editor has basic graphic capabilities and can used when creating
simple symbols or adding simple detail to imported symbols.
To initiate the import process, press the Import from .dwg file button.
A Windows file open dialogue will appear, browse for the symbol,
C:\AVEVA_InstrumentationTraining\CAD_Files\CBD
Files\Detector.dwg
Select Open and the selected symbol will appear in the Symbol
Editor.
Users can modify the symbol further if required using the basic
graphics tools provided.
When finished with the imported symbol, press the OK button

to return to the Symbol Detail window.

The Enhanced Cable Block Diagram Symbol Detail window now displays the symbol that was imported.
Datalinks available to the Object type are displayed in the scrollable list to the left of the graphics area.
These are added to the symbol by selecting a datalink, and then dragging and positioning it in the graphics
area.
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:
Datalinks are shown with the table name are contained. For example: Area Fields.AreaNo.
 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
around the symbol.
The red lines that are visible on the datalinks

represent the justification of the datalinks. The view
above shows that the datalinks are left justified.
To change the justification of the datalinks, place the

cursor over the datalink and then Right Click with
the mouse. A context menu will appear offering
some options: Selecting Anchor offers three
justifications for the datalinks. Click anywhere in the
graphics area to cancel.
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.
Right click on the datalink AreaNo select Edit Text and

Type [Area: ] as shown opposite.
Click anywhere in the graphics area to exit Edit Text

mode.

To change the font used for the datalink text, click Font. The Select Font window is then displayed:
Select the values

according to the screen
on the left and click OK.
Change the Font values for the Instrument List Fields.TagNo and adjust the elements as shown below:
Select OK to exit.
A Message informing that the Default Symbol for Field Device already exist. Select Yes to accept.
 Existing Symbols can also be copied and edited to create another symbol. In the User Defined
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.

Exercise 11 – Symbols Creation
Using the symbol library provided on the electronic media supplied by the trainer, create the following
symbols listed below into AVEVA Instrumentation Wiring Manager:
AutoCAD dwg Symbol View
Horn.dwg
JunctionBox.dwg
Panel.dwg

5.8.2.4 Cable Label Symbols (Worked Example)
In the case of cables, the Enhanced Cable Block Diagram Symbol Detail window is used to define the labels
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
the information described in the chapter above, create a new cable symbol using the information in the
screen below:
When a box or any graphic is included as a cable label, the Default

Anchor option is available on the tool bar.
This option controls the position of connection between the cable and
its label.
Bottom Left representation.
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
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..


CHAPTER 6
6 AVEVA Instrumentation Designer
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.
Generally, this is the last AVEVA Instrumentation module used by an Engineer/Designer during a project life
cycle as the AVEVA Instrumentation Engineer is used to create Instrument tags and assign tags to Loops
and AVEVA Instrumentation Wiring Manager is used to create equipment, cables and wiring including
terminations.
The AVEVA Instrumentation Designer module cannot generate the deliverables (drawing files) without this
data from the other modules.
AVEVA Instrumentation Designer can be used to generate:

 Loop Diagrams
 Termination Diagrams
 Installation Detail Drawings.
 Enhanced Cable Block Diagrams
6.1 Starting AVEVA Instrumentation Designer
AVEVA Instrumentation Designer can be started from the windows desktop:
Designer 12.1.SP4

Click Select
The AVEVA Instrumentation Designer Application Window opens.

6.2 Options
The user can view and edit the options for drawings generated by Instrumentation Designer.
To access the project options: Select Project tab > Options.
The Options window with five tabs: General, Revisions, Rev Clouds, Terminations and Enhanced Cable
Block Diagrams are displayed.
6.2.1 General
Keep the default settings on the tab and check the Cloud Changes check box only.
6.2.2 Revisions
Select the Revisions tab and enter the following details into each field/caption:
Field Name: Caption:
By Drw By
Checked Chk By
Approved App By

6.2.3 Rev Clouds
Select the Rev Clouds tab, and select

Yellow from the Color for Clouds
combo box while keeping the default
settings.
 Templates must have any layer

referred already in the AutoCAD
file, i.e. REVCLOUDS.
 Changes to drawings are

automatically highlighted using
revision clouds if the Cloud
Changes checkbox on the
General tab (see above) is
checked.

6.2.4 Terminations
Select the Terminations tab, Check the Use DwgNo. References for Wires box and change the Core
Length and Wire Length.
 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.
 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
drawings.
 The “Draw Looping Wire with Bend” check-box controls how looping wires are drawn on Termination
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
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
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
if checked.

6.2.5 Enhanced Cable Block Diagrams
Select the Enhanced Cable Block Diagrams tab and keep the default settings.
 If the User Layers check box is

checked, the Equipment Layer and
Link(s)/Cable(s)/Cable Lable
Symbol(s) Layer text boxes become
available. Here the user is to enter
the names of the layers that the
user would like to place equipment
items and cable data on.
 The layer options in this dialogue
will NOT create the layers, the
layers should already exist in the
SEED file. When layers are
specified, the KOL/SLD drawings
will adopt the colour properties of
that layer.
Click the OK button to save and exit the Options window.
6.3 Project Setup
The Setup menu under the Project tab provides the user access to the project setup menu items in
Instrumentation Designer.
The user has the flexibility to

manipulate the Plant Areas, Area
Types and Pick Lists even within the
Designer Module.
 This training guide will NOT

explore all of the menu items
available from the Setup Menu.
For additional information please
refer to the AVEVA
Instrumentation Designer User
Guide.

6.3.1 Drawing Titles (Worked Example)
AVEVA Instrumentation Designer will automatically populate the drawing title information Title1, Title2 and
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.
 Import is probably not a good name for this feature. Import in this context means that the selected
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):
Select the Project > Setup > Loop

Titles (Import Format)
This will open the Schematic Import

Drawing Title Settings dialogue.
Enter the following details on the Loop

Import Drawing Title Settings form:
Title 1 combo box: INSTRUMENT LOOP

DIAGRAM
Title 2 combo box: {LoopNo} -

{LoopService1}
Check the Update existing drawing Titles

on ‘Check’ for new drawings check box.
Click the Save button on the Loop Import

Drawing Title Settings form.

Exercise 12 – Drawing Titles
Using the knowledge gained in 6.3.1 above, configure the drawing title according to the following window:
 Termination Import Drawing Title
 Enhanced Cable Block Diagram Import Drawing Title
 ECBD Diagram Number, Description and the user fields defined in AVEVA Instrumentation Wiring
Manager are available to be included in the drawing title.

6.4 Termination Diagram Seeds
A Termination Diagram (Drawing) is used to show all field Instruments and their wiring details specific to an
equipment (Junction Box, Cabinet/Panel, etc.) within the project.
Termination diagrams are created automatically and use SEED drawings (Drawing Borders) to create them.
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.
The user can configure several different types of Seeds to display one row of terminals, three rows of
terminals etc.
First, from the training supporting material, copy the AutoCAD drawing Termination_1TB.dwg to the
folder: C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds.
On the Home tab select Seeds. This will open the Seeds grid and a contextual action tab Seeds.
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:
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds\Termination_1TB.dwg
Complete the remainder of the form so that it matches the image below. When completed select OK.

The Seed is now listed in the grid. Selecting Open on the Seeds tab will open the Seed drawing:
Close and exit the Termination_1TB.dwg drawing.
 Assigning and editing Datalinks of the Seed file is an Administrator Activity, but for this training it will be
cover in the AVEVA Instrumentation Designer Training Manual.

Exercise 13 – Generate a Termination Diagram:
Using the ‘A1’ size create a SEED file called Termination_3TB.dwg as shown below

6.5 CBD Seeds
On the Home tab select CBD Seeds. This will open the CBD Seeds grid and a contextual action tab
Seeds.
First, from the training supporting material, copy the AutoCAD drawing ECBDA3.dwg to the folder:
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Seeds
On the Seeds tab select New. Using the image below as a guide, complete the CBD Seed File
Parameters.
 If the Scale to fit checkbox is selected, the enhanced cable block diagram contents (as defined in
Wiring Manager) are to be scaled to fit within the extents of the seed drawing border.
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.
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.
 In order for line weights and dashed lines to be displayed correctly in the Enhanced Cable Block
Drawings the LWDISPLAY command must be set to ON and the LTSCALE may need to be adjusted in
the CBD Seed.
 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.

6.6 Loop Templates
Loop Drawings are created using AutoCAD loop diagram templates. A Template is an AutoCAD drawing
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
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
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
engineering data is always updated on the drawings and reflect the project database.
First, from the training material issued at the beginning of this training session, copy the AutoCAD drawings
FL001.dwg and LV001.dwg to the folder:
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Templates\AI (where XX are

Select Home > Select > Templates the templates grid is opened displaying a list of templates.
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.
 Assigning and editing Datalinks is an Administrator Activity, but for this training it will be cover in the
AVEVA Instrumentation Designer Training Manual.

6.7 Hookup Drawings
Hookup Details define the requirements to correctly install an instrumentation and control component i.e. an
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
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
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
assigned from Instrumentation Designer Hookup parts catalogue.
When the project Hookup Drawing is created AVEVA Instrumentation updates the Hookup Template
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.
6.7.1 Hookup Item Catalogue (Worked Example)
The first step in creating an Installation Detail Drawing is to create or import an Installation Detail Items
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).
On the Home tab select Hookup Items (under catalogues). This will open the catalogue.
This grid can be populated manually or data can be imported from Excel.
Click the New button to add a new Hookup Item (manually).

This opens a blank Hookup Item Detail form. Enter the details as below.
Click the OK button to save the data and

exit the form.
The new item is now listed on the

Hookup Item Catalogue grid.
Select the Manage tab; on the Import pane select From Excel. In the browsing window that opens, browse
to the folder:
C:\AVEVA_InstrumentationTraining\ExcelFiles\HookupItemCatalogue.xls. Select Open.
The Import Fields form opens.
AVEVA Instrumentation Designer will

attempt to automatically map the first row
of the Excel column headers to AVEVA
Instrumentation Field names if the names
correspond to AVEVA Instrumentation
Field names.
Select Import from the toolbar menu.
Select Batch Process all Records…
The Import Differences window opens, select

Accept All > Save. The Import Log window opens
informing the user of how many records failed to
import, and how many records were imported
successfully.
Select Close

The Installation Detail Item Catalogue is populated and the grid is opened to display the contents.
 Ensure that the Excel columns names mapped for data import do not contain leading or trailing spaces.
6.7.2 Hookup Catalogue
The Hookup Catalogue contains a list of templates that can be assigned to produce Installation Detail
Drawings.
Create the Hookup template drawings in AutoCAD and include attributed blocks. Instrumentation Designer
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.
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
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
folder:
C:\AVEVA_InstrumentationTraining\Projects\TM6101_01_XX\Templates\AI\Hookups
To access the Hookup Catalogues: Home > Select > Hookup (under Catalogues). The Hookup
Catalogue grid opens:
 The Hookup Catalogue grid is empty when working with a fresh new project database.

Select New from the Records pane on the Home tab, the Hookup Template Details is displayed.
Enter the following details on the Hookup Template Details form:
Category text box: Flow
Template text box: PS001
Remarks text box: Typical Hook Up
Description text box: Orifice & D/P Transmitter – Long Mounting – Gas Service
No. of Tags text box: 20
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:
Double-click the record with Size 1/2" OD - 1/2" NPTM and Material SS 316L. Click the Close button to exit
the window.

Complete the list as shown below:
Select OK.
An Installation Detail template has now been added to the Hookup Catalogue list.
 The Administrator should apply the appropriate Datalinks to the template drawing attributes to map the
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.

Exercise 14 – Generate a Hookup Template
Using the Hookup template CV001.dwg provided, generate a Hookup Template with the following details:


TM-6101 AVEVA Instrumentation (12.1) Administration Rev 6.0 PDF

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

TM-6101 AVEVA Instrumentation (12.1) Administration Rev 6.0 PDF

Hochgeladen von

Copyright:

Verfügbare Formate

AVEVA Instrumentation

Copyright © 2014. 2 www.aveva.com

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

Copyright © 2014. 3 www.aveva.com

@AVEVA Solutions Limited 2016

Copyright © 2014. 4 www.aveva.com

Copyright © 2014. 5 www.aveva.com

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

Copyright © 2014. 6 www.aveva.com

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

Copyright © 2014. 7 www.aveva.com

1.4 Course Structure

1.5 Using this guide

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

Annotation for trainees benefit:

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

Copyright © 2014. 8 www.aveva.com

2 AVEVA Instrumentation Training Workflow

The AVEVA Instrumentation product suite consists of five modules:

Copyright © 2014. 9 www.aveva.com

2.1 AVEVA Instrumentation Administration Training Guide Workflow

Copyright © 2014. 10 www.aveva.com

2.2 AVEVA Instrumentation Engineer Training Guide Workflow

2.3 AVEVA Instrumentation Wiring Manager Training Guide Workflow

2.4 AVEVA Instrumentation Designer Training Guide Workflow

2.5 AVEVA Instrumentation Process Engineer Training Guide Workflow

Copyright © 2014. 11 www.aveva.com

This page is intentionally left blank.

Copyright © 2014. 12 www.aveva.com

3 AVEVA Instrumentation Security Manager

3.1 Create a New Project

AVEVA Instrumentation Security Manager

Start Menu > All Programs > AVEVA >

Or, AVEVA Instrumentation Security

Copyright © 2014. 13 www.aveva.com

If this window does appear then browse to or make

And then select it and then pick OK.

 AvevaInstProjects.mdb a Microsoft Access

If this form is displayed, (contents will differ to

If an existing project does not already exist,

Copyright © 2014. 14 www.aveva.com

Click the Yes button to continue.

Copyright © 2014. 15 www.aveva.com

To the right of the SQL Server Name:

When selected, a login window will

Copyright © 2014. 16 www.aveva.com

The instance of the SQL Server that

It is advisable to test the connection

Continue to populate the form with the following data:

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

Project Description text box: My 1st AVEVA Instrumentation Project

Plant Name text box: My Plant

Plant Location text box: My Location

Client Name text box: AVEVA Solutions Ltd

Client Project No text box: TM6101

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

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

Copyright © 2014. 17 www.aveva.com

The form will look similar to the following:

Copyright © 2014. 18 www.aveva.com

The Project Selection Form containing the

The Login form appears. Type Password into the Password

The AVEVA Instrumentation Security Manager Module opens.