AVEVA Instrumentation

Instrument Engineer
User Guide
AVEVA Solutions Limited

Disclaimer
AVEVA Instrumentation provides instrument sizing calculations for estimation purposes only, end users of the
software should not rely on the calculations produced by the software for design purposes. End users should seek
the advice of certified equipment suppliers prior to specifying or purchasing equipment.

To the fullest extent permissible at law:

a) AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from viruses;

b) 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 customer, including any loss suffered by the customer 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;

c) 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
customer's claim is brought.

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
All intellectual property rights, including but not limited to, copyright in this manual and the associated software,
(including source code, object code, and any data) belongs to or is validly licensed by AVEVA Solutions Limited or
its subsidiaries.

All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may also not reverse
engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in
this publication may be incorporated into any third-party software, product, machine, or system without the prior
written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.

The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms
and conditions of the respective licence agreements, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the product is strictly prohibited.

Copyright 2000 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.

The AVEVA Instrumentation user interface is based on the Microsoft® Office Fluent™ user interface.

Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Group plc or its subsidiaries. AVEVA product names are
trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
trademarks belonging to AVEVA Group plc or its subsidiaries is strictly forbidden.

Microsoft® Office Fluent™ user interface. Fluent is a trademark of Microsoft Corporation and the Fluent user
interface is licensed from Microsoft Corporation. The Microsoft Office User Interface is subject to protection under
U.S. and international intellectual property laws and is used by AVEVA Solutions Limited under license from
Microsoft.

DevExpress® redistributables are used by AVEVA under license from Developer Express Inc. Copyright © 2000-
2014 Developer Express Inc.

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
Instrumentation Engineer User Guide

Revision Sheet

Date Version Comments / Remarks

March 2012 Copyright added to all pages.
March 2013 12.1 SP1 Updates incorporated
August 2013 12.1 SP2 Updates incorporated
July 2014 12.1 SP3 Updates incorporated
March 2016 12.1 SP4 Updates incorporated
December 2016 12.1.SP5 Updates incorporated
Instrumentation Engineer User Guide
 Instrument Engineer User Guide

Instrument Engineer User Guide

Contents Page

Instrument Engineer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Feature Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4
AVEVA Instrumentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4

User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Open an AVEVA Instrumentation Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Instrument Engineer Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Project Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Home Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Manage Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
List Tools Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Select a Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Select a Colour Scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Working with the Data Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Find and Replace Text in a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Advanced Grid Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Grid Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Using PickLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:5
Claims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:6

© Copyright 2000 to current year. i 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Options and Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Process Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Project Voltages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Property Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7
Add New Property Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8
Edit Property Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11
Delete Property Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12
Merge Property Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12
Import Property Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:14
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:16
Tag Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17
Define a New Tag Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17
Edit a Tag Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:20
Edit the List of Available Tag Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:22
Delete a Tag Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:24
Class Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:25
Create New Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:25
Edit Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:26
Delete Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:27
Export Classes to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:27
Import Classes from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:28
Assign Tag Formats to Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:33
Instrument Type Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:34
Create New Instrument Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:36
Edit Instrument Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:38
Delete Instrument Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39
Export the Instrument Type Catalogue to Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:40
Import the Instrument Type Catalogue from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:40
Loop Type Catalogue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:44
Create New Loop Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:45
Edit Loop Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:46
Delete Loop Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:47
Export and Import the Loop Type Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:47

Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Instrument List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

© Copyright 2000 to current year. ii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Manually Add a Tag to the Instrument List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:4

Copy Data from another Tag or a Catalogue Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9
Edit a Tag in the Instrument List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:10
Edit Tag Details - Tab Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:14
Edit Multiple Instruments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:21
Edit Multiple Instrument Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:21
Edit Tag Formats of Multiple Instruments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:26
Edit Engineering Data for Multiple Instruments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:29
Assign Instrument Tags to Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30
Assign Process Equipment and Process Lines . . . . . . . . . . . . . . . . . . . . . . . . 5:32
Associate Process Items to an Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:33
Remove Associations of Process Items to an Instrument . . . . . . . . . . . . . . . . . . . . . . . . . 5:33
View/Edit Instrument Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:34
Deleting Instruments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:35
Import Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
Import Instrument Data from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
AVEVA P&ID Instrument Tags Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
AVEVA Schematic Model Instrument Tag Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:42
AVEVA Engineering Instrument Tag Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:48
AVEVA Diagrams Instrument Tag Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:49
Copy Instruments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:51
To Copy a Single Tag (Instrument) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:51
Engineer Instrument Copy Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:51
Attachments (External Documents) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:55
View Attached Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:56
Attach a Document to an Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:56
Edit Attached Document Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:57
Delete Attached Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:57
Change Attached Document Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:57
Import Attached Documents Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:59
Export Attached Documents Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:63
I/O Allocations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:64
View the Project I/O List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:64
Import I/O Allocation Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:64
View Data by Form Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:70
Browse Data By Form Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:70
Edit Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:72

© Copyright 2000 to current year. iii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Edit Data for Multiple Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:73

Import Data from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:75
Instrument Loads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:75

Process Data, Equipment and Lines . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Edit Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
Edit Process Data for Multiple Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
Import Process Data from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6
Process Equipment and Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6
View Further Process Item Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7

Perform Instrument Sizing Calculations . . . . . . . . . . . . . . . . . . . . . . 7:1

Perform Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3

Loop List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Add a Loop to the Loop List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3
Edit a Loop in the Loop List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:8
Edit Multiple Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:11
Edit Multiple Loop Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:11
Assign Tags to Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:17
Select Existing Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:18
Copy Existing Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:19
To Copy a Single Loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:19
Engineer Copy Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:20
Delete Loops. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:24
Import Loop Data from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:25
AVEVA P&ID Loops Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:25
AVEVA P&ID Loop Data Import Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:25
Import Loops from AVEVA P&ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:25
AVEVA Schematic Model Loops Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:27
AVEVA Schematic Model Loop Data Import Configuration . . . . . . . . . . . . . . . . . . . . . . . . 8:28
Import Loops from AVEVA Schematic Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:28

Instrument and Loop Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1

Instrument Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2
Create Tag Wiring using Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2
Tag Wiring Check Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:6

© Copyright 2000 to current year. iv 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Loop Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:14

Create Loop Wiring using Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:14
Loop Wiring Check Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:17

Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
View/Edit Instrument Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Datasheet Data Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Copy Tag Data during Data Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:6
Convert Process Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:7
Datasheet Change Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:9
Datasheets List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:10
Add New Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:13
Edit Datasheet Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:15
Assign Tags To Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:18
Assign Tags from the Datasheet Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:18
Batch Assign Multiple Tags to Datasheets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:19
Delete Datasheet Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:21
Print Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:22
Datasheet Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:22
Create a Revision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:23
Edit a Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:24
Viewing and Editing Multiple Datasheet Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:25
Datasheet Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:26
Highlight Datasheets for Reissue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:27
View a List of Previous Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:27
Import Datasheets from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:28
Import Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:28
Accept Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:31
Datasheet Publishing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:32
Publishing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:32
Publish Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Merge Datasheets into a Single Document . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Assign Datasheets to the Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:35
Unassign Datasheets from the Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:36
Enter Basic Document Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:36
Save and Publish the Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:40
Document List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:41

© Copyright 2000 to current year. v 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Delete Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:42

Publish Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:43
Document Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:43
Datasheet Form Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:47
Datasheet Form Catalogue Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:48
Add a New Datasheet Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:49
Edit Datasheet Definition Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:52
Copy Existing Catalogue Datasheet Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:52
Map Database Fields to Datasheet Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:53
Assign a PickList to a Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:57
Checkboxes on Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:58
Auto Create Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:58
Import Catalogue From Other Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:60
Delete a Catalogue Datasheet Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:61

Instrument Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1

Instrument Catalogue Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Add a New Catalogue Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:2
Edit a Catalogue Instrument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:3
Import Catalogue Instruments from another Project . . . . . . . . . . . . . . . . . . . . 11:3
Import Instrument Catalogue Data from Excel . . . . . . . . . . . . . . . . . . . . . . . . . 11:6

Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export to XPS and PDF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export Selected Datasheet Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export Datasheets to a Specified Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2
Export Datasheets to Pre-Defined Folders with File Names in a Pre-Defined Format. . . . 12:3
Export to AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:5
AVEVA NET Export Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:5
Export Data from Grids. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:7
Export Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:8

Work Packs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1

Change Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:1
Audit Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:1
Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14:1

© Copyright 2000 to current year. vi 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:1
Instrument Sizing Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1
AVEVA NET Export Configuration Files . . . . . . . . . . . . . . . . . . . . . .B:1

© Copyright 2000 to current year. vii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

© Copyright 2000 to current year. viii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

1 Introduction

The Instrument Engineer User Guide is designed to help the user learn the Instrument
Engineer module of AVEVA Instrumentation. The guide describes how to create detailed
project instrument, loop, cable and wiring termination data.
Instrument Engineer manages all tasks typically handled by an Instrument Engineer during
a project life cycle, including instrument index data entry and reports, the generation of
instrument datasheets (specification sheets), process data import/entry and document
management (revision control, batch printing etc.). Instrument Engineer can be used to:
• Manage all project instrumentation data.
• Generate instrument datasheets or spec sheets automatically from the AVEVA
Instrumentation database in Microsoft Excel format (xls).
• Create instrument tags and their wiring data (terminals, junction box allocations,
cables, wire terminations and wire numbers) automatically from “wiring rules” directly
into AVEVA Instrumentation Wiring Manager database.
• All data from Instrument Engineer (Manufacturer, model number, range, P&ID drawing
number, I/O etc.) can be used in loop diagrams generated by AVEVA Instrumentation
Instrument Designer.
• Produce reports, for example:
Instrument List (or Instrument Index)
Loop List
I/O Allocations
Datasheet List
Changes to Instrument data
For more information refer to Feature Overview.

1.1 Feature Overview

Instrument Engineer provides instrument index data entry, change tracking, instrument
index type reports and definition of instrument data sheet (specification sheet) layouts and
generation of data sheets including document management. Instrument Engineer includes
the following features:

Instrument List (Instrument Index)

• User-definable Instrument List Grid Views (viewable columns, captions, default column
widths, default sort order and data filters).
• Adding/editing of instruments and maintenance of instrument list data including DCS/
PLC I/O information.
• Catalogue of instrument definitions for use when creating new instruments.
• Printing, sorting and filtering lists 'on the fly'.

© Copyright 2000 to current year. 1:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

• Export of Grid Views to Excel.

• Imports from Excel.
• Attaching of external documents/files to instrument tags (PDF, Word, Excel, various
picture formats etc.) and view these documents.
• Support for multiple tag formats (e.g 021-FT-800, FT-800, FT-021-800, 21-FC-800-T
etc., all with or without delimiters e.g. '-').
• Opening of datasheets directly from the Instrument List or instrument edit form.
• Datasheet document numbers can be updated from Datasheet list.
• Loop drawing numbers can be updated from Instrument Designer application.
• Hook-up (installation detail) document numbers can be updated from Instrument
Designer.
• Change management: Report all tags added, deleted and renamed. Report detail
changes in each field (e.g. Ex Rating. now: Exi was Exd:, DCS I/O now: AI was: etc.).
• Integration facilities for transferring and comparing data from other AVEVA products
and Excel.
• Export of instrument data to AVEVA NET.

Loop List
• Creation of new loops using the advanced user interface (pick lists, auto tag build, add
from instrument index etc.).
• Assigning of instruments to loops (from instrument list or create new tags on the fly).
• Editing of instrument data of any instrument assigned to a loop (i.e. access Instrument
List data from Loop).
• Definition of “wiring rules” for each loop tag and generate all field cables, equipment
terminals and wire terminations in Wiring Manager application. Refer to Instrument and
Loop Wiring.
Note: An AVEVA Instrumentation Wiring Manager license is required to access Wiring
Rules.

• Database fields are automatically transferred to Designer's Drawing List (creates new
drawings, if required, and updates loop number, service etc.).
• Loop Wiring check enables printing and previewing loop wiring without CAD.
• Change management: Report all loops added, deleted and renamed. Report detail
changes in each field (e.g. Loop No. now ABC was XYZ).
• Export of loop data to AVEVA NET.

Datasheets (Specifications)
• Assigning of instruments to datasheets (supports multiple tags per datasheet).
• Control of the printing and updating of datasheets in 'batch' mode.
• Document management - control document revisions etc.
• Datasheets use Microsoft Excel spreadsheets to define form layout for: Data Entry (if
fields are not updated from Instrument List, Document List or Process Data list).
Formatting/printing (user defined format).
• Datasheets are stand-alone documents (Excel spreadsheets) for easy exchange with
third parties.
• Importing and exporting of data from spreadsheets completed by vendor or client etc.,
highlight changes, accept and reject etc.
• Fully user-definable datasheet design (form layout and cell/database mapping and user
table design).

© Copyright 2000 to current year. 1:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

• Copy datasheet design (form layout/setup etc.) from other AVEVA Instrumentation
projects.
• Tools to copy data from other tags and/or datasheets.
• Auto-input default Process Units (user definable).
• Import/export of Process Data from/to Excel (highlight changes, accept/reject etc.).
• Viewing/editing of Process Data in a grid for easier management of process data
across multiple datasheets and tags.
• Viewing/editing of all Datasheet data by form type in a grid for easier management of all
data across multiple datasheets and tags.
• Change Management: Highlight changes between Issues (revisions) e.g. Pressure
Max now: 2000 kPa.
• Viewing of previous Issues.
• Printing of datasheets to PDF format files.
• Merging of multiple datasheets into single documents for joint publication. Documents
are accessible from Documents grid.
• Export of datasheet data to AVEVA NET.

Change Management
• Report all instruments/datasheets added, deleted and renamed.
• Report detail changes in each field (e.g. Model No now XXXX was YYYY).
• Log changes for future reporting (e.g. Tag FT-600 changed: Model No. 1234 was 4567
etc.).
• Audit Manager enables users to view changes by object type.

Reports
Instrument Engineer supports the following user definable reports:
• Instrument List (or Instrument Index), DCS I/O, PLC/ESD I/O etc.
• Loop List.
• Datasheet List (document list).
• Process Data List.
• Data by form type (e.g. Report all tag data on all 'Orifice Plates' datasheets).
• Tags assigned to data sheets.
• Database changes between Revisions.
• Reports and associated data can be exported to AVEVA NET.

User Security Rights

An AVEVA Instrumentation administrator can set security rights for users to enable/disable
access to AVEVA Instrumentation functionality including:
• Access to AVEVA Instrumentation application modules - users can be restricted from
using any module (license).
• Access to AVEVA Instrumentation objects can be restricted to read-only (e.g. a user
cannot add/edit a datasheets) or no access (i.e. the user cannot view an instrument
etc.).
Instrument Engineer objects include project entities such as cables, instruments, datasheets
etc., and catalogues, the importing of data etc.

© Copyright 2000 to current year. 1:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

By default, all new projects have the Security Rights features disabled for backward
compatibility with earlier versions of AVEVA Instrumentation. If security is required it must be
turned on using the AVEVA Instrumentation Security Manager. Users must then be allocated
to 'Security Groups' such as Engineers and Designers, Read-Only Users etc. Refer to the
AVEVA Instrumentation Security Manager User Guide for more information.

1.2 System Requirements

For the minimum system requirements needed to run AVEVA Instrumentation, refer to the
Installation User Guide.

1.3 AVEVA Instrumentation

For an overview of AVEVA Instrumentation, its features and benefits, refer to the Common
Functionality User Guide.

1.4 Guide Structure

Introduction a brief description of Instrument Engineer.

User Interface an overview of the user interface.

Options and Setup describes how to set various Instrument Engineer options,
preferences and data used when specifying instrument etc,
such as process units, tag formats etc.

Areas describes the Plant Areas on which all objects are based -
once the project is setup the first task is to add the various
plant areas to the project database.

Instrument List describes the main Instrument Index window used for adding/
editing instruments in the Index, and related facilities.

Process Data, describes how to view and edit instrument process data, and
Equipment and Lines how to view project process items (equipment and lines).

Perform Instrument describes how to carry out instrument sizing calculations.

Sizing Calculations

Loop List describes the main window for adding/editing Loops to the
project and to assign instruments, and related facilities.

Instrument and Loop how to use 'Wiring Rules' to auto generate typical field
Wiring instrument and loop wiring/cabling.

Datasheets describes how to view and edit instrument datasheets directly

from Datasheet List, Instrument List and Instrument Edit Detail
window.

Instrument Catalogue a catalogue of user-defined instrument definitions for use when

creating new instruments.

© Copyright 2000 to current year. 1:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

Exports includes facilities to export files of item data and report PDF
files for import into AVEVA NET.

Work Packs can be created with selected equipment and time scales for a
particular project.

Change Reports has an in-built Audit Manager that enables users to view
database changes made during the project in the database
audit log.

Reports an in-built Report Manager that enables users to create and

modify reports.

Instrument Sizing an appendix which covers all instrument sizing calculations.

Calculations

AVEVA NET Export explains the configuration required for AVEVA NET Export.
Configuration Files

© Copyright 2000 to current year. 1:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Introduction

© Copyright 2000 to current year. 1:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

2 User Interface

When Instrument Engineer starts up, the AVEVA Instrument Engineer window is displayed
showing the Home tab.

The Select an AVEVA Instrumentation Project window is also displayed.

Continue at:
• Open an AVEVA Instrumentation Project
• Instrument Engineer Tabs
• Select a Language
• Select a Colour Scheme
• Working with the Data Grid
• Find and Replace Text in a Grid
• Advanced Grid Filters
• Grid Manager
• Using PickLists

© Copyright 2000 to current year. 2:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

• Claims

2.1 Open an AVEVA Instrumentation Project

When an AVEVA Instrumentation module is started, the Select an AVEVA Electrical
Project window is displayed, from which the required project can be selected. refer to the
Common Functionality User Guide for details.

2.2 Instrument Engineer Tabs

On opening, the Engineer module each displays four tabs: Project, Home, Manage and
View. Once a grid is opened, an optional “List Tools” tab, named after that grid and
containing commands specific to that grid, is displayed, if there are any.
The rest of this section describes those tab options specific to Engineer.
For details of options common to all Instrumentation modules, refer to the Common
Functionality User Guide.

2.2.1 Project Tab

The Project tab includes the following Engineer-specific options:

Setup Sub Menu:

Edit Process Units Enables users to add and edit Process Units to AVEVA
Instrumentation. Refer to Process Units.

Project Voltages Enables users to define the voltages to be used on the project
when defining the power supply details of powered
instruments. Refer to Project Voltages.

Property Definitions Displays the Property Definitions window, used to add and edit
instrument and process properties.

Tag Formats Enables the user to select existing Tag Formats, create new
tag formats and edit existing tag formats.

Class Definitions Provides access to the Class Definitions window, used to

create and edit instrument and loop classes. Refer to Class
Definitions.

Type Catalogue Provides access to the Instrument Types Catalogue and

Loop Types Catalogue windows, used to create and edit
instrument types and loop types. Refer to Instrument Type
Catalogue and Loop Type Catalogue.

Set Datasheet Export Enables users to define rules to enable datasheet Excel files to
File Name / Folders be automatically renamed when copied out of AVEVA
Instrumentation into user-defined folders. Refer to Export
Selected Datasheet Files.

© Copyright 2000 to current year. 2:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

Drawings Export to Enables the user to select where the publishing folder is
External System located when exporting to an external system, which
Configuration executable format is required and fields of information written
for each published item. Refer to Datasheet Publishing.

AVEVA P&ID Import Displays the AVEVA P&ID Data Import Configuration
Configuration window. Refer to AVEVA P&ID Tag Data Import Configuration
for further information.

AVEVA Engineering Displays the AVEVA Engineering Data Import Configuration

Import Configuration window. Refer to AVEVA Engineering Import Configuration for
further information.

AVEVA Diagrams Opens a sub-menu consisting of the following options:

Import Configuration

AVEVA Schematic Displays the AVEVA Schematic Model

Model Import Login window. Refer to AVEVA
Configuration Schematic Model Import Configuration
for further information.

AVEVA Diagrams Displays the AVEVA Diagrams Login

Import window. Refer to AVEVA Diagrams
Configuration Instrument Tag Import for further
information.

2.2.2 Home Tab

The following Engineer-specific options are accessed from the Select option in the Lists
and Schedules section of the Home tab:
Under the List heading:

Instruments Displays the Instrument List, which is used to view, create and edit
instrument tags.

Loops Displays the Loop List, which is used to view, create and edit loops
and assign instruments to each loop.

Process Data Displays the Process Data List, a list of all process data fields for
tags assigned to datasheets.

Datasheets Displays the Datasheets List, which enables creation/editing of

project datasheets from the Datasheet List grid view.

Browse Data by Displays the View Data by Form Type list of instruments by the
Form Type associated with a selected datasheet form type, which enables
viewing of multiple datasheet tag data.

Document List Displays the Document List, which is used to view, create and edit
documents (collections of datasheets).

Instrument Displays the list of Instrument Loads, i.e. instruments which have
Loads power requirements.

Process Displays the list of Process Equipment. Refer to Process Equipment

Equipment and Lines.

© Copyright 2000 to current year. 2:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

Process Lines Displays the list of Process Lines. Refer to Process Equipment and
Lines.

Reports Display the Reports grid, showing Engineer-specific reports. Refer to

Reports.

Under the Catalogue heading:

Datasheets Displays the Datasheet Form Catalogue Grid, list of user defined
datasheet form definitions.

Instruments Displays the Instrument Catalogue of user-defined instrument

definitions for use when creating new instruments.

2.2.3 Manage Tab

The Manage tab includes the following Engineer-specific options:
In the Integration section:

Publish to AVEVA Used to export data to AVEVA NET. Refer to Export to AVEVA
NET NET.

AVEVA P&ID Import Used to import data from AVEVA P&ID. Refer to Import Tags
from AVEVA P&ID and Import Loops from AVEVA P&ID

AVEVA Diagrams Used to import data from AVEVA Diagrams. Refer to AVEVA
Import Configuration Diagrams Instrument Tag Import for further information.

AVEVA Engineering Opens a sub-menu consisting of the following options:

Import Configuration

AVEVA Schematic Used to import model data from AVEVA

Model Import Schematic Model. Refer to Import Tags
from AVEVA Schematic Model and
Import Loops from AVEVA Schematic
Model.

AVEVA Tags Used to import instrument data from

Integration AVEVA Tags. Refer to AVEVA
Configuration Engineering Instrument Tag Import for
further information.

In the Import section:

From Other Project Used to import instrument catalogue items from another project.
Refer to Import Catalogue Instruments from another Project

Attached Used to import attached documents details from an Excel

Documents spreadsheet. Refer to Import Attached Documents Data.

I/O Allocations Used to import I/O Allocations from an Excel spreadsheet. Refer
to I/O Allocations.

© Copyright 2000 to current year. 2:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

2.2.4 View Tab

All options on the view tab are common to all AVEVA Instrumentation modules.

2.2.5 List Tools Tab

The List Tools tab contains options specific to the grid which is currently being viewed, if
there are any. If no grid is open, the tab will not be displayed.
The name of the tab will be the name of the current grid.

2.3 Select a Language

If required, a different language can be selected. For a description of this functionality, refer
to the Common Functionality User Guide.

2.4 Select a Colour Scheme

If required, a different colour scheme can be selected. For a description of this functionality,
refer to the Common Functionality User Guide.

2.5 Working with the Data Grid

For a description of the generic functionality of Data Grids used in all AVEVA
Instrumentation applications, refer to the Common Functionality User Guide.

2.6 Find and Replace Text in a Grid

Any character string within a grid can be found, highlighted and optionally replaced. For a
description of this functionality, refer to the Common Functionality User Guide.

2.7 Advanced Grid Filters

Advanced (complex) filters can be applied to a grid. For a description of this functionality,
refer to the Common Functionality User Guide.

2.8 Grid Manager

The Grid Manager allows users to define their own sets of data fields (columns), default
column orders, default sorting and predefined data filters for most grids. For a description of
this functionality, refer to the Common Functionality User Guide.

2.9 Using PickLists

Many grid cells, datasheet cells and window fields can be, or must be, completed by
selecting from lists of values. These “Pick Lists” can be edited if required. For a description
of this functionality, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 2:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
User Interface

2.10 Claims
If a user attempts to edit an item which is currently being edited by another item, a message
is displayed to inform the user that the item is locked. For details of how to unlock claims,
refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 2:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

3 Options and Setup

A number of setup procedures may need to be carried out to specify options and for
entering and setting up data required when specifying engineering data. Continue at:
• Options
• Process Units
• Project Voltages
• Property Definitions
• Tag Formats
• Class Definitions
• Instrument Type Catalogue
• Loop Type Catalogue

3.1 Options
The Preferences window enables the user to:
• change the field label captions on the New and Edit Tag windows, on Edit Process
Equipment and Edit Process Line windows, and on the Datasheet Revision window,
• specify whether or not duplicate instrument tags are permitted as long as they are in
different project locations,
• specify whether the values of associated process lines can be used when performing
instrument sizing calculations, and
• to set other options related to datasheets.
To open the Preferences window, click Options on the Project tab.
The window is then displayed with the Instruments tab selected.

© Copyright 2000 to current year. 3:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Instruments Tab

In the Sizing Calculation Properties section, click Process Item Properties if the values
of associated process lines can be used when performing instrument sizing calculations. If
the values must be entered manually, leave the Instrument Process Properties option
selected.
The Grid Captions section can be used to specify alternative field captions for fields on the
New and Edit Tag windows (for creating and editing instruments), if required.
By default, the Grid Captions grid is inactive and the captions cannot be amended. To
activate the grid check the Use Gridview Captions for Instrument Edit dialog checkbox.
The user can now amend any of the Caption column fields.
The user can revert back to the default settings by un-checking the Use Gridview Captions
for Instrument Edit dialog checkbox.
By default, every instrument tag in the project must be unique. However, if required,
duplicate tags may be permitted as long as they unique within their project location. Check
the Allow duplicate Instrument Tags in different locations checkbox if this is required.

Note: Duplicate tags can only be created in Engineer. In other words, field devices created
in Equipment list in Wiring Manager, even though they are also in the Instrument List,
cannot have duplicate tags.

© Copyright 2000 to current year. 3:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Process Data Tab

The Process Data tab is used specify alternative field captions for fields on the Edit
Process Equipment and Edit Process Lines windows, if required.
By default, the grid is inactive and the captions cannot be amended. To activate the grid
check the Use Gridview Captions for Process Data Edit dialog checkbox. The user can
now amend any of the Caption column fields.
The user can revert back to the default settings by un-checking the Use Gridview Captions
for Process Data Edit dialog checkbox.

© Copyright 2000 to current year. 3:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Datasheets Tab

On the Datasheets tab, the user can set the number of revisions that appear in the history
list and change the default Field Name captions.
To change a Field Name caption, enter the required text in the Caption field and check the
Use box. If no text is entered into the Caption text fields and the Use checkbox is checked,
the default name shown in the Field Name column will be used.
If the Use checkbox is left un-checked, the default Field Name and any text in the Caption
field with be ignored.
The properties of each datasheet include an “of” value. For example, a datasheet may be
sheet 1 of 2. If this value (e.g. “2”) is to be calculated either by simply totalling the number of
sheets with the same datasheet number, the Use MAX sheet No. as value for Sheet Of:
should be checked.
If the first sheet number (i.e. the lowest) is to be used as the basis for this calculation, this
checkbox should be unchecked. In other words, when the lowest number is more than one,
then the sheets with lower numbers that are implied to exist are taken into account.
If this setting is changed, a message will be displayed when preferences are saved asking
whether or not sheet numbers for existing datasheets should be recalculated. If No is
clicked, the change will only be applied to datasheets subsequently created or updated.
If when an instrument tag is assigned to datasheet, the Requisition Number of the datasheet
is to overwrite that of the instrument, check the Overwrite Tag Requisition Number
checkbox (the default setting). Otherwise uncheck the checkbox.

© Copyright 2000 to current year. 3:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

If the checkbox is checked, if the datasheet is deleted or the instrument tag is unassigned
from it, the Requisition Number is deleted from the instrument tag details.
To save any changes made to the Instruments or Datasheets tabs and close the
Preferences window, click Save. Click Cancel to close the Preferences window without
any changes.

3.2 Process Units

The Process Units window is used to add, edit and delete process units and process
properties (types of process units), and to specify which process unit within each process
property is the default.
To access this window select Setup > Process Units from the Project tab.

Initially the window displays all units of all process properties.

To add a new process unit, first select the process property of the new unit from the drop
down list. The list of process units then changes to display only the process units of the
selected process property (select ALL from the drop down list to return to window to
displaying all units).
Click Add Item. A new row of fields is added to the bottom of the list. Enter the details of the
new unit in these fields.
To edit an existing type, click in the unit row and edit the details as required.
To delete an existing unit, select the unit row and click Remove Item. A message is
displayed requesting that the deletion be confirmed. Click Yes to proceed.
To set a unit as the default unit for a process property, check its Default checkbox.

© Copyright 2000 to current year. 3:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

If a unit is set as the default, and if the Apply Default Units checkbox of the Process Data
grid is checked, when a value of the unit's process property is entered for an instrument in
the Process Data grid, this unit is automatically applied to that value and added to it in the
grid.
To create a new process property, select the empty space in the drop down list (beneath
ALL in the list), and enter the name of the new process property. Click Add New Process
Property. A process property with the entered name is then created.
To delete a process property, delete all the units of that property.
To save changes and exit the window, click Save.
If more than one unit within a process property has been set as the default, a message is
displayed informing the user of this. The save will not take place and the window will remain
open. Rectify the problem and then click Save again.
To exit the window without saving any changes, click Cancel.

3.3 Project Voltages

The voltages to be used when defining the power supply details of powered instruments
must be selected from a pre-defined list of project voltages.
To edit the list of project voltages, select Setup > Project Voltages from the Project tab.
The Voltages window is then displayed:

The window lists those project voltages already set up.

To add a new project voltage, click New. The Voltage Detail window is then displayed:

© Copyright 2000 to current year. 3:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Enter the volts in the field provided and select the number of phrases and the frequency
from the lists of values.
Click Save. The Voltage Detail window is closed and new project voltage is added to the list
in Voltages window.
To edit an existing voltage, select it from the list and click Edit. The Voltage Detail window is
then displayed with the details of the selected voltage displayed.
Edit the details as required and click Save.
To delete a voltage, select it from the list and click Delete. A message is then displayed
requesting confirmation of the deletion. Click Yes to continue with the deletion.
Multiple records may be selected for deletion.

3.4 Property Definitions

AVEVA Instrumentation supports user-defined properties for use when creating instrument
datasheets and when defining instruments. These properties enable users to create
meaningful attribute names for data that has no other logical property or field within the
project database. Properties can belong to one of two Property Type groups:
• Instrument Properties.
• Process Properties.
Once created, a new property can be assigned to a catalogue datasheet. When datasheets
based on that catalogue datasheet are created, data can be assigned to that property.
The new property will also be displayed on the Properties tab of the Instrument and
Catalogue Instrument details windows and in the Process Data grid in Process Engineer,
enabling data to assigned to that property for an instrument. It can also be added to data
grids using the List Manager facility (see the Common Functionality guide for details), and
will be available as a DataLink to be assigned to drawings in the Designer module.

Note: If the user has a Catalogue Datasheet 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.

© Copyright 2000 to current year. 3:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

To display the Property Definitions window, select Setup > Property Definitions from the
Project tab:

Select InstrumentData from the Object Type list to view instrument properties and
ProcessData to view process properties.

3.4.1 Add New Property Definition

To add a property definition, with the appropriate properties list (instrument or process)
open, click New to display the Property Definition window.
For instrument properties:

© Copyright 2000 to current year. 3:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

For process properties:

© Copyright 2000 to current year. 3:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Enter values in the Property Name and Caption fields. The Property Name must be
completed and a message is displayed if no value is entered into the field, or if the name
has been used before. For example:

If no value is entered in the Caption field, the value in the Property Name is used.
Select the data type of the property (text, numeric (decimal), numeric (integer) or True/
False) from the Data Type list.
If the property type is process, if the new property has units, check the Has Units checkbox
(not present for instrument property types).
If the property is to be available when constructing queries for custom reports (refer to
Common Functionality documentation for details), check the Available for Custom
Reports checkbox. Note that a maximum of 1024 properties can be made available.
If data entered for the new property is to be restricted to the values in a pick list, click the
button in the Pick List field. The Select Picklist window is then displayed:

Select the required picklist by double-clicking on it or clicking on it and clicking Select. The
window then exits and the selected picklist is displayed in the Pick List field.

© Copyright 2000 to current year. 3:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

If a numeric data type was selected in the Data Type field, the minimum and maximum
values that may be entered for the property may be specified in the Minimum Value and
Maximum Value fields.
For any data type except True/False, entries for the property may also be validated against
a regular expression entered in the Regular Expression field.
Click OK to return to the Property Definition window.
When all the required data for the property definition has been entered, click OK to return to
the Property Definitions window, where the new definition will now be listed.
If the property type is process, if the Has Units checkbox was checked, a property definition
for the units of the new property is automatically created at the same time.
The name of a units property definition will be the name of the new property suffixed with the
units suffix specified in the Please enter a new Units Suffix window (see Preferences - the
default suffix is “Units”). The data type of units property definitions is text. Neither this or the
name may be changed.

3.4.2 Edit Property Definition

To edit an existing Property Definition, select it from the list and click Edit. The Property
Definition window will be displayed with the fields populated.

The Property Name field cannot be edited. All other attributes may be edited. Click OK to
exit the window and save any changes.

© Copyright 2000 to current year. 3:11 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

3.4.3 Delete Property Definition

To delete a Property Definition, select it from the grid list and click Delete. If the property is
currently being used, a message will be displayed informing the user that it cannot be
deleted.

If the selection has no tags associated with it, a message will be displayed asking the user
to confirm the deletion.

Click Yes to confirm the deletion and return to the Property Definitions window. The
deleted property will be removed from the grid view.
Click No to cancel the deletion and return to the Property Definitions window.

3.4.4 Merge Property Definitions

Property Definitions can be merged together by selecting the items to be merged in the grid
view and clicking Merge Properties. The Property Merge window will be displayed.

© Copyright 2000 to current year. 3:12 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The user can now enter a value for the Merged Property Name and Merged Property
Caption. The Merged Property Name is mandatory and a message is displayed if no value
is entered into the field.

Click OK to return to the Property Merge window.

If no value is entered for the Merged Property Caption field the value given to the Merged
Property Name is used.
The user has the option to delete the selected properties after the merge and keep only the
merged property or to keep the selected properties and add the newly merged property to
the grid list. To delete the selected properties, check the Delete existing Properties box.

Note: If the Delete existing Properties box is checked, all references will be set to the
new property.

The user must check one of the radio buttons in the bottom pane to select which one of the
existing properties values will be saved to the newly merged property.

© Copyright 2000 to current year. 3:13 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Note: If the Available for Custom Reports checkbox of any of the property definitions
being merged is checked, the checkbox for the merged property will also be
checked.

3.4.5 Import Property Definitions

Property Definitions can be imported from another project by clicking Import. The user will
be asked to select a project to import the properties from. If the properties are the same in
both projects, a message is displayed informing the user that there are no properties to
import in the selected project.

Click OK to return to the Property Definitions window.

When differences are found by the import process, the Property Definition Import window
is displayed listing the differences in the grid view.

© Copyright 2000 to current year. 3:14 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The user can now select individual properties to import by clicking their Select checkboxes,
or choose all the properties by clicking Select all. Clicking Cancel will return the user to the
Property Definitions window without merging any properties.
Click Import to start the import process. A progress bar will be displayed followed by the
Import Log window.

© Copyright 2000 to current year. 3:15 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The Import Log window shows the user the import status and displays the successfully
imported files in the grid view.
Clicking Close closes the Import Log window. The imported definitions will be displayed in
the Property Definitions window.

3.4.6 Preferences
Click Preferences to display the Please enter a new Units Suffix window.

Enter a new suffix for the names of automatically generated units property definitions for
process property definitions with units (see Add New Property Definition). Click Save. All
units property definition names are automatically updated to include the new suffix.

© Copyright 2000 to current year. 3:16 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

3.5 Tag Formats

In Instrument Engineer, Tag Numbers (including Loop Numbers) are constructed from the
attributes of instruments. For example, a Tag Number may be the concatenation of the
relevant plant area number and its function code, suffixed or prefixed with a sequential
number. Instrument Engineer is supplied with multiple Tag Formats, which can be edited.
New Tag Formats can also be defined.
Examples of different Tag Formats for a flow transmitter:

FT-600 Typical ISA style tag format.

33-FT-600 Typical ISA style tag format where Tag is prefixed with its plant area
number (33, separated by delimiters (dashes).

33FT600 Typical ISA style with area number but no delimiters.

Tag Formats are selected for each AVEVA Instrumentation instrument and loop class (refer
to Class Definitions for details) to define how the tag numbers of items within these classes
are formatted.
To view, edit and create Tag Formats click Setup > Tag Formats in the Project tab to
display the Tag Formats window.

The window initially lists the existing tag formats for instruments.
Select Loops from the Format for list to view the existing tag formats for loops.
Use the New button to create a new tag format. Continue at Define a New Tag Format.
Use the Edit button to edit an existing tag format. Continue at Edit a Tag Format.
Use the Delete button to delete a tag format. Continue at Delete a Tag Format.

3.5.1 Define a New Tag Format

To create a new tag format, select either Instruments or Loops as appropriate from the
Format for list, and click New.

© Copyright 2000 to current year. 3:17 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The Tag Format window is then displayed:

Enter a project-unique name for the new format in the Tag Format field. Complete the
Description and Remarks fields as required.
The instrument attributes (“tag codes”) that the tag format will consist of, their order and the
delimiters separating them (if any), are defined in the Tag Codes section of the window.

Note: The list of available tag codes can be edited via the Tag Codes button. This must be
done before any tag codes are specified for a tag format (the Tag Codes button is
disabled once a tag code is selected). See Edit the List of Available Tag Codes for
details.

To add a tag code, click “Click here to assign Tag Code...” in the Tag Code field. A list of tag
codes (i.e. instrument attributes) is then displayed:

© Copyright 2000 to current year. 3:18 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Click on the required attribute to select it from the list.

If a delimiter is required between the selected tag code and the next tag code that the tag
format is to consist of, select it from the list in the Delimiter field:

Leave the delimiter field blank if no delimiter (or space) is required.

Repeat the above procedure for each required tag code and delimiter until the tag code has
been constructed as required, for example:

© Copyright 2000 to current year. 3:19 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

An example tag number in the specified format is displayed above the list of tag codes.
To change the order of a tag code and its following delimiter, select it, and click Up or Down
as appropriate to move the tag code up or down one position in the list of codes.

To delete a tag code and its delimiter, select it and click Remove. A message will be
displayed requesting that the user conform the deletion. Click Yes to continue.
Click Apply to save the new tag format without exiting the window.
Click OK to save the new tag format and exit the window.
Click New to clear all the window of all data.
Click Cancel to exit the window without saving the new tag format.

3.5.2 Edit a Tag Format

To edit a tag format, select it and click Edit.
The Tag Format window is then opened with the details of the selected format displayed.
For example:

© Copyright 2000 to current year. 3:20 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Edit the details as required.

If the tag numbers of items that have previously been assigned the tag format are to be
updated to reflect the changes to the tag format, check the Update Tags checkbox.
If the changes are only to apply the tag numbers subsequently assigned this tag format,
leave the checkbox unchecked (the default setting).
Click OK or Apply to save the changes.
If the Update Tags checkbox was checked, the following warning message is displayed:

© Copyright 2000 to current year. 3:21 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Click Yes to continue.

Note: The list of available tag codes can be edited via the Tag Codes button. This must be
done before changes to the tag codes are specified for a tag format (the Tag Codes
button is disabled once a tag code is selected). See Edit the List of Available Tag
Codes for details.

3.5.3 Edit the List of Available Tag Codes

The list of available tag codes can be edited. This must be done before any tag codes are
specified for a new tag format, or any changes to tag codes specified for an existing tag
format (the Tag Codes button is disabled once a tag code is selected).
In the Tag Format window, click Tag Codes. Either the Select Tag Codes for Instruments
window or the Select Tag Codes for Loops window is then displayed, as appropriate (both
are used in the same way). For example:

The window lists all tag codes. Tag codes currently available when constructing tag formats
have their Select checkboxes checked.
To make further tag codes available, check their Select checkboxes.
To make a currently available tag code unavailable, uncheck its Select checkboxes. Note
that this cannot be done for tag codes that have been used to construct a tag format. A
message is displayed to inform the user of this if it is attempted.

Create New Tag Codes

New tag codes can be created. Click New. The Add New Tag Code window is then
displayed:

© Copyright 2000 to current year. 3:22 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Enter a unique name in the Field Name field.

In the Caption field enter the text that will be displayed to represent the tag code to users.
From the Datatype list select either Text, Numeric or Integer as required.
Specify the maximum number of characters for the new code in the Length field.
If required, enter an example of a value for the tag code in the Example text field.
Click New to clear all the window of all data.
Click OK or Apply to save the changes. The new code is then added to the list of tag codes
in the Select Tag Codes for Instruments / Loops window.

Note: New tag codes automatically have their Select checkboxes checked.

Edit Tag Codes

To edit an existing tag code, select it and click Edit. The Edit window is then displayed. For
example:

Modify the attributes of the tag code as required, then click OK or Apply. Note that the field
name cannot be edited.

© Copyright 2000 to current year. 3:23 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Delete Tag Codes

To delete tag codes, select them and click Delete. Multiple tag codes may be selected for
deletion.
A message will be displayed requesting that the user conform the deletion. Click Yes to
continue.
Note that system tag codes (i.e. those supplied with the product) and those that have
already been used to construct a tag format, cannot be deleted. A message is displayed to
inform the user of this if it is attempted.

3.5.4 Delete a Tag Format

A tag format can be deleted as long as it is not:
• In use as the tag format for an existing project tag number.
• Assigned to a project class.
To delete a tag format, select it and click Delete. Only a single tag format can be deleted at
time. If more than one is selected, a message will be displayed to inform the user of this.
If a single tag format was selected, the following message is displayed:

Click Yes to continue with the deletion.

If the tag format cannot be deleted because of one of the reasons given above, the
appropriate message is displayed to inform the user of this. For example:

If the tag format can be deleted, the deletion is then carried out.

© Copyright 2000 to current year. 3:24 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

3.6 Class Definitions

Classes are used to enable each instrument and loop type to have its own tag formats. Each
class is allocated tag formats. Each instrument and loop type/function is in turn allocated a
class.
For details of to create and edit tag formats, refer to Tag Formats.
For details of how to create and edit instrument and loop types (including how to assign
classes), refer to Instrument Type Catalogue and Loop Type Catalogue.
Classes are defined and allocated tag formats using the Class Definitions window,
accessed by clicking Setup > Class Definitions in the Project tab

The window initially lists the existing class definitions for instruments. To view the class
definitions for loops instead, select Loops from the Format for list.
Continue at:
• Create New Classes
• Edit Classes
• Delete Classes
• Export Classes to Excel
• Import Classes from Excel
• Assign Tag Formats to Classes

3.6.1 Create New Classes

Note: Classes can also be added to the project by importing them from an Excel
spreadsheet. Refer to Import Classes from Excel for details.

To create a new class for instruments, select Instruments from the Format for list. To create
a new class for loops, select Loops from the Format for list.
Next, click New. The Class Details window is then displayed:

© Copyright 2000 to current year. 3:25 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Enter the required details in the Class Name, Class Description and Remarks fields.
The Class Name and Class Description fields cannot be left blank. The entry in the Class
Name field must be unique for the project (i.e. it cannot be a name that another class
already has).
Click Apply to save the new class without exiting the window.
Click OK to save the new class and exit the window.
Click New to clear all the fields.
Click Cancel to exit the window without saving the new class.

3.6.2 Edit Classes

To edit an existing class, select it from the Class Definitions window and click Edit.
The Class Details window is then opened with the details of the selected class displayed.
For example:

Edit the details of the class as required. The Class Name and Class Description fields
cannot be left blank. The entry in the Class Name field must be unique for the project (i.e. it
cannot be a name that another class already has).
Click Apply to save the changes without exiting the window.
Click OK to save the changes and exit the window.

© Copyright 2000 to current year. 3:26 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Click Cancel to exit the window without saving the changes.

3.6.3 Delete Classes

To delete classes, select them from the Class Definitions window and click Edit. Multiple
classes may be selected for deletion.

Note: “System” classes, i.e. those supplied with the product cannot be deleted. Neither can
classes that have been assigned a tag format. A message will be displayed to inform
the user why the selected class cannot be deleted.

If classes that can be deleted were selected, the following message is displayed.

Click Yes to complete the deletion.

3.6.4 Export Classes to Excel

To export classes to an Excel spreadsheet, click Export to Excel.
A standard Windows Save file as window is then displayed.

© Copyright 2000 to current year. 3:27 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Select the filename, location and format in the usual way, and click Save to complete the
procedure.

3.6.5 Import Classes from Excel

To import classes from an Excel spreadsheet, click Import from Excel.
The Select excel workbook to import window is then displayed:

© Copyright 2000 to current year. 3:28 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Select the required file, and click Open.

If the selected file consists of more than one sheet, the user will be requested to select the
sheet that data is to be imported from, for example:

The Import Fields window is then displayed:

© Copyright 2000 to current year. 3:29 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

The Excel Column Name fields display the names of the columns in the spreadsheet. The
AVEVA Instrumentation Field fields displays the Instrumentation fields they are mapped
to.
To map an Excel Column to an AVEVA Instrumentation database field, click in the AVEVA
Instrumentation Field field adjacent to the relevant Excel Column Name field, and select
the required AVEVA Instrumentation field from a drop-down list. To exclude a field from the
import, click Clear button in the grid against the field to be excluded or select the blank entry
from the mapping drop-down list.

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the
first row in the Excel worksheet against fields names in AVEVA Instrumentation
Database (if not found then the field Captions - as set in the Grid Manager). If a
match is found then AVEVA Instrumentation automatically adds the Field Name to
the mapping list. The user can select a different field from the mapping list if required.

Defining a New Mapping Definition

Sets of column-field mappings can be saved and re-used for future imports. Define the
required mappings as described above, then click New. The Mapping Name and
Description fields are then displayed and the New button is replaced by a Save button.

© Copyright 2000 to current year. 3:30 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Once the name and description for the mapping have been entered, click Save and the
mappings will be saved and added to the Saved Mappings drop down.

Note: Data can also be imported by just clicking on the Import button. However it may
save time to save the mappings if an import with those mappings is to be performed
again.

AVEVA Instrumentation displays a window showing all the columns in the Excel Workbook
selected earlier.
Once the mappings have been set up, click Import.
AVEVA Instrumentation will display the Import Options window from which the user may
choose to import reports one by one or in a batch. The batch option processes all records
together then displays a differences report enabling users to accept or reject each change.
The one by one option displays a differences report for each record one at a time.

Click on the required option. If field mappings are being tested, it is recommended that the
Process each Record and Show Differences one by one option is selected. AVEVA
Instrumentation will then process the data and show any differences in the Import
Differences window:

© Copyright 2000 to current year. 3:31 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported Excel) data. If the one by one import option was selected, the
difference for a single record are listed. If the batch option was selected, differences for all
records are displayed.
To accept the changes either select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.

Note: To cancel ALL further importing click Stop Import.

After the import is complete, the Import Log window is displayed:

© Copyright 2000 to current year. 3:32 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The Import Log window shows the user the import status and displays the successfully
imported files in the grid view.

3.6.6 Assign Tag Formats to Classes

To assign tag formats to a class, select the class from the Class Definitions window and
click Assign Tag Formats.
The Tag Formats window is then displayed:

© Copyright 2000 to current year. 3:33 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

The window lists all tag formats for either instruments or loops as appropriate.
To assign a tag format to the class, click its Assign checkbox.
A primary tag format must be specified. To do so, check the appropriate Primary checkbox
of an assigned tag format. Doing so automatically unchecks any previously checked
Primary checkbox.
The primary tag format will be the format selected by default when creating an instrument or
loop associated with the class. The other assigned formats will also be available for
selection if required.
Click Save to exit the window and save the changes.
Click Close to exit the window without saving any changes.

3.7 Instrument Type Catalogue

An “instrument type” consists of the association of an instrument function with a class (see
Class Definitions). A description for the type may be entered, and an I/O type and location
specified.
When a new instrument is created, a class is specified. This in turn determines which tag
formats may be selected for the instrument, and if the selected tag format includes the
instrument function, which functions may be selected.
To open the Instrument Type Catalogue, select Setup > Type Catalogue from the Project
tab. The Instrument Types Catalogue window is then displayed:

© Copyright 2000 to current year. 3:34 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Note: By default, the Instrument Types Catalogue window is displayed when the above
option is selected. To open the Loop Type Catalogue window, select Loops from the
Catalogue for list. Select Instruments from the Catalogue for list to open the
Instrument Type Catalogue window again.

Whether or not a wiring rule and operation principle may be viewed when creating and
editing instrument types is controlled by the Enable Tag Catalogue mode checkbox. If the
checkbox is checked, additional fields are displayed in the Instrument Type Catalogue
window:

© Copyright 2000 to current year. 3:35 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

These additional fields are also available in the windows used for creating and editing
instrument types (see below).
Continue at:
• Create New Instrument Types
• Edit Instrument Types
• Delete Instrument Types
• Export the Instrument Type Catalogue to Excel
• Import the Instrument Type Catalogue from Excel

3.7.1 Create New Instrument Types

To add a new instrument type to the catalogue, click New. The Add New Instrument Type
window is then displayed:

© Copyright 2000 to current year. 3:36 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

From the Class Name list select the class of the instrument type. The Class Description
field is automatically completed with the description of the selected class.
In the Function field, enter the instrument type function. Enter a description of the function
in the Description field.
The Class Name and Function fields cannot be left blank. The combination of class and
function must be unique, i.e it cannot already been have assigned to another instrument
type.
From the System list, select either DCS or PLC as appropriate. The selection controls
which system fields (DCS or PLC/ESD) are automatically populated by the instrument type’s
I/O Type and Location details (see below) when an instrument of this type is created. This
field cannot be left blank.
If required, select an I/O type and location from the I/O Type and Location lists.
If the catalogue is in tag catalogue mode, additional fields are displayed:

© Copyright 2000 to current year. 3:37 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

If required, select a wiring rule and operating principle from the Wiring Rule and Operating
Principle fields.
Click Apply to save the new instrument type without exiting the window.
Click OK to save the new instrument type and exit the window.
Click New to clear all the fields.
Click Cancel to exit the window without saving the new instrument type.

3.7.2 Edit Instrument Types

To edit an existing instrument type, select it and click Edit. The Edit window is then
displayed. For example:

© Copyright 2000 to current year. 3:38 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Edit the details of the type as required.

The Function field cannot be left blank. The combination of class and function must be
unique, i.e it cannot already been have assigned to another instrument type.
Note that if the catalogue is in tag catalogue mode, Wiring Rule and Operating Principle
fields will also be displayed.
Click Apply to save the changes without exiting the window.
Click OK to save the changes and exit the window.
Click Cancel to exit the window without saving the changes.

Note: Editing an instrument type will not change details of instruments previously created
using that type. Only instruments subsequently created will be affected.

3.7.3 Delete Instrument Types

To delete instrument types, select them and click Delete. Multiple instrument types may be
selected for deletion. The following message will then be displayed:

Click Yes to complete the deletion.

© Copyright 2000 to current year. 3:39 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

3.7.4 Export the Instrument Type Catalogue to Excel

To export instrument types to an Excel spreadsheet, click Export to Excel.
A standard Windows Save file as window is then displayed.

Select the filename, location and format in the usual way, and click Save to complete the
procedure.

3.7.5 Import the Instrument Type Catalogue from Excel

The Instrument Type Catalogue catalogue can be imported from an Excel spreadsheet. It
can also be imported from another AVEVA Instrumentation project (see below).

Note: Importing an instrument type that already exists in the project will not change details
of instruments previously created using that type. Only instruments subsequently
created will be affected.

To import from a spreadsheet, click Import from Excel. The Select excel workbook to
import window is displayed:

© Copyright 2000 to current year. 3:40 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Browse for the spreadsheet that data is to be imported from and click Open. The Import
Fields window is then displayed:

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available

© Copyright 2000 to current year. 3:41 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Select an existing Field Mapping (if one for this Import type exists) from saved mappings
drop down or use the automatic mappings created by AVEVA Instrumentation and make
changes to these mappings (if required).
The Excel Column Name fields display the names of the columns in the spreadsheet. The
AVEVA Instrumentation Field fields displays the Instrumentation fields they are mapped
to.
To map an Excel Column to an AVEVA Instrumentation database field, click in the AVEVA
Instrumentation Field field adjacent to the relevant Excel Column Name field, and select
the required AVEVA Instrumentation field from a drop-down list. To exclude a field from the
import, click Clear button in the grid against the field to be excluded, or select the blank
entry from the mapping drop-down list.

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the first
row in the Excel worksheet against fields names in AVEVA Instrumentation Database
(if not found then field Captions, as set in the Grid Manager). If a match is found then
AVEVA Instrumentation automatically adds the Field Name to the mapping list. The
user can select a different field from the mapping list if required.

Define a New Mapping Definition

Sets of column-field mappings can be saved and re-used for future imports. Define the
required mappings as described above, then select the New command button. The
Mapping Name and Description fields are then displayed and the New button is replaced
by a Save button.

Once the name and description for the mapping have been entered, click Save and the
mappings will be saved and added to the Saved Mappings drop down.

Note: Data can also be imported by just clicking on the Import button. However it may
save time to save the mappings if an import with those mappings is to be performed
again.

AVEVA Instrumentation displays a window showing all the columns in the Excel Workbook
selected earlier.
Once the mappings have been set up, click Import.
AVEVA Instrumentation will display the Import Options window from which the user may
choose to import reports one by one or in a batch. The batch option processes all records
together then displays a differences report enabling users to accept or reject each change.
The one by one option displays a differences report for each record one at a time.

© Copyright 2000 to current year. 3:42 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Click on the required option. If field mappings are being tested, it is recommended that the
Process each Record and Show Differences one by one option is selected. AVEVA
Instrumentation will then process the data and show any differences in the Import
Differences window:

The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported Excel) data. If the one by one option was selected, the
difference for a single tag record are listed. If the batch option was selected, differences for
all records are displayed.
To accept the changes either, select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.

© Copyright 2000 to current year. 3:43 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.

Note: To cancel all further importing click Stop Import.

After the import is complete, the Import Log window is displayed:

The Import Log window shows the user the import status and displays the successfully
imported records in the grid view.

3.8 Loop Type Catalogue

An “loop type” consists of the association of a loop code with a class (see Class Definitions).
When a new loop is created, a class is specified. This in turn determines which tag formats
and loop codes may be selected for the loop.
To open the Loop Types Catalogue, select Setup > Type Catalogue from the Project tab.
The Instrument Type Catalogue window is then displayed (see Instrument Type
Catalogue).
From the Catalogue for list on that window, select Loops. The Loop Types Catalogue
window is then displayed:

© Copyright 2000 to current year. 3:44 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Note: Select Instruments from the Catalogue for list to return to the Instrument Type
Catalogue window.

Continue at:
• Create New Loop Types
• Edit Loop Types
• Delete Loop Types
• Export and Import the Loop Type Catalogue

3.8.1 Create New Loop Types

To add a new loop type to the catalogue, click New. The Add New Loop Type window is
then displayed:

© Copyright 2000 to current year. 3:45 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

From the Class Name list select the class of the loop type. The Class Description field is
automatically completed with the description of the selected class.
In the Loop Code field, enter the loop type code. Enter a description of the code in the
Description field.
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, in the screen example above (see Loop Type Catalogue), there are many loop
types with an order value of 99. These will be listed after those loop types with lower order
values, in alphabetical order. If no order number is entered for a loop type, it will appear at
the bottom of the list of values.
The Class Name and Loop Code fields cannot be left blank. The combination of class and
loop code must be unique, i.e it cannot already been have assigned to another loop type.
Click Apply to save the new loop type without exiting the window.
Click OK to save the new loop type and exit the window.
Click New to clear all the fields.
Click Cancel to exit the window without saving the new loop type.

3.8.2 Edit Loop Types

To edit an existing loop type, select it and click Edit. The Edit window is then displayed. For
example:

© Copyright 2000 to current year. 3:46 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

Edit the details of the type as required.

The Class Name and Loop Code fields cannot be left blank. The combination of class and
loop code must be unique, i.e it cannot already been have assigned to another loop type.
Click Apply to save the changes without exiting the window.
Click OK to save the changes and exit the window.
Click Cancel to exit the window without saving the changes.

Note: Editing a loop type will not change details of loops previously created using that type.
Only loops subsequently created will be affected.

3.8.3 Delete Loop Types

To delete loop types, select them and click Delete. Multiple loop types may be selected for
deletion. The following message will then be displayed:

Click Yes to complete the deletion.

3.8.4 Export and Import the Loop Type Catalogue

The Loop Type Catalogue can be exported to and imported from an Excel spreadsheet.
These facilities are identical to the ones provided for the Instrument Type Catalogue. Refer
to Export the Instrument Type Catalogue to Excel and Import the Instrument Type
Catalogue from Excel for details.

© Copyright 2000 to current year. 3:47 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Options and Setup

© Copyright 2000 to current year. 3:48 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Areas

4 Areas

All Engineering items in AVEVA Instrumentation must be assigned to a Plant Area. The first
task once the project is setup (refer to the Installation User Guide for further information on
project setup), is to add areas to the project database.
For a description of this functionality, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 4:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Areas

© Copyright 2000 to current year. 4:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5 Instrument List

The Instruments List is the main Instrument Index window for adding/editing instruments in
Engineer's Instrument Index. By default all instruments for the project are shown in the
Instrument List grid.
A “sub-grid” below the main grid lists the process items (equipment and lines) associated
with the currently selected instrument.
The viewable columns, their captions, column size and order are user definable using the
Grid Manager utility.
Instrument Engineer allows Instruments to be created without assigning them to a loop. For
example pressure gauges, relief valves etc.
A catalogue of common instrument definitions may be created for use when creating
instruments with common attributes.

Access the Instruments List

To open the Instrument List, click Select in the Grids and Schedules section of the Home
tab.
Select Instruments under the Lists heading from the list of grids that is then displayed. The
Instrument List grid is then displayed:

© Copyright 2000 to current year. 5:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Refer to Working with the Data Grid for information on the grid controls including selecting
an instrument record, and sorting and filtering the grid data.
The Instrument List consists of two grids. The main, upper grid displays details of the
instruments in the project.
The lower grid displays details of any process items (equipment and lines) assigned to the
instrument (see Assign Process Equipment and Process Lines) currently selected in the
upper grid. Switch between displaying equipment and lines in the lower grid by clicking the
Associated Process Equipment or Associated Process Lines button. Data in the lower
grid cannot be edited in Instrument Engineer. The lower grid can be closed and re-opened
by clicking Show Process Items in the Associated Items Section of the List Tools -
Instruments tab.

Add New Tags to the Instrument List

Instruments can also added to the Instrument List manually (see Manually Add a Tag to the
Instrument List), or by copying and changing existing instruments (see Copy Instruments).
Instruments may also be created from facilities accessible from the Loop List grid (the Loop
List grid is also used to assign existing instruments from the Instrument List to any loop).
Various facilities are also provided to import instruments from external sources. See Import
Instrument Data from Excel, AVEVA P&ID Instrument Tags Import, AVEVA Schematic
Model Instrument Tag Import, AVEVA Engineering Instrument Tag Import and AVEVA
Diagrams Instrument Tag Import.

Edit Instrument Data

To edit data, the user can either double-click on an instrument record, or select it and click
Edit on the Home tab. The user can also edit most column data directly in the Grid itself by
selecting the cell and entering a new value, selecting a value from a pick list etc. Columns
with a yellow coloured background cannot be edited directly in the grid.

Special Instrument List Grid Features

Some cells within the grid will display a small button in the right side of the cell when the
mouse cursor hovers over it, from which additional information related to the instrument can
be viewed and edited. The cells are:
• Loop No: If the instrument has been assigned a loop, clicking the Loop No cell button
will display the Edit Loop button. Refer to Edit a Loop in the Loop List).
If no loop is assigned, the user can assign a loop to the instrument using the Assign
Loop window. Refer to Assign Instrument Tags to Loops.
• Datasheet No: The Datasheet No cell button provides access to facilities for viewing
end editing the datasheet assigned to the instrument, if there is one. Refer to
Datasheet Data Entry.
If a datasheet is not yet assigned, the button provides access to facilities for creating a
new datasheet for the instrument. Refer to Add New Datasheets.

Grid PickLists
Some Instrument List grid cells contain pick lists (e.g. Area No, Location, Project Status,
Description, Manufacturer, I/O Type etc.). The value list in each pick list are generally
loaded from both the PickList library, plus any value that has been entered in a pick list's
field. Therefore manually adding a value into the pick list will add that new value to the pick
list for future use.

© Copyright 2000 to current year. 5:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: A pick list may be set so that grid cells must be completed with the values in it, i.e.
other values may not be manually entered.

Note: Any value manually added directly into a grid pick list does not get added to the pick
list's value list until the user clicks Refresh in the Records section of the Home tab,
or the grid is re-loaded (e.g. Instrument Engineer is re-started).

Note: The Location field can be used to change the project location of an instrument. If the
Allow duplicate Instrument Tags in different locations checkbox on the
Instruments tab of the Preferences window is checked (refer to Options for details),
instrument tags need not be unique in the project, as long as their location codes, as
specified here, are different. Be aware of this when changing the location of
instruments.

Refer to Using PickLists for further information on editing picklists.

Instrument List - List Tools Options

The following options are located on the List Tools - Instruments tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Actions Section

Show Un-Wired This checkbox is used to filter the grid so that only unwired
instruments are listed. Uncheck the checkbox to remove the
filter.

Sizing Calculation Used to perform sizing calculations for the selected instrument.
Refer to Perform Instrument Sizing Calculations for details.

Bulk Edit Used to edit multiple instrument numbers. Refer to Edit Multiple
Instrument Instrument Numbers for details.
Numbers

Bulk Update Tag Used to change the tag format of multiple instruments. Refer to
Format Edit Tag Formats of Multiple Instruments for details.

Attached Documents Section

Open for Selected Opens a list of the documents attached to the selected
instrument.

Attach Document Used to link the selected instrument to an external document

(e.g. Vendor Data PDF, Calibration Sheet Word Document etc.).

Change Folder Used to change the folder in which the attached documents of
selected instruments are located.

Refer to Attachments (External Documents) for more information on these two options.

© Copyright 2000 to current year. 5:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Associated Items Section

Associate Process Used to associate process equipment with the instrument

Equipment currently selected in the Instrument List.

Associate Process Used to associate process lines with the instrument currently
Lines selected in the Instrument List.

Remove Used to remove the association of the process items currently

Association selected in the lower grid of the Instrument List to the currently
selected instrument.

Show Process Used to show and hide the lower grid of the Instrument List,
Items which displays the process items associated with the instrument
currently selected in the Instrument List.

Refer to Assign Process Equipment and Process Lines for more information on these
options.

5.1 Manually Add a Tag to the Instrument List

To manually add a new instrument tag to a project, with the Instrument List open click New
in the Records section of the Home tab to display the Instrument Tag window:

This window is used to specify the tag of the new instrument.

Note: Instrument tags must be unique, either across the entire project, or within their
project location (as selected from the Location Code field in the Add New Tag
window - see below).
For duplicate tags to be permitted in different locations, the Allow duplicate
Instrument Tags in different locations checkbox on the Instruments tab of the
Preferences window must be checked (refer to Options for details).
If a tag number is not unique within the project or location, when the user attempts to

© Copyright 2000 to current year. 5:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

save the instrument, a warning message will be displayed to alert the user of this,
and the save will not take place.

The Class list consists of all classes to which tag formats have been assigned (refer to
Class Definitions for details of classes and tag format allocation). Select the required class.
The Tag Format list is then populated with all the tag formats that have been assigned to
the selected class (the class designated the primary class is automatically pre-selected).
Select the required tag format from this list.
The fields displayed under the Tag Format list will depend on the fields that the selected tag
format consist of (refer to Tag Formats for details). For example, if a different tag format
from that displayed above is selected, the displayed fields will change to reflect this. For
example:

Note that any delimiters defined for tag format are displayed after the fields they follow.
Complete the fields as required. Note that if the tag format includes “Function”, the list of
available functions will be restricted to those associated with the selected class (refer to
Instrument Type Catalogue for details).
The entered tag number is displayed at the bottom of the window. For example:

© Copyright 2000 to current year. 5:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

When the required tag data has been entered, click OK to display the Add New Tag
window:

© Copyright 2000 to current year. 5:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: Field captions in this window are user definable. To change captions use the
Preferences window, accessed from the Project menu.

The user can change the caption for each of the fields, for example Tag No: can be
changed to read Tag Number: For more information refer to Options and Setup.
To change the tag number, click the button next to the Tag No field to display the
Instrument Tag window again (see above).
If the selected tag format for the item includes “Area”, the Area No field displays the plant
area that the instrument is in, and cannot be changed. If the tag format does not include the
plant area, select it this field.
Any System, I/O Type, Location, Wiring Rule and Operating Principle details associated with
the instrument type of the selected tag format are automatically assigned to the new
instrument. These may subsequently be changed if required.

General Information about Fields

Location Code is the project location of the instrument. If the Allow duplicate Instrument
Tags in different locations checkbox on the Instruments tab of the Preferences window is

© Copyright 2000 to current year. 5:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

checked (refer to Options for details), instrument tags need not be unique in the project, as
long as their location codes, as specified here, are different.
Loop Order is used to sort instruments within a loop. It has no other purpose.
Loop Number and Loop Service are not editable fields. These fields are populated by data
from the loop to which the instruments is assigned, if applicable, refer to Assign Instrument
Tags to Loops.
Data on several of the fields in this window can be shared with a datasheet defined in the
Datasheet Catalogue for the project.
Wiring Config on the Detail tab is used to assign a wiring rule to the instrument. Refer to
Instrument Wiring. The name is used to auto generate the instrument termination
arrangement including terminal details, cable type, connection arrangement and wire ferrule
numbers etc. Typically this choice is made by the person responsible for detail wiring
design. It can also be edited from the Designer application. Specifying a wiring rule enables
AVEVA Instrumentation to create the field device and terminals in Wiring Manager.
PickLists (pull downs) can be updated with new values to choose from by selecting the
button to the right of most pull-down options. Exceptions are: Area (based on project Areas
defined), Description (based on the ISA Tag Catalogue and any previous value entered for
Description), Wiring Config (based of project Wiring Rules).
The Project Status, Location and Description PickLists are created from all previously
entered values for each respective field in the current project combined with all descriptions
entered in the PickList Manager (for Project Status and Location) or ISA Tag Catalogue
(for Description) for the project.
Data is grouped logically by Tabs. The tabs in the window enable the following information to
be added, viewed and edited:

General Information
Detail Design information related to Detail design
Datasheet Information related to the Datasheet (if any)
DCS System Information related to the DCS I/O
PLC/ESD System Information related to the PLC or ESD (Emergency Shutdown) I/O
User User Defined Fields
Alarms/Settings Information related to Alarms, Set Points etc.
Properties Additional instrument and process data properties
Power Supply Details of any power supply requirements for the instrument
Associated Items Not displayed until the instrument is saved. Process equipment
and lines associated with the instruments

For details of each tab refer to Edit Tag Details - Tab Details.

Note: The Associated Items tab is only displayed in the Edit version of the window. It is not
displayed in the Add New Tag version.

© Copyright 2000 to current year. 5:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.1.1 Copy Data from another Tag or a Catalogue Instrument

The information in the tabs can be populated by copying the information from another tag
and from a catalogue instrument.
To copy from another tag, click Copy Data. The Copying data to window is displayed.

Using the drop-down list Select a Tag to Copy from: select the appropriate tag. The
information from the selected tag will be displayed in the Proposed Value Column. If the
proposed value matches the existing value it will be displayed in black, otherwise it will be
displayed in red. The user can choose which values to copy by checking the boxes in the
Accept column. Checking the Accept All box checks all the boxes in the Accept column.
Click Save to accept the selected proposed values.
To copy from a catalogue instrument, click Copy From Catalogue. The Copying data to
window is then displayed. This works in the same way as the Copying data to window
accessed from the Copy Data window. Pick the catalogue instrument to copy from the
Select a Catalogue Instrument to Copy from list.
For information on creating, editing and viewing catalogue instruments, refer to Instrument
Catalogue.

© Copyright 2000 to current year. 5:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Copied data may subsequently be amended as required.

5.2 Edit a Tag in the Instrument List

To edit an instrument tag, highlight the tag in the Instrument List and click Edit in the
Records section of the Home tab, or double-click on the tag.
The Edit window is then displayed.

© Copyright 2000 to current year. 5:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: The Last Edit field displays the date and time when the instrument data was last
edited. The user name of the individual that performed the edit is displayed in a tool-
tip when the mouse cursor is hovered over the field. Click the button in the field to
display the Audit Manager, which will display a list of all the changes to the
instrument data.

Note: Field captions in this window are user definable. To change captions use the
Preferences window, accessed from the Project menu.

To change the tag number, click the button next to the Tag No field to display the
Instrument Tag window. For example:

© Copyright 2000 to current year. 5:11 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

See Manually Add a Tag to the Instrument List for details.

Note: Changing the Function will not result in any other attributes of the instrument being
changed (except the Function Description).

The user can change the description for each of the text boxes, for example Tag No: can be
changed to read Tag Number.
For more information refer to Options and Setup.

General Information about Fields

Location Code is the project location of the instrument. If the Allow duplicate Instrument
Tags in different locations checkbox on the Instruments tab of the Preferences window is
checked (refer to Options for details), instrument tags need not be unique in the project, as
long as their location codes, as specified here, are different. Be aware of this when
changing the location of instruments.
Loop Order is used to sort instrument within a loop. It has no other purpose.
Loop Number and Loop Service are not editable fields. The fields are populated by data
from the loop to which the instrument is assigned, if applicable, refer to Assign Instrument
Tags to Loops.
Data on several of the fields in this window can be shared with a datasheet defined in the
Datasheet Catalogue for the project.
Wiring Configuration on the Detail tab is used to assign a wiring rule to the instrument. Refer
to Instrument Wiring. The name is used to auto generate the instrument termination
arrangement including terminal details, cable type, connection arrangement and wire ferrule
numbers, etc. Typically this choice is made by the person responsible for detail wiring
design. It can also be edited from the Designer application. Adding a Wiring Config enables
AVEVA Instrumentation to create the field device and terminals in Wiring Manager.

© Copyright 2000 to current year. 5:12 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

PickLists (pull downs) can be updated with new values to choose from by selecting the
button to the right of most pull down options. Exceptions are: Area (based on project Areas
defined), Description (based on the ISA Tag Catalogue and any previous value entered for
Description), Wiring Configurations (based of project Wiring Rules).
The Project Status, Location and Description PickLists are created from all previously
entered values for each respective field in the current project combined with all descriptions
entered in the Picklist Manager (for Project Status and Location) or ISA Tag Catalogue for
the project.
Data is grouped logically by Tabs. The tabs in the window enable the following information to
be added, viewed and edited:

General Information
Detail Design information related to Detail design
Datasheet Information related to the Datasheet (if any)
DCS System Information related to the DCS I/O
PLC/ESD System Information related to the PLC or ESD (Emergency Shutdown) I/O
User User Defined Fields
Alarms/Settings Information related to Alarms, Set Points etc.
Properties Additional instrument and process data properties
Power Supply Details of any power supply requirements for the instrument
Associated Items Process equipment and lines associated with the instruments

For details of each tab refer to Edit Tag Details - Tab Details.
The information in the tabs can be populated by copying the information from another tag.
Clicking Copy Data displays the Copy data to window.

© Copyright 2000 to current year. 5:13 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Select the appropriate tag from the Select a Tag to Copy from: drop-down list. The
information from the selected tag will be displayed in the Proposed Value Column. If the
proposed value matches the existing value it will be displayed in black, otherwise it will be
displayed in red. The user can choose which values to copy by checking the boxes in the
Accept column. Checking the Accept All box checks all the boxes in the Accept column.
Click Save to accept the selected proposed values.

5.3 Edit Tag Details - Tab Details

Note: Field captions in this window are user definable. To change captions use the
Preferences window, accessed from the Project menu.

© Copyright 2000 to current year. 5:14 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

General

The General tab is used to enter typical common data for most instruments in the project.
The values available from the Instrument Range and Calibration Range, Units drop-down
lists are dependant on the Function type specified for the instrument. For example selecting
the AE Function displays the following values via the Units drop-down list:

whereas if the TT function was selected, the following values are available:

© Copyright 2000 to current year. 5:15 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Detail

The Detail tab is used to specify more detailed design data, including data typically required
for wiring, and installation information.
The Wiring Config PickList is used to assign a wiring rule to the instrument. The rule is
used to auto-generate the instrument termination arrangement including terminal details,
cable type, connection arrangement and wire ferrule numbers etc. Typically this choice is
made by the person responsible for detail wiring design. It can also be edited from the
Designer and Wiring Manager applications.
The button in the Junction Box cell displays an Assign window which enables the user to
assign the current instrument to a Junction Box.

Click Create Tag Wiring to display the Create Tag Wiring for window.
Clicking Tag Wiring Check displays a report showing wiring connectivity for the current tag.

© Copyright 2000 to current year. 5:16 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Refer to Instrument Wiring for further information on wiring facilities.

Datasheet

The Operating Principle PickList is used to pre-assign an instrument to a datasheet form

type.
The Sizing Calculation button is used to display windows used to perform sizing
calculations for the instrument. If no sizing calculations have been performed for the
instrument, the button will display a list of sizing calculation types to select from.
If a sizing calculation or calculations have been performed, the last type of calculation
performed is displayed under the button. The button will open the window used to perform
that calculation.
To select a different calculation to perform, double-click on the calculation type name under
the button. The list of calculation types is then displayed.
For more details, refer to Perform Instrument Sizing Calculations.
The Datasheet No command button provides direct access to the datasheet (if it exists). If
the tag is not yet assigned to a datasheet, the user is allowed to assign the current tag to an
existing datasheet using the Add a New Datasheet window. Refer to Add New Datasheets.
Otherwise it opens the associated datasheet. Refer to View/Edit Instrument Datasheets.

© Copyright 2000 to current year. 5:17 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

DCS System

The DCS System tab is used to assign DCS I/O information for the current tag.

Important: The DCS I/O Type must contain a non-blank value for the current tag to be
assigned to an I/O Module in Wiring Manager to enable wiring to be completed
to the I/O terminals.

PLC/ESD System

The PLC/ESD System tab is used to assign PLC or ESD (Emergency/Safety Shutdown) I/O
information for the current tag.

© Copyright 2000 to current year. 5:18 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Important: The PLC I/O Type must contain a non-blank value for the current tag to be
assigned to an I/O Module in Wiring Manager to enabled wiring to be completed
to the I/O terminals.

User

Instrument Engineer has twenty-four user defined fields (UserField1 to UserField24). The
User section shows sixteen of these user fields (the others can be added to any grid view).
Complete them as required.

Alarms/Settings

Use this tab to enter any alarm and settings data required for the instrument.

© Copyright 2000 to current year. 5:19 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Properties

Use this tab to enter additional instrument and process data properties as required. Click on
the appropriate Select Properties Type option and enter or edit values as required.

Power Supply

Use this tab to enter details of any power supply requirements for the instrument. If
appropriate, check the Requires Power Supply checkbox and enter the details in the fields
provided.

Note: The voltages used when defining the power supply details must be selected from a
pre-defined list of project voltages. Refer to Project Voltages for details.

If the instrument data is to be shared with AVEVA Electrical, click Share with Electrical.

Note: Unless sharing with AVEVA Electrical is enabled for the project the checkbox will be
disabled. Sharing with AVEVA Electrical may be enabled during project setup, or
afterwards (using the Project tab > Edit Project option). Refer to the Installation
User Guide for details.

© Copyright 2000 to current year. 5:20 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Associated Items

Note: The Associated Items tab is only displayed once the tag is saved.

This tab is used to view the process equipment and lines associated with the instruments, to
add further associations, and to remove associations. Refer to Assign Process Equipment
and Process Lines for details.
The Properties button is used to open the Edit Process Equipment or Edit Process
Lines window for the process item selected on the tab, in which further details of the item
can be viewed (see View Further Process Item Details).
All process item details are read-only.

5.4 Edit Multiple Instruments

Instruments can be edited in bulk, i.e. the instrument numbers of multiple items edited at
once.
The tag formats of multiple instruments may also be changed.
A facility is also provided to edit the engineering data of multiple items at once.
Continue at:
• Edit Multiple Instrument Numbers
• Edit Tag Formats of Multiple Instruments
• Edit Engineering Data for Multiple Instruments
Note: Changing the Function of an instrument will not result in any other attributes of that
instrument being changed (except the Function Description).

5.4.1 Edit Multiple Instrument Numbers

In Instrument Engineer the instrument numbers of multiple instruments can be edited at a
time.

Note: Instrument tags must be unique, either across the entire project, or within their
project location (see Manually Add a Tag to the Instrument List).
If a tag numbers are not unique within the project or location, when the user attempts

© Copyright 2000 to current year. 5:21 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

to save the instruments, a warning message will be displayed to alert the user of this,
and the save will not take place.

To edit multiple tag numbers, select the items, then click Bulk Edit Instrument Numbers in
the Actions section of the List Tools - Instruments tab.
The Instrument Number wizard window is then displayed.

The screen displays all the instruments that were selected for editing, grouped by tag
format. Click the + symbol to the left of each tag format to view details of each of the tags
with that tag format.

© Copyright 2000 to current year. 5:22 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Change the tag numbers of the selected instruments by editing all or some of the tag
number fields to make up the a new, project-unique tag number, as displayed in the New
Tag No fields.
Invalid (i.e. not unique) tag numbers are displayed in red in these fields. As each tag number
is changed, it is validated against the database to check its uniqueness. If validation is
successful, display of the tag number in the New Tag No field changes to green.
To edit the tag numbers in bulk instead of one at time, select the tags rows to be edited and
click Edit Selected Rows (click Select All Rows to select all the rows). The Multi Field
Edit (Bulk Edit) window is then displayed:

© Copyright 2000 to current year. 5:23 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Check the Select checkbox for all columns to be edited.

Enter the new values required in the Value columns.
The Copy first record's Data option will copy the data from first record in selection into the
window ready for editing. The data is not actually copied to the selected tags unless the
Select checkbox is selected and the Save button is clicked.
Click Save to save the new tag numbers. The Instrument Number window is then
displayed with the new tag numbers listed and validated.
Once tag numbers have been edited as required, click Next.
The Wizard then shows all the proposed instrument numbers.

© Copyright 2000 to current year. 5:24 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

To complete the process, click Save.

AVEVA Instrumentation then renumbers the items and displays a log of the changes:

© Copyright 2000 to current year. 5:25 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Close.

5.4.2 Edit Tag Formats of Multiple Instruments

The tag formats (see Tag Formats) of multiple instruments can be changed in a single bulk
edit. When the tag format of an instrument is changed, the tag number of the instrument will
be updated to reflect the new format.

Note: Instrument tags must be unique, either across the entire project, or within their
project location (see Manually Add a Tag to the Instrument List).
If a tag numbers are not unique within the project or location, when the user attempts
to save the instruments, a warning message will be displayed to alert the user of this,
and the save will not take place.

To edit the tag format of multiple instruments, select the items, then click Bulk Update Tag
Format in the Actions section of the List Tools - Instruments tab.
The Instrument Bulk Update Tag Format window is then displayed.

© Copyright 2000 to current year. 5:26 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The window displays the current tag numbers of the instruments selected in the Instruments
list, with their class names (see Class Definitions) and tag formats.
The required tag format to be applied to all the listed instruments is selected from the Tag
Format list.
By default, this list is restricted to the tag formats assigned to the classes of the listed
instruments. If the listed instruments are associated with different classes, only those tag
formats common to all those classes are available. Select the required format.
If required, the class of the listed instruments can be changed. Uncheck the Lock Class
checkbox.
The Class Name list then becomes available. Select the required class from this list. The
Tag Format list will then list the tag formats associated with the selected class. Select the
required format.
Once the required tag format has been selected, click Next.
The window then lists the instruments with the “proposed” tag numbers, i.e. the tag numbers
of the instruments with the selected tag format applied.

© Copyright 2000 to current year. 5:27 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The current tag number, and current and proposed classes and tag formats are also
displayed.
Only those instruments with their Select checkboxes checked will have their tag numbers
changed. They are checked by default. Uncheck Select checkboxes as required. The
Select All checkbox can be used to uncheck (and re-check) all Select checkboxes.
When the required instruments have been selected, click Next.
The following warning message is then displayed, warning that the “new” tag numbers
created by this procedure may duplicate those of other instruments.

Click Yes to continue, or No to close the message without continuing.

If Yes is clicked, the changes to the tag numbers then take place.
A log of the changes is then displayed, listing successful and failed changes to tag numbers.

© Copyright 2000 to current year. 5:28 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Close to exit the window.

5.4.3 Edit Engineering Data for Multiple Instruments

Multiple instruments tags and catalogue instruments can be edited.
To edit multiple records in the project, select multiple records in the Instrument List or
Instrument Catalogue then, click Edit in the Records section of the Home tab. The Multi
Field Edit (Bulk Edit) window is displayed.

© Copyright 2000 to current year. 5:29 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Actions required to edit multiple tags:

• Check the Select checkbox for all columns to be edited.
• Enter the new value required in the Value column
(repeat for all columns to be updated).
• Click Save to save the data to all selected tags.
Note: The Copy first record's Data option will copy the data from the first record selected
in the Grid View into the window ready for editing. The data is not actually copied to
the selected tags unless the Select checkbox is selected and the Save button is
clicked.

Note: The columns in this window are the same as the columns in the current Grid view as
defined by the Grid Manager.

5.5 Assign Instrument Tags to Loops

Instrument Tags can be assigned to loops from the Instrument List.

Note: It is not mandatory for each instrument tag to be assigned to a loop. For example
field pressure gauges and pressure relief valves are not normally members of a
control loop. They are stand-alone instruments.

© Copyright 2000 to current year. 5:30 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Hover the mouse over the Loop No cell for the instrument, and command button appears
as shown below:

If the button is clicked for a tag not currently assigned to a loop, the Assign Tag to Loop
window is displayed.

The Assign Tag to Loop window shows all loops already defined in AVEVA Instrumentation
for the current project.

© Copyright 2000 to current year. 5:31 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The list by default is filtered by the current instrument’s Plant Area number. Select a different
are area if required from the Display by Area list, or “All”.
The Match Number checkbox filters the list of loops by the Tag No. 'number' field. In the
example above, selecting Match Number would limit the list of loops to only those
containing '510' (the current instrument is numbered '510').

To Assign the Current Instrument to an Existing Loop

Double-click on the desired loop number in the list of loops, or select a Loop and click the
Assign command button.

Assign the Current Instrument to a New Loop

Click New Loop button to display the Add New Loop window, refer to Add a Loop to the
Loop List. Enter the loop details in the window and save the new loop.
AVEVA Instrumentation will return to the Assign Tag to Loop window, in which the new
loop will now be listed. The user can then assign the current instrument to the new loop.

Unassign an Instrument from a Loop

If an instrument is assigned to a loop then in the Instrument List selecting the button in the
Loop No cell will display the Loop Edit window (refer to Edit a Loop in the Loop List). To
unassign the tag from the loop select the instrument tag in the list of instruments and press
<Delete> key. The instrument is unassigned from the loop (it is not deleted).

5.6 Assign Process Equipment and Process Lines

The Instrument List consists of two grids. The main, upper grid displays details of the
instruments in the project.
The lower grid displays details of any process items (equipment and lines) assigned to the
instrument currently selected in the upper grid.
Further details of a process item can be viewed by double-clicking on it to open the Edit
Process Equipment or Edit Process Lines window (see View Further Process Item
Details).

Note: All details of process items are read-only in Instrument Engineering. They can also
be viewed in a grid. See Process Equipment and Lines.

Note: Instead of associating actual process items with an instrument, process data
associated with an instrument alternatively be recorded on an instrument-by-
instrument basis using the Process Data grid.
However, in this case, if for example, a process value (flow rate) of a line is changed,
this value must be updated for each and every instrument that is associated with that
line. Whereas if those instruments were associated with an actual process line item,
only a single change to that item would be required.

Switch between displaying equipment and lines in the lower grid by clicking the Associated
Process Equipment or Associated Process Lines button. Data in the lower grid cannot
be edited in Instrument Engineer.
The lower grid can be closed and re-opened by clicking Show Process Items in the
Associated Items Section of the List Tools - Instruments tab.

© Copyright 2000 to current year. 5:32 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.6.1 Associate Process Items to an Instrument

Select the instrument in the upper grid, then either:
• Click either Associate Process Equipment or Associate Process Lines in the
Associated Items Section of the List Tools - Instruments tab as appropriate.
or:
• Open the Edit window for the instrument (see Edit a Tag in the Instrument List) and
access the Associated Items tab. Select either Process Equipment or Process Lines
as required from the Process Item Type options, then click Associate.
The Select Process Equipment Tags or Select Process Lines window is then displayed.
For example:

The window lists the available process equipment or process lines. Check the Select
checkboxes for the equipment or lines to be associated with the instrument, then click OK.
The selected process items are then associated with the instrument and displayed in the
lower grid of the Instrument List and on the Associated Items tab of the Edit window.

Note: A process item can be associated with multiple instruments.

Note: Process items can also be assigned to instruments using the Import Instrument Data
from Excel procedure. Note that associated process items on the import spreadsheet
must exist in the project database, i.e. new process items cannot be created using
this interface.

5.6.2 Remove Associations of Process Items to an Instrument

Either:
• Select the process items to be removed in the lower grid of the Instrument List, then
click Remove Association in the Associated Items Section of the List Tools -
Instruments tab.
or:
• Open the Edit window for the instrument (see Edit a Tag in the Instrument List) and
access the Associated Items tab. Select either Process Equipment or Process Lines
as required from the Process Item Type options. Select the process items to be
removed, then click Remove.

© Copyright 2000 to current year. 5:33 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

A message is then displayed asking that the user confirm the removal of the association.
Click Yes to complete the procedure.

Note: Process items can also be unassigned from instruments using the Import Instrument
Data from Excel procedure by leaving blank the ProcessLines or ProcessEquipment
cells in the spreadsheet that would otherwise include the associated items.

5.7 View/Edit Instrument Datasheets

Instrument datasheets can be accessed for viewing and editing from the following places:
• From the Datasheets List, by double-clicking on the Datasheet record.
• From the Instrument List or Instrument Catalogue grid, by clicking on the button in
Datasheet No button (displayed when the mouse is hovered over the cell), as shown
below:

• Datasheet tab of the Edit window (refer to Edit a Tag in the Instrument List) click the
button next to the Datasheet No field.

The datasheet is then displayed. Refer to the Datasheet Data Entry for further details.

Note: If the instrument tag is not currently assigned to a datasheet, then Instrument
Engineer will instead display a window from where a datasheet can be assigned.

© Copyright 2000 to current year. 5:34 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Refer to Add New Datasheets for details.

5.8 Deleting Instruments

To delete an instrument tag, highlight the tag in the Instrument List and click Delete in the
Records section of the Home tab.
A message is then displayed requesting that the deletion be confirmed. For example:

Click Yes to continue.

If the selected instrument is associated with a datasheet or wiring, a message is then
displayed to inform the user of this, and again requesting that the deletion be confirmed. For
example:

Click Yes to complete the deletion.

If multiple instruments were selected in the Instrument List, the following window is
displayed:

© Copyright 2000 to current year. 5:35 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Delete to continue with the deletions. The messages displayed above will be
displayed for every selected instrument.
To delete all the selected instruments without any prompts being displayed, click Delete All
selected Instruments without prompt to confirm each before clicking Delete.
To delete all the selected instruments without prompts regarding the deletion of associated
wiring being displayed, click Delete Instrument Wiring without prompt to confirm each
before clicking Delete.

5.9 Import Data

Data can be imported into the Instrument List from various sources.

Note: Instrument tags must be unique, either across the entire project, or within their
project location (see Manually Add a Tag to the Instrument List).
Tag numbers that are not unique within the project or location cannot be imported.
If duplicate tag numbers are permitted in the project as long as their project locations
are different, the location of an instrument is taken into account when matching
imported tag numbers with those present in the database.

Continue at:
• Import Instrument Data from Excel
• AVEVA P&ID Instrument Tags Import
• AVEVA Schematic Model Instrument Tag Import
• AVEVA Engineering Instrument Tag Import
• AVEVA Diagrams Instrument Tag Import

5.9.1 Import Instrument Data from Excel

Instrument Engineer includes facilities to import instrument data into the AVEVA
Instrumentation project database from a Microsoft Excel Workbook.
For a description of this functionality, refer to the Common Functionality User Guide.

5.9.2 AVEVA P&ID Instrument Tags Import

Engineer includes facilities to import tag data into the Instrument List from the AVEVA P&ID.

© Copyright 2000 to current year. 5:36 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

AVEVA P&ID Tag Data Import Configuration

Before the user can import data from AVEVA P&ID, mappings between AVEVA P&ID and
AVEVA Instrumentation fields must be setup.
Click Setup > AVEVA P&ID Import on the Project tab to display the AVEVA P&ID Data
Import Configuration window.

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Both the AVEVA P&ID and the AVEVA Instrumentation mapping fields will be empty until the
user selects a project file. To select a project file, click the browse button to the right of the
AVEVA P&ID Project file text field. A browser window will then be displayed to enable the
user to navigate to the required project file.
Once the project file is selected, the AVEVA P&ID Data Import Configuration window will
refresh to display the default mappings.

© Copyright 2000 to current year. 5:37 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

If the user changes the AVEVA P&ID Project file setting, a warning message window will
be displayed informing the user that changing project files may corrupt the data.

Click Yes to accept the change of project or No to cancel.

The Elements Types field on the AVEVA P&ID Data Import Configuration window
enables the user to filter the data displayed in the grid view between Instrument and Loop
by selecting from the drop-down menu. The mapping data for Instrument is imported into
the Instrument List. The mapping data for Loop is imported into the Loop List.
To map a field, click on the drop-down list in the AVEVA Instrumentation Field column and
select a value from the list.

© Copyright 2000 to current year. 5:38 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Some of the fields in the AVEVA Instrumentation Field column are mandatory. If any of
these fields are not populated with a value and the user clicks Save, the user will prompted
with a message asking them to configure the mandatory field.

The user must click OK to return to the AVEVA P&ID Data Import Configuration window
and configure the mandatory field(s).
To save the changes made to the mapping fields, click Save. To cancel the changes made
to the mapping fields click Cancel.
If the AVEVA P&ID Project is changed after data has been loaded, the Schematic Model
item unique id's stored in AVEVA Instrumentation will potentially be invalid. An additional
checkbox, Remove all the links for items previously imported from this project is
displayed on the AVEVA P&ID Data Import Configuration window.

Checking this checkbox removes all the unique id's, enabling a subsequent import to correct
the tag list in line with the new project.

Import Tags from AVEVA P&ID

To import tags from AVEVA P&ID, select AVEVA P&ID Import from the Integration section
of the Manage tab to display the Import from AVEVA P&ID window.

© Copyright 2000 to current year. 5:39 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The Import from AVEVA P&ID window displays totals of new and existing tags with the
option to import all the tags in a batch or one at a time.
The batch option processes all records together then displays a differences report enabling
users to accept or reject each change. The one by one option displays a differences report
for each record one at a time.
If that are any tags previously imported from AVEVA P&ID that have since been deleted in
AVEVA P&ID, the total of these is also displayed, and the Process deleted tags button
becomes active. Click Process deleted tags if these tags are also to be deleted from
Instrumentation.
The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported AVEVA P&ID) data. If the one by one import option was
selected, the differences for a single record are listed.

If the batch option was selected, differences for all records are displayed.

© Copyright 2000 to current year. 5:40 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

To accept the changes either select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel all further importing click Stop Import
The Import Log then shows the user the import status and displays the successfully
imported files in the grid view.

© Copyright 2000 to current year. 5:41 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.9.3 AVEVA Schematic Model Instrument Tag Import

Engineer includes facilities to import tag data into the Instrument List from the AVEVA
Schematic Model.

AVEVA Schematic Model Import Configuration

Before the user can import data from AVEVA Schematic Model, mapping between AVEVA
Schematic Model and AVEVA Instrumentation fields must be setup.
Click Setup > AVEVA Diagrams Import Configuration > AVEVA Schematic Model
Import Configuration on the Project tab. The AVEVA Schematic Model Data Import
window is then displayed:

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

© Copyright 2000 to current year. 5:42 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The AVEVA Schematic Model Version field enables the user to chose which version of the
software to import from by selecting from a drop-down menu which list all the software
versions currently installed on the user's workstation.
The mapping fields will be empty until the user logs onto a Schematic database. Click the
browse button to the right of the AVEVA Schematic Model Version field. To connect to
Select Login to display the AVEVA Schematic Model Login window.

Complete the Project, Username, Password and Project MBD as appropriate and click
OK.
The Elements Types field enables the user to filter the data displayed in the grid view by
selecting an option from the drop-down menu. The mapping data for Offline Instrument,
Inline Instrument, Actuator and Instrument Valve is imported into the Instrument List.
The mapping data for Loops is imported into the Loop List.
To map a field, click on the drop-down list in the AVEVA Instrumentation Field column and
select a value from the list.

Some of the fields in the AVEVA Instrumentation Field column are mandatory. If any of
these fields are not populated with a value and the user clicks Save, the user will prompted
with a message asking them to configure the mandatory field.

© Copyright 2000 to current year. 5:43 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The user must click OK to return to the AVEVA Schematic Model Data Import
Configuration window and configure the mandatory field(s).
To save the changes made to the mapping fields, click Save. To cancel the changes made
to the mapping fields click Cancel.

Import Tags from AVEVA Schematic Model

To import tags from AVEVA Schematic Model, select AVEVA Diagrams Import > AVEVA
Schematic Model Import from the Integration section of the Manage tab display the
AVEVA Schematic Model Login window.
If data has previously been imported into the project from AVEVA P&ID, a message is
displayed warning the user that because of this no data can be import from AVEVA
Schematic Model.

Clicking OK will terminate the process.

If no data has previously been imported into the project, a message is displayed warning the
user that, after importing data from AVEVA Schematic Model the user will be prevented from
importing data from AVEVA P&ID.

If the user clicks No a message window is displayed informing the user that the import has
been terminated.

© Copyright 2000 to current year. 5:44 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click OK to return to the Instruments grid view.

If the user clicks Yes the AVEVA Schematic Model Login window is displayed.

Complete the Project, Username, Password and Project MBD as appropriate and click
OK.

Note: If the field mappings have not been set, the AVEVA Schematic Model Data Import
Configuration window is displayed. Refer to AVEVA Schematic Model Import
Configuration for further information. If the user clicks Cancel, a message window is
displayed informing the user that the import cannot continue without the Field
mappings being set.

If field mappings have been setup, the Import from AVEVA Schematic Model window is
displayed:

© Copyright 2000 to current year. 5:45 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The Import from AVEVA Schematic Model window displays totals of new and existing
tags with the option to import all the tags in a batch or one at a time.
The batch option processes all records together then displays a differences report enabling
users to accept or reject each change. The one by one option displays a differences report
for each record one at a time.
If that are any tags previously imported from AVEVA Schematic Model that have since been
deleted in AVEVA Schematic Model, the total of these is also displayed, and the Process
deleted tags button becomes active. Click Process deleted tags if these tags are also to
be deleted from Instrumentation.
The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported AVEVA Schematic Model) data. If the one by one import
option was selected, the differences for a single record are listed.

© Copyright 2000 to current year. 5:46 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

If the batch option was selected, differences for all records are displayed.

© Copyright 2000 to current year. 5:47 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

To accept the changes either select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel all further importing click Stop Import
The Import Log then shows the user the import status and displays the successfully
imported files in the grid view.

5.9.4 AVEVA Engineering Instrument Tag Import

Engineer includes facilities to import tag data into the Instrument List from the AVEVA
Engineering.

AVEVA Engineering Import Configuration

Before the user can import data from AVEVA Engineering, mappings between AVEVA
Engineering elements in a selected Engineering project and AVEVA Instrumentation
elements must be set up.
Click Setup > AVEVA Engineering Import Configuration on the Project tab to display the
AVEVA Engineering Data Import Configuration window.

© Copyright 2000 to current year. 5:48 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Setup the required mappings. The procedure is similar to that described in AVEVA
Schematic Model Import Configuration.

Import Tags from AVEVA Engineering

To import tags from AVEVA Engineering, select AVEVA Engineering Import from the
Integration section of the Manage tab display the AVEVA Engineering Login window.
The procedure is similar to that for importing from AVEVA Schematic Model. Refer to Import
Tags from AVEVA Schematic Model for details.

5.9.5 AVEVA Diagrams Instrument Tag Import

Engineer includes facilities to import tag data into the Instrument List from the AVEVA
Diagrams.

© Copyright 2000 to current year. 5:49 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

AVEVA Diagrams Import Configuration

Before the user can import data from AVEVA Diagrams, mappings between AVEVA
Diagrams elements in a selected Diagrams project and AVEVA Instrumentation elements
must be set up.
Click Setup > AVEVA Diagrams Integration Configuration > AVEVA Diagrams
Integration Configuration on the Project tab to display the AVEVA Diagrams Import
Configuration window.

Setup the required mappings. The procedure is similar to that described in AVEVA
Schematic Model Import Configuration.

Import Tags from AVEVA Diagrams

To import tags from AVEVA Diagrams, select AVEVA Diagrams Import > AVEVA
Diagrams Import from the Integration section of the Manage tab.
The procedure is similar to that for importing from AVEVA Schematic Model. Refer to Import
Tags from AVEVA Schematic Model for details.

© Copyright 2000 to current year. 5:50 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.10 Copy Instruments

In Engineer, existing instruments can be copied to create new tags. Facilities to copy both
single and multiple items are available:
• To Copy a Single Tag (Instrument)
• Engineer Instrument Copy Wizard
Note: Changing the Function of an instrument during a copy procedure will not result in any
other attributes of the instrument being changed (except the Function Description).

5.10.1 To Copy a Single Tag (Instrument)

Select the existing tag record in the Instrument List and select Copy Selected from the
drop-down menu next to the New option on the Home tab. The following message will then
be displayed:

Click Yes to open Instrument Copy Wizard. Refer to Engineer Instrument Copy Wizard for
details. Otherwise click No.
AVEVA Instrumentation will then display the Instrument Tag window. Enter the required tag
details and click OK.
The Add New Tag window is then displayed with the details of the copied instrument
displayed.
Change the details as required and click Save.
Refer to Manually Add a Tag to the Instrument List for details of the Instrument Tag and
Add New Tag window.

5.10.2 Engineer Instrument Copy Wizard

Engineer supports the copying of multiple existing instruments to create new tags. Copying
instruments using the Copy Wizard also copies each instrument's datasheets (if any). Using
the Instrument Copy Wizard, users can step through the renaming of the copied instruments
and their datasheets in a logical manner.
From the Instrument List, select the tag records in the Instrument List to be copied, and
click: Copy Selected from the drop-down menu next to the New button of the Home tab.
The first screen of the Copy window is then displayed:

© Copyright 2000 to current year. 5:51 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The screen displays all the instruments that were selected for copying, grouped by tag
format. Click the + symbol to the left of each tag format to view details of each of the tags
with that tag format.

To remove any tags from the copying process, uncheck their Select checkboxes. Uncheck
the Select All for Copying checkbox to uncheck all Select checkboxes.
Before continuing each selected instrument must be renamed by editing all or some of the
tag number fields that make up a new, project-unique tag number, as displayed in the New
Tag No fields.

© Copyright 2000 to current year. 5:52 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Invalid (i.e. not unique) tag numbers are displayed in red in these fields. As each tag number
is changed, it is validated against the database to check its uniqueness. If validation is
successful, display of the tag number in the New Tag No field changes to green.
To edit the tag numbers in bulk instead of one at time, select the tags rows to be edited and
click Edit Selected Rows (click Select All Rows to select all the rows). The Multi Field
Edit (Bulk Edit) window is then displayed:

Check the Select checkbox for all columns to be edited.

Enter the new values required in the Value columns.
The Copy first record's Data option will copy the data from first record in selection into the
window ready for editing. The data is not actually copied to the selected tags unless the
Select checkbox is selected and the Save button is clicked.
Click Save to save the new tag numbers. The Copy window is then displayed with the new
tag numbers listed and validated.
Once tag numbers have been edited as required, click Next.
The next screen shows all datasheets associated with the selected instruments (if any).

© Copyright 2000 to current year. 5:53 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Each selected instrument datasheet must be renamed by editing all or some of the fields
that make up the document number, including Sheet No. The new document number is
displayed in the New Doc No field.
The editing facilities on this screen are the same as on the first.
To continue click Next.

The wizard shows all the proposed instruments and datasheets.

To create the new items, click Copy.
AVEVA Instrumentation copies all the new items then stops and displays a log. For example:

© Copyright 2000 to current year. 5:54 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Close to exit the window.

5.11 Attachments (External Documents)

Engineer includes facilities to attach external documents/files to instrument tags and for the
viewing of these attached documents.
Attachments can include any Windows supported file. Attached documents might contain
information such as: vendor data, catalogue data, calibration certificates, hazardous area
certificates, site photographs, CAD files etc.
While AVEVA Instrumentation supports the attachment of any Windows file format, to view
an attached document however the user's workstation must provide access to the an
application to open the attachment's file format (e.g. a PDF viewer to open PDF files).
Continue at:
• View Attached Documents
• Attach a Document to an Instrument
• Edit Attached Document Details
• Delete Attached Document
• Change Attached Document Folders
• Import Attached Documents Data
• Export Attached Documents Data

© Copyright 2000 to current year. 5:55 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.11.1 View Attached Documents

To view the list of the attached documents for an instrument, select the instrument, then click
Open for Selected in the Attached Documents section of the List Tools - Instruments
tab to display the Attached Documents window.

Note: The Attached Documents window can also be viewed when editing a tag by clicking
Attached Documents on the General tab on the Edit window.

To open an attached document, highlight the document and click Open.

5.11.2 Attach a Document to an Instrument

To attach a new document to an instrument tag, either click New on the Attached
Documents window, or click Attached Document in the Attached Documents section of
the List Tools - Instruments tab.
The Attached Document Details window is displayed.

Note: Documents can also be attached by importing details of attached documents from an
Excel spreadsheet. See Import Attached Documents Data for details.

The file to be attached is selected by clicking the button to the right of the Document field. A
file browser window is then opened, enabling the user to navigate to the file. Select the
required file and click Open on the file browser window to close the file browser window and

© Copyright 2000 to current year. 5:56 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

return to the Attached Document Details window. The Document field will be populated
with the selected file and file path.
The user can select a document type from the Type drop-down list or manually enter a new
type. An optional description can be entered in the Description text box.
Check the Public checkbox if the attachment is to be shared with all the users on the same
project. Leave the Public checkbox box unchecked if only the current user is to have
access to the attachment.

5.11.3 Edit Attached Document Details

To edit a document attachment, highlight the attachment in the Attached Documents
window and select Edit to display the Attached Document Details window.

Edit the attachment details as required, as described in Attach a Document to an

Instrument.

5.11.4 Delete Attached Document

To delete an attached document, highlight the tag in the Attached Documents window and
click Delete.

Note: Only the association to the attached document is deleted. Neither the tag or the
actual document file is deleted.

5.11.5 Change Attached Document Folders

To change the folder in which the attached documents of multiple tags are located, highlight
the tag or tags in the grid, click Change Folder in the Attached Documents section of the
List Tools - Instruments tab. The Change Folder window is the displayed:

© Copyright 2000 to current year. 5:57 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The window lists the attachments of the selected tags and their current locations.
To select a new location, click the ... button. The Browse For Folder window is then
displayed. Browse for and select the required folder, and click OK.

© Copyright 2000 to current year. 5:58 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The selected location is then displayed in the New Folder Path field in the Change Folder
window.
To complete the procedure, click OK in the Change Folder window. The attached
documents for the tags are then moved to the specified location (the originals are not
deleted), and from now on the document attachments for the tags will be linked to that
location.

5.11.6 Import Attached Documents Data

Attached documents data can be imported from an Excel spreadsheet.
Open the Instrument List grid. and click Attached Documents in the Import section of the
Manage section. The Attached Document Import wizard window is then displayed:

© Copyright 2000 to current year. 5:59 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Browse and select the Excel file from which data is to be imported. Click Next >.
The next window shows all the columns in the Excel spreadsheet to be imported. Select an
existing Field Mapping (if one for this Import type exists) from saved mappings drop down
or use the automatic mappings created by AVEVA Instrumentation and make changes to
these mappings (if required).

© Copyright 2000 to current year. 5:60 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Excel Column Name fields display the names of the columns in the spreadsheet. The
AVEVA Instrumentation Field fields displays the Instrumentation fields they are mapped
to.
To map an Excel Column to an AVEVA Instrumentation database field click in the AVEVA
Instrumentation Field field adjacent to the relevant Excel Column Name field, and select
the required AVEVA Instrumentation field from a drop-down list. To exclude a field from the
import, click Clear button in the grid against the field that needs to be excluded or select the
blank entry from the mapping drop-down list.

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the first
row in the Excel worksheet against fields names in AVEVA Instrumentation Database
(if not found then field Captions - as set in the Grid Manager). If a match is found
then AVEVA Instrumentation automatically adds the Field Name to the mapping list.
The user can select a different field from the mapping list if required.

Defining a New Mapping Definition

Sets of column-field mappings can be saved and re-used for future imports. Define the
required mappings as described above, then select the New command button. The
Mapping Name and Description fields are then displayed and the New button is replaced
by a Save button.

© Copyright 2000 to current year. 5:61 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Once the name and description for the mapping have been entered, click Save and the
mappings will be saved and added to the Saved Mappings drop down.

Note: Data can also be imported by just clicking on the Import button. However it may
save time to save the mappings if an import with those mappings is to be performed
again.

Once the mappings have been set up, click Next >.
A list of instruments for which attached document details can be imported is then displayed.

Click Import to proceed with the import. The import then takes place. After the import is
complete, a log of the imported document details is displayed:

© Copyright 2000 to current year. 5:62 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Close the exit the import wizard.

5.11.7 Export Attached Documents Data

The Attached Documents grid in the Attached Documents window can be exported to
Excel by clicking Export To Excel. A Save file as dialogue is displayed, enabling the user
to navigate to a chosen destination and to name the Excel file.
The user can change the folder path by clicking Change Folder to display a file browser
window allowing the user to navigate to a different folder or create a new folder. If the new
folder path does not contain the attached file a message window is displayed.

Clicking Yes changes the folder path in the Attached Documents window, but the user
cannot view any attachments until the file is moved or copied to the new folder path. Click
No to cancel the folder path change.
To close the Attached Documents window and return to the Instruments grid view, click
Close.

© Copyright 2000 to current year. 5:63 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.12 I/O Allocations

Engineer includes facilities to view a list of project I/O include instrument allocation, and the
ability to import I/O allocation from an Excel spreadsheet.

5.12.1 View the Project I/O List

To view project I/O data in a grid, select I/O List from the Reports grid. The I/O List window
is then displayed:

The Tag No column displays the instrument which has been allocated to a particular I/O.

5.12.2 Import I/O Allocation Data

Engineer supports importing of I/O Allocations (tag to channel assignment) from an Excel
spreadsheet.
To import I/O Allocations the Excel file must contain the following information at a minimum:
Cabinet Name, I/O Module Name (or Tag), I/O module Catalogue Number (Model No),
Channel No (Point) and Tag No.
Since Engineer I/O Modules have several user definable property fields, users can also
import additional data such as Rack, Slot, System, Chassis etc into those I/O module
property fields by including that data in the Excel file being imported.

Important: Tags cannot be assigned to an I/O Module through importing unless the Tag No
already exists in the Engineer Instrument List.

Prior to importing, the Excel Worksheet must be in a simple tabular format (columns and
rows) and the first row should contain unique column names (headings) so that Engineer
can identify the column's data to enable 'mapping' to Engineer database fields. The column
names are user-definable but must not be duplicated. Engineer will only import column data
that contains a heading. Furthermore, the Excel file must contain the following mandatory

© Copyright 2000 to current year. 5:64 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

columns/data: Cabinet Name, I/O Module Name (or Tag), I/O module catalogue number,
Channel No and Tag No.
If the I/O Module Tag/Name does not exist, Engineer will automatically create an I/O module
with that Tag/Name in the Cabinet listed in the Excel workbook.
Once an Excel Worksheet is formatted accordingly and selected for import, users must
'map' each Excel column name (heading) to an Engineer database field using the Engineer
import utility. The data can then be imported into Engineer. The import utility will check if
mandatory columns exists in the Excel file and Mappings. While processing I/O Modules to
be imported, if a Module already exists in the database Engineer will show the differences
between the imported data and the Engineer data, allowing the user to accept/reject the
proposed changes on a record by record (and field by field) basis. If the I/O Module does not
exist in Engineer and the user accepts to import, Engineer will create a new I/O Module in
the Equipment (Cabinet) specified in the Excel data.
To start the import procedure, open the Instrument List grid or the Loops grid. Then click I/O
Allocations in the Import section of the Manage section. The I/O Allocation Import wizard
window is then displayed:

Click Browse and select the Excel file from which data is to be imported. Click Next >.
The next window shows all the columns in the Excel spreadsheet to be imported. Select an
existing Field Mapping (if one for this Import type exists) from saved mappings drop down
or use the automatic mappings created by AVEVA Instrumentation and make changes to
these mappings (if required).

© Copyright 2000 to current year. 5:65 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Excel Column Name fields display the names of the columns in the spreadsheet. The
AVEVA Instrumentation Field fields displays the Instrumentation fields they are mapped
to.
To map an Excel Column to an AVEVA Instrumentation database field, click in the AVEVA
Instrumentation Field field adjacent to the relevant Excel Column Name field, and select
the required AVEVA Instrumentation field from a drop-down list. To exclude a field from the
import, click Clear button in the grid against the field that needs to be excluded or select the
blank entry from the mapping drop-down list.

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the first
row in the Excel worksheet against fields names in AVEVA Instrumentation Database
(if not found then field Captions - as set in the Grid Manager). If a match is found
then AVEVA Instrumentation automatically adds the Field Name to the mapping list.
The user can select a different field from the mapping list if required.

Define a New Mapping Definition

Sets of column-field mappings can be saved and re-used for future imports. Define the
required mappings as described above, then select the New command button. The
Mapping Name and Description fields are then displayed and the New button is replaced
by a Save button.

© Copyright 2000 to current year. 5:66 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Once the name and description for the mapping have been entered, click Save and the
mappings will be saved and added to the Saved Mappings drop down.

Note: Data can also be imported by just clicking on the Import button. However it may
save time to save the mappings if an import with those mappings is to be performed
again.

Once the mappings have been set up, click Next >.
The list of I/O Modules in the selected Excel file is then displayed.

To import the instrument allocation data for an I/O Module, check its Select checkbox.
Check the Select all checkbox to check all the Select checkboxes.
Click Next >.
The data in the spreadsheet is then validated. Lists of I/O Modules that cannot be imported
and these reasons for this are then displayed. For example:

© Copyright 2000 to current year. 5:67 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

The list of I/O Modules than can be imported is then displayed. For example:

© Copyright 2000 to current year. 5:68 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Import to proceed with the import. The import then takes place. After the import is
complete, a log of the imported document details is displayed, including the I/O allocations
that have taken place as a result of the import. For example:

© Copyright 2000 to current year. 5:69 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Close the exit the import wizard.

5.13 View Data by Form Type

Engineer includes a grid for viewing and editing data for multiple instruments by form type.
For example, users may view all data for all Control Valve tags. This enables faster entry
with copy and paste functionality and enables users to view data for similar datasheets and
immediately see gaps in data or inconsistent data etc.
The grid window also supports editing of multiple tags from a single multi-editing window
enabling the easy bulk editing of multiple tags.
Continue at:
• Browse Data By Form Type
• Edit Data
• Edit Data for Multiple Tags
• Import Data from Excel

5.13.1 Browse Data By Form Type

To open the Browse Data by Form Type grid, click Select in the Grids and Schedules
section of the Home tab.
Select Browse Data by Form Type from the list of grids that is then displayed. The Browse
Data by Form Type grid is then displayed:

© Copyright 2000 to current year. 5:70 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Select a form type from the Datasheet Form Type drop-down menu. The required data is
then displayed in the grid.

Note: The fields in this grid depend on the actual fields mapped to the current Form Type
selected.

Display the datasheet window by clicking on the button that is displayed in the DocNo cell
when the mouse is hovered over the cell. Refer to Datasheet Data Entry for details.
Instrument data may be edited by clicking on the button that appears in the Tag No cell
when the mouse is hovered over the cell. Refer to Edit a Tag in the Instrument List for
details.

Note: Any change made to data in this grid is not updated on the respective datasheet until
the datasheet is opened (or updated from the Datasheet List).

© Copyright 2000 to current year. 5:71 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Browse Data by Form Type - List Tools Options

The following options are located on the List Tools - Browse Data by Form Type tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Actions Section

Datasheet Form Type Used to select the required form type, as described above.

Apply Default Units If this option is checked then on update of a value in grid cell,
the default unit is appended to the value if no unit is present.

Sizing Calculation Used to perform sizing calculations for the selected

instrument. Refer to Perform Instrument Sizing Calculations
for details.

Hide\Show Grid Displays a Hide\Show Grid Columns window, enabling a

Columns user to temporarily hide or un-hide columns as required.

Invert Hide\Show Makes the hidden column visible and hides currently visible
Grid Columns columns.

Convert Process Units

A user can convert process units. Refer to Convert Process Units for more information.

5.13.2 Edit Data

Data for a tag may be displayed in a vertical format, enabling users to view all the field data
more conveniently than in a conventional horizontal grid.
From the Browse Data By Form Type grid, select the tag record and click Edit in the
Records section of the Home tab to display the Editing Data for: window.

© Copyright 2000 to current year. 5:72 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Note: The fields in this window depend on the actual fields mapped to the current Form
Type selected in the Browse Data By Form Type grid.

Note: If more than one record is selected in the Browse Data By Form Type grid when Edit
is selected, the Multi Field Edit (Bulk Edit) window is displayed instead. Refer to
Edit Data for Multiple Tags.

5.13.3 Edit Data for Multiple Tags

Data for multiple instruments can be edited at the same time.
In the Browse Data By Form Type grid, select the multiple instrument records, then click
Edit in the Records section of the Home tab. A message is displayed.

© Copyright 2000 to current year. 5:73 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

Click Yes. The Multi Field Edit (Bulk Edit) window is then displayed:

Check the Select checkbox for all columns to be edited.

Enter the new values required in the Value columns.
The Copy first record's Data option will copy the data from first record in selection into the
window ready for editing. The data is not actually copied to the selected tags unless the
Select checkbox is selected and the Save button is clicked.
Click Save to save the changes.

© Copyright 2000 to current year. 5:74 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

5.13.4 Import Data from Excel

Instrument Engineer includes facilities to data associated with a specific datasheet form
type into the AVEVA Instrumentation project database from a Microsoft Excel Workbook.
To import an Excel datasheet, with the Browse Data By Form Type open and the form type
selected, click From Excel in the Import section of the Manage tab.
The Import Items window is then displayed:

The window enables users to specify which type or types of data are to be imported. Check
the appropriate checkboxes and click Save.
The Select excel workbook to import window is then displayed for the first type of item
(e.g. datasheet list data) the user specified was to be imported. Select the spreadsheet that
the first type of data is to be imported from and click Open.
The import procedure then continues in the standard way, as described in the Common
Functionality User Guide.
Once the import for the first selected item type is completed (or if it is cancelled), the user
will be prompted to select a spreadsheet for the next selected data type (if there is one),
until all import procedures are completed.

Note: Whenever the import detects a duplicate column name, it will append the column
number on the end, so the end will result will be, for example, “Rating_A” and
“Rating_B”.

5.14 Instrument Loads

Details of instruments identified as having power requirements, i.e. those which are loads,
can be viewed in a separate list.
To open the Instrument Loads List, click Select in the Grids and Schedules section of the
Home tab.
Select Instrument Loads under the Lists heading from the list of grids that is then
displayed. The Instrument Loads grid is then displayed:

© Copyright 2000 to current year. 5:75 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument List

All data is the grid is display-only. It cannot be edited, deleted or added to.

Note: Load requirements are specified on the Power Supply tab of the Edit window of
instruments. See Edit Tag Details - Tab Details.

© Copyright 2000 to current year. 5:76 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

6 Process Data, Equipment and Lines

In AVEVA Instrumentation, there are two methods of recording the details of process data
associated with an instrument (for example, for inclusion on instrument datasheets):
• The process data can be recorded against each specific instrument using the Process
Data grid.
In this case, if for example a process value (flow rate) of a line changed, this value must
be updated for each and every instrument that is associated with that line.
• Instruments can instead be associated with actual process equipment and process line
items in the AVEVA Instrumentation project database (see Assign Process Equipment
and Process Lines).
These items of equipment and lines have their own specific process and physical
properties. If a process value such as flow rate changes, this change is made against
the line, not the instruments associated with that line i.e. in one place. All instruments
associated with that line that automatically reference this single updated value, thus
ensuring data consistency on deliverables such as instrument datasheets.
These items are created and edited in the Process Engineer module, but can be
viewed in the Instrument Engineer module.
Continue at:
• Process Data
• Process Equipment and Lines

6.1 Process Data

In Engineer, process data for multiple instruments may be viewed in a grid format. This
enables faster data entry using copy and paste functionality, and enables users to view like
instruments and more easily see missing or inconsistent data etc.
The grid window also supports editing of multiple tags from a single multi-editing window.
To view and edit process data in the Process Data Grid, click Select in the Grids and
Schedules section of the Home tab.
Select Process Data from the list of grids that is then displayed. The Process Data grid is
then displayed:

© Copyright 2000 to current year. 6:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

Instrument data may be edited by clicking on the button that is displayed in the Tag No cell
when the mouse is hovered over that cell.

Note: Any change made to data in this grid is not updated onto the respective datasheet
until the datasheet is Opened (or Updated from the Datasheet List).

The grid supports Grid Manager for user defined grid layouts. AVEVA Instrumentation
'remembers' the last Grid View used and starts with that view.

Note: Grid Manager allows each user to define their own sets of data fields/columns,
column order, predefined filters and sort order for the Process Data List. Each set is
known as a 'View'. For example, users can set various views to show only certain tag
types (e.g Control Valves, Pressure Transmitters etc.) and then limit the fields to
show only those specific to that tag type (e.g For a Pressure Transmitter show
PressureMax, TemperatureDesign and exclude LevelMax etc.).

By default all fields in the AVEVA Instrumentation database table 'ProcessData' are shown
along with a few base InstrumentList fields (e.g TagNo, P&IDNo etc.).

Process Data - List Tools Options

The following options are located on the List Tools - Process Data tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Actions Section

Apply Default Units If this option is checked then on update of a value in grid cell,
the default unit is appended to the value if no unit is present.
To change a project's default units use the Setup > Edit
Process Units option from the Project tab. Refer to Process
Units.

Hide\Show Grid Displays a Hide\Show window allowing a user to temporarily

Columns hide or un-hide columns as required.

© Copyright 2000 to current year. 6:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

Invert Hide\Show Grid Makes the hidden column visible and hides currently visible
Columns columns.

Sizing Calculation Used to perform sizing calculations for the selected

instrument. Refer to Perform Instrument Sizing Calculations
for details.

Insert Special Displays a menu enabling insertion of special characters into

Characters a grid cell:

Change Process Displays a window that lists all the supported process units for
Units the value in the currently selected cell and allows the user to
change from one unit type to another unit type without
changing the value. For example 100°C to 100°F.

Convert Units Displays a window that lists all the supported process units for
the value in the currently selected cell and allows the user to
change from one unit type and to change the value to reflect
this. For example 100°C to 212°F.

© Copyright 2000 to current year. 6:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

6.1.1 Edit Data

Process data may be displayed in a vertical format, enabling users to view all the field data
more conveniently than in a conventional horizontal grid, and edit it if required.
In the Process Data list, double-click on the tag record or select the tag record and click Edit
in the Records section of the Home tab to display the Editing data for: window.

Edit the data as required.

Note: If more than one record is selected in the Process Data grid when Edit is selected
the Multi Field Edit (Bulk Edit) window is displayed instead. Refer to Edit Process
Data for Multiple Tags.

6.1.2 Edit Process Data for Multiple Tags

Data for multiple process data records can be edited at the same time.
In the Process data grid, select the multiple records, then click Edit in the Records section
of the Home tab. A message is displayed:

© Copyright 2000 to current year. 6:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

Click Yes. The Multi Field Edit (Bulk Edit) window is then displayed:

Check the Select checkbox for all columns to be edited.

Enter the new values required in the Value columns.
The Copy first record's Data option will copy the data from first record in selection into the
window ready for editing. The data is not actually copied to the selected tags unless the
Select checkbox is selected and the Save button is clicked.
Click Save to save the changes.

© Copyright 2000 to current year. 6:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

6.1.3 Import Process Data from Excel

Process Data can be imported from Excel spreadsheets.
For a description of this functionality, refer to the Common Functionality User Guide.

6.2 Process Equipment and Lines

Project Process Equipment and Process Lines can viewed in Instrument Engineer.

Note: Process Equipment and Process Lines are created in Process Engineer and can
only be edited in that module. In Instrument Engineer, they may only be viewed and
assigned to instruments (refer to Assign Process Equipment and Process Lines).

To open the Process Equipment or Process Lines Grid, click Select in the Grids and
Schedules section of the Home tab.
Select Process Equipment or Process Lines from the list of grids that is then displayed.
The selected grid is then displayed:

© Copyright 2000 to current year. 6:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

Process Equipment and Process Lines - List Tools Options

The following options are located on both the List Tools - Process Equipment and the List
Tools - Process Lines tabs:

Records Section

Refresh These common options are also located on the Home tab.
New Refer to the Common Functionality User Guide for details.
The New and Delete options are disabled in Instrument
Edit
Engineer. The Edit option is used to view further details of an
Delete item. Refer to View Further Process Item Details.

Attached Documents Section

Open For Selected Opens the Attached Documents window, which lists the
documents attached to the selected item. Refer to
Attachments (External Documents) for details.

Attach Document Disabled in Instrument Engineer. Documents can only be

attached in Process Engineer.

Actions Section

Bulk Edit Tag No /

Disabled in Instrument Engineer.
Bulk Edit Line IDs

6.2.1 View Further Process Item Details

In addition to the process item details displayed in the Process Equipment and Process
Lines grid, further details can be viewed by clicking Edit in the Records section of the
Home tab.
The Edit Process Equipment or Edit Process Lines window is then displayed. For
example:

© Copyright 2000 to current year. 6:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Process Data, Equipment and Lines

All details displayed on this tab are read-only.

These windows can also be accessed by double-clicking on a process item records in the
lower grid of the Instrument List, or by clicking Properties on the Associated Items tab of
the Edit window (see Edit Tag Details - Tab Details).

© Copyright 2000 to current year. 6:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

7 Perform Instrument Sizing Calculations

The following sizing calculations can be performed for an instrument:

• Control Valve Sizing
• Flow Element Sizing
• Relief Valve Sizing
• Thermowell Vibrations
• Gas compressibility factor “Z”
For details of these calculations, refer to Instrument Sizing Calculations.

Important: AVEVA Instrumentation provides Instrument Sizing Calculations for estimating

purposes only.
End users should not rely on AVEVA Instrumentation calculation results for
design purposes.
AVEVA recommends using certified equipment vendor calculations for final
specification/purchasing.

To perform sizing calculations for an instrument:

• either select the instrument from the Instrument List and click Sizing Calculation in the
Actions section of the List Tools tab (an error message is displayed if multiple
instruments are selected)
• or access the Edit window for the instrument, and click Sizing Calculation on its
Datasheet tab.

© Copyright 2000 to current year. 7:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

If no sizing calculations have been performed for the instrument, a list of sizing calculation
types to select from will be displayed.

Click on the required calculation type. A window is then displayed on which the calculation
can be performed. For details of these windows, continue at Perform Calculations.

Note: The first time that sizing calculation functionality is accessed, the following disclaimer
is displayed before the list of calculation types:

Click OK to display the list of calculation types. The disclaimer can be viewed again
at any time by clicking the link below the list of calculation types.

Note: The window for performing Gas compressibility factor “Z” calculations is accessed
from the Control Valve Sizing window.

If a sizing calculation (or calculations) has been performed, the window used to perform that
calculation is displayed instead.
The last type of calculation that was performed (if any) is displayed under the Sizing
Calculation button on the Datasheet tab of the Edit window.

© Copyright 2000 to current year. 7:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

To select a different calculation to perform, double-click on the calculation type name under
the button. The list of calculation types (see above) is then displayed.

7.1 Perform Calculations

Access the required calculation windows as described above.

© Copyright 2000 to current year. 7:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

Control Valve Sizing window:

© Copyright 2000 to current year. 7:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

Flow Element Sizing Window:

© Copyright 2000 to current year. 7:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

Relief Sizing - Gases & Vapours Window:

© Copyright 2000 to current year. 7:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

Thermowell Vibration Window:

Basic details of the selected instrument are displayed at the top of the windows.
Complete the fields with the values required to perform the calculations. All values may be
entered manually.
Alternatively, if an instrument has been associated with a Process Line (refer to Assign
Process Equipment and Process Lines for details), and the Process Item Properties option
on the Instruments tab of the Preferences window has been selected (see Options), then
many of the fields may be completed with the details of that Process Line by selecting it
from the Associated Item list. Complete the rest of the fields “manually”.
Fields should be completed in the order that they are displayed on the window. For example
in the Control Valve Sizing window enter the Upstream Nominal Size first, then the
Upstream Nominal Size, finishing with the Cp/Cv, leaving blank any the values to be
calculated (if values are entered in these fields they will be overwritten when a calculation is
performed).
Fields with a yellow background cannot be edited. They either display general data relating
to the instrument, or can only be populated when a calculation is performed.
Values entered in one calculation window automatically populate corresponding fields in
other calculation windows.
If a field that must be completed is left blank, or is completed with an invalid value, an
warning symbol is displayed next to that field:

© Copyright 2000 to current year. 7:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

Hover the mouse cursor over the symbol to display a tooltip explaining the reason for the
warning:

To perform a calculation, click the appropriate button, e.g. Calc. Flow, Calc. DP, PSV Size
etc.
Note that the Calc. Density button on the Control Valve Sizing window opens the Gas
Compressibility Factor “Z” window (see below).
The calculated values then populate the appropriate fields on the windows.
If there are any warnings or noteworthy implications arising from a calculation, they are
displayed as messages at the bottom of the window.

To save any calculations or entered values and exit a window, click Save. Click Cancel to
exit a window without saving.
Gas Compressibility Factor “Z” calculations are performed by clicking Calc. Density on the
Control Valve Sizing window. The Gas Compressibility Factor “Z” window then opens. As
described above, enter the required values then click Calculate to the perform the
calculation.

© Copyright 2000 to current year. 7:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

To print the calculation results, click Print. The data is then displayed in a Print Preview
window.
To exit the Gas Compressibility Factor “Z” window, click Cancel. Note that calculations and
entered values are not saved when the window is closed.

© Copyright 2000 to current year. 7:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Perform Instrument Sizing Calculations

© Copyright 2000 to current year. 7:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

8 Loop List

The Loop List is the main window for adding/editing Loops in the project and for assigning
instruments to loops. By default all loops in the project are shown in the Loop List grid. If
required, users may use the column filters to filter the list by plant area, etc.

Access the Loop List

To open the Loop List, click Select in the Grids and Schedules section of the Home tab.
Select Loops from the list of grids that is then displayed. The Loop List grid is then
displayed:

Refer to Working with the Data Grid for information on the grid controls including selecting a
loop record, and sorting and filtering the grid data.
The Loop List consists of two grids. The main, upper grid displays details of the loops in the
project. The lower grid displays details of any instruments assigned to the loop currently
selected in the upper grid.

Add New Loops to the Loop List

To create a new Loop, click New on the Home tab. Refer to Add a Loop to the Loop List for
details.

© Copyright 2000 to current year. 8:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

A Loop can be copied by selecting an existing loop record then clicking the Copy Selected
menu option from the small pull-down menu next to the New option on the Home tab.
Copying a Loop will also copy loop instruments and the original data assigned to each
instrument to the new instruments created, except for the following data: TagNo,
PlantConnection. Refer to Copy Existing Loops for details.
Loop data may also be imported from external applications and sources. Refer to Import
Loop Data from Excel, AVEVA P&ID Loops Import and AVEVA Schematic Model Loops
Import.

Edit Loop Data

To edit data, double-click on the Loop record or select it and click Edit on the Home tab.
Refer to Edit a Loop in the Loop List for details.
If a Loop has instruments, double-click on the instrument record to edit the instrument data
in the Edit window (refer to Edit a Tag in the Instrument List).
Users may also edit most columns directly in the Grid itself. Select the cell and enter a new
value, select it from a Pick list etc.

Loop List - List Tools Options

The following options are located on the List Tools - Loops tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Tools Section

Show Un- This checkbox is used to filter the list so that only unassigned Loops,
Assigned i.e. without allocated instruments, are listed. Uncheck the checkbox to
remove the filter.

Wiring Creates a graphical wiring report for the currently selected Loop(s)
showing detailed loop wiring. The command will only show valid
termination data if wiring/cabling has been created for instruments in
the selected loop(s) using Wiring Manager. Refer to Loop Wiring
Check Reports.

Bulk Edit Used to edit multiple loop numbers. Refer to Edit Multiple Loop
Loop Numbers for details.
Numbers

Bulk Update Used to change the tag format of multiple loops. Refer to Edit Multiple
Tag Format Loops for details.

© Copyright 2000 to current year. 8:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

8.1 Add a Loop to the Loop List

To add manually a new Loop to a project, with the Loop List open click New in the Records
section of the Home tab to display the Loop Tag window:

This window is used to specify the tag of the new loop.

The Class list consists of all classes to which tag formats have been assigned (refer to
Class Definitions for details of classes and tag format allocation). Select the required class.
The Tag Format list is then populated with all the tag formats that have been assigned to
the selected class (the class designated the primary class is automatically pre-selected).
Select the required tag format from this list.
The fields displayed under the Tag Format list will depend on the fields that the selected tag
format consist of (refer to Tag Formats for details). For example, if a different tag format
from that displayed above is selected, the displayed fields will change to reflect this. For
example:

© Copyright 2000 to current year. 8:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Note that any delimiters defined for tag format are displayed after the fields they follow.
Complete the fields as required, including the loop type. The list of available loop types will
be restricted to those associated with the selected class (refer to Loop Type Catalogue for
details). The loop function code will be automatically completed with the code associated
with the loop type in the catalogue.
The entered tag number is displayed at the bottom of the window. For example:

© Copyright 2000 to current year. 8:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

When the required tag data has been entered, click OK to display the Add New Loop
window:

© Copyright 2000 to current year. 8:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

To change the tag number, click the button next to the Loop Number field to display the
Loop Tag window again (see above).
The Area No display the area that the loop is in, and cannot be changed. The Area Path:
displays the parent area(s) of that area, if there are any.
If the Drawing Required checkbox is checked, Engineer creates a drawing entry in the
Designer application. The Loop Number and Loop Service are automatically inserted into
the drawing list as a Loop Diagram drawing.

Related Loops
Up to two 'related loops' may assigned to the loop. This enables AVEVA Instrumentation to
place information for related loops (including their instrument tag data) on any Loop
Diagram created with Designer. To assign a related loop, select the button in one of the
Related Loops fields. The Select a Related Loop window is then displayed.

© Copyright 2000 to current year. 8:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Double-click on the required Loop, or select it and click Assign.

Use the Display by Area list to filter the list of Loops by an area.
The New Loop button accesses the windows for creating new Loops, as described above.

Loop Instruments List

The Loop Instruments list at the bottom of the window shows all instruments assigned to
the current loop.
To assign Instrument Tag Numbers to this loop, click the Add Tag button. Refer to Assign
Tags to Loops for further details.
To edit instrument data, double-click on the instrument tag number to display the Edit
window for the instrument.

To Remove a Tag from the Current Loop

Select the instrument tag record in the Loop Instruments list then press the <Delete> key.

Special Loop Command Buttons

The following buttons: Loop Wiring Check, Create Loop Wiring and Remove Loop
Wiring are used by designers to view and build loop wiring details from Instrument and
Loop Wiring.

© Copyright 2000 to current year. 8:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Note: If the PC does not have a valid license for Designer only Loop Wiring Check is
visible.

Loop Wiring Check Displays the Loop Check Report window, showing all
instrument wiring in the AVEVA Instrumentation database
for the current loop. Refer to Loop Wiring Check Reports.

Create Loop Wiring Allows automatic creation of instrument field wiring for
instruments in the current loop. Displays the Create Loop
Wiring for window. Refer to Create Loop Wiring using
Wiring Rules.

Remove Loop Wiring Removes all field wiring/cables and terminations for the
current loop instruments previously created with Create
Loop Wiring.

To Unassign an Instrument from a Loop

To unassign the a tag select the instrument tag in the Loop Instruments list and press
<Delete> key. The instrument is not deleted, it just unassigns the selected tag from the loop
(after the OK command is used).

8.2 Edit a Loop in the Loop List

To edit a loop, select the loop in the Loop List and click Edit in the Records section of the
Home tab, or double-click on the loop.
The Loop Edit window is then displayed.

© Copyright 2000 to current year. 8:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Note: The Last Edit field displays the date and time when the loop data was last edited.
The user name of the individual that performed the edit is displayed in a tool-tip when
the mouse cursor is hovered over the field. Click the button in the field to display the
Audit Manager, which will display a list of all the changes to the loop data.

To change the tag number, click the button next to the Loop Number field to display the
Loop Tag window again (see Add a Loop to the Loop List).

Note: If the loop type of a loop is changed, the loop function code will be automatically
changed to that associated with the type in the Loop Type Catalogue. However,
changing a loop function will not result in the loop type being updated.

The Area No display the area that the loop is in, and cannot be changed. The Area Path:
displays the parent area(s) of that area, if there are any.
The Drawing Required checkbox tells Engineer to create a drawing entry in the Instrument
Designer application. If this is checked, a Loop Diagram with the Loop Number and Loop
Service is automatically inserted into the drawing list.

© Copyright 2000 to current year. 8:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Related Loops
Up to two 'related loops' may assigned to the loop. This enables AVEVA Instrumentation to
place information for related loops (including their instrument tag data) on any Loop
Diagram created with Designer. To assign a related loop, select the button in one of the
Related Loops fields. The Select a Related Loop window is then displayed.

Double-click on the required Loop, or select it and click Assign.

Use the Display by Area list to filter the list of Loops by an area.
The New Loop button accesses the windows for creating new Loops, as described in Add a
Loop to the Loop List.

Loop Instruments List

The Loop Instruments list at the bottom of the window shows all instruments assigned to
the current loop.
To assign Instrument Tag Numbers to this loop, click the Add Tag button. Refer to Assign
Tags to Loops for further details.
To edit instrument data, double-click on the instrument tag number to display the Edit
window for the instrument.

To Remove a Tag from the Current Loop

Select the instrument tag record in the Loop Instruments list then press the <Delete> key.

Special Loop Command Buttons

The following buttons: Loop Wiring Check, Create Loop Wiring and Remove Loop
Wiring are used by designers to view and build loop wiring details from Instrument and
Loop Wiring.

© Copyright 2000 to current year. 8:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Note: If the PC does not have a valid license for Designer only Loop Wiring Check is
visible.

Loop Wiring Check Displays the Loop Check Report window, showing all
instrument wiring in the AVEVA Instrumentation database
for the current loop. Refer to Loop Wiring Check Reports.

Create Loop Wiring Allows automatic creation of instrument field wiring for
instruments in the current loop. Displays the Create Loop
Wiring for window. Refer to Create Loop Wiring using
Wiring Rules.

Remove Loop Wiring Removes all field wiring/cables and terminations for the
current loop instruments previously created with Create
Loop Wiring.

To Unassign an Instrument from a Loop

To unassign the a tag select the instrument tag in the Loop Instruments list and press
<Delete> key. The instrument is not deleted, it just unassigns the selected tag from the loop
(after the OK command is used).

8.3 Edit Multiple Loops

Loops can be edited in bulk, i.e. the loop numbers of multiple items edited at once. Continue
at Edit Multiple Loop Numbers.
The tag formats of multiple loops may also be changed. A facility is also provided to edit the
engineering data of multiple loops at once. These facilities are identical to those provided for
editing multiple instruments. Refer to:
• Edit Engineering Data for Multiple Instruments
• Edit Tag Formats of Multiple Instruments

8.3.1 Edit Multiple Loop Numbers

In Instrument Engineer the loop numbers of multiple loops, plus assigned instruments, can
be edited at a time.
To edit multiple loop numbers, select the items, then click Bulk Edit Loop Numbers in the
Actions section of the List Tools - Loops tab.
The Loop Number wizard window is then displayed.

© Copyright 2000 to current year. 8:11 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The screen displays all the loops that were selected for editing, grouped by tag format. Click
the + symbol to the left of each tag format to view details of each of the loops with that tag
format.

© Copyright 2000 to current year. 8:12 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Change the loop numbers of the selected loop by editing all or some of the loop number
fields to make up the a new, project-unique tag number, as displayed in the New Loop No
fields.
Invalid (i.e. not unique) loop numbers are displayed in red in these fields. As each loop
number is changed, it is validated against the database to check its uniqueness. If validation
is successful, display of the tag number in the New Loop No field changes to green.
To edit the loop numbers in bulk instead of one at time, select the loop number rows to be
edited and click Edit Selected Rows (click Select All Rows to select all the rows). The
Multi Field Edit (Bulk Edit) window is then displayed:

© Copyright 2000 to current year. 8:13 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Check the Select checkbox for all columns to be edited.

Enter the new values required in the Value columns.
The Copy first record's Data option will copy the data from first record in selection into the
window ready for editing. The data is not actually copied to the selected loop unless the
Select checkbox is selected and the Save button is clicked.
Click Save to save the new loop numbers. The Loop Number window is then displayed
with the new loop numbers listed and validated.
Once loop numbers have been edited as required, click Next.
The Wizard then shows all the instruments assigned to the loops with successfully validated
loop numbers.

© Copyright 2000 to current year. 8:14 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

As required, specify new tag numbers for the instruments, following the same procedure as
for loops. Click Next.
The Wizard then shows all the proposed loop and instrument numbers.

© Copyright 2000 to current year. 8:15 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

To complete the process, click Save.

AVEVA Instrumentation then renumbers the items and displays a log of the changes:

© Copyright 2000 to current year. 8:16 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Click Close.

8.4 Assign Tags to Loops

Instruments tags may assigned to loops either from Loop List facilities, or from the
Instrument List. Refer to Assign Instrument Tags to Loops for details of the Instrument List
facility.

Note: It is not mandatory for each tag to be assigned to a loop. For example, simple field
pressure gauges or a pressure relief valves are not normally members of a control
loop. They are stand-alone instruments.

To assign a tags to a Loop from the Loop List, in the Edit Loop window (or from the Add
Loop window if creating a new loop), click the Add Tag button to display the following
window:

© Copyright 2000 to current year. 8:17 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The left-hand list shows typical tags and descriptions from the Instrument Engineer ISA tag
Catalogue and built using the current loop Function prefix.
The right-hand list shows all tags assigned to the current loop (if any).
To assign a tag to the current loop, two methods may be used:
1. Build a Tag Number using the ISA tag Catalogue (left list).
Double-click on the required tag and the full tag number is added to the Tags to Add
list (right list).
Note: If required, users may click on a Tag value and overwrite it.

2. Pick an existing tag number from the Instrument List.

Click the From Instrument List button, which displays a window for Select Existing
Tags not assigned to any loop.

8.4.1 Select Existing Tags

When the From Instrument List button in the Assign Tags to Loops window is clicked, the
following window is displayed:

© Copyright 2000 to current year. 8:18 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The window lists only those tags yet to be assigned to a loop. The tag list can be filtered to
by Plant Area, using the Display by Area list.

To Assign a Tag to the Current Loop:

To assign a single tag, double-click on a Tag Number to assign the selected tag to the
current Loop.
To assign multiple tags, click the checkboxes for all the tag numbers to assign and click the
Assign button.
The Exit button cancels any tag assignment.
The Match Number checkbox filters the list of loops by the current Loop’s tag ‘number’
field. In the example above selecting Match Number would limit the list of loops to only
those containing '510' if the current loop was numbered '510'.

8.5 Copy Existing Loops

Engineer supports the copying of existing Loops to create new loops. Copying a loop also
copies the loop’s instruments (if any). Facilities to copy both single and multiple items are
available:
• To Copy a Single Loop
• Engineer Copy Wizard

8.5.1 To Copy a Single Loop

Select the existing loop record in the Loop List and select Copy Selected from the drop-
down menu next to the New option on the Home tab.
The following message will then be displayed:

© Copyright 2000 to current year. 8:19 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Click Yes to open Engineer Copy Wizard. Refer to Engineer Copy Wizard for details.
Otherwise click No.
AVEVA Instrumentation will then display the Loop Tag window. Enter the required tag
details and click OK.
The Add New Loop window is then displayed with the details of the copied loop displayed.
Change the details as required and click Save.
Refer to Add a Loop to the Loop List for details of the Loop Tag and Add New Loop
window.

Note: The command copies all loop instruments and the original data assigned to each
instrument to the new instruments created except the following: TagNo,
PlantConnection, P&ID No, DataSheetNo, LoopDwgNo, LocationDwg, InstallDwgNo
and JunctionBox. The command also copies any field device definitions and cables
(including terminations) for each loop instrument (if any) as defined in the Wiring
Manager module for the copied loop.

8.5.2 Engineer Copy Wizard

Engineer supports copying of multiple existing Loops to create new loops. Copying loops
using the Copy Wizard also copies the loop's instruments (if any) and datasheets (if any).
The Loop Copy Wizard enables users to step through all the selected loops, their
instruments and datasheets to enable renaming of the copied objects in a logical manner.

Note: The Wizard copies all selected loops and loop instruments and the original data
assigned to each instrument to the new instruments created except the following:
TagNo, PlantConnection, P&ID No, DataSheetNo, LoopDwgNo, LocationDwg,
InstallDwgNo and JunctionBox. The Wizard does not currently copy any field device
definitions and cables (including terminations) for each loop instrument (if any) as
defined in the Wiring Manager module for the copied loop. The Wizard does enable
copying of all instrument datasheets.

To copy multiple loops, select the loop records to be copied that require copying from the
Loop List and click Copy Selected from the drop-down toolbar menu next to the New button
of the Home tab.
The first screen of the Copy window is then displayed:

© Copyright 2000 to current year. 8:20 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

To remove any tags from the copying process, uncheck their Select checkboxes. Uncheck
the Select All for Copying checkbox to uncheck all Select checkboxes.
Before continuing each selected loop must be renamed by editing all or some of the fields
that make up the a new, project-unique tag number, as displayed in the New Loop No
fields.
Invalid (i.e. not unique) tag numbers are displayed in red in these fields. As each tag number
is changed, it is validated against the database to check its uniqueness. If validation is
successful, display of the tag number in the New Loop No field changes to green.
To edit the tag numbers in bulk instead of one at time, select the tags rows to be edited and
click Edit Selected Rows (click Select All Rows to select all the rows). The Multi Field Edit
(Bulk Edit) window is then displayed. Refer to Edit Multiple Loops for details of this window.
Once tag numbers have been edited as required, click Next.
The next screen shows all instruments associated with the selected loop (if any), grouped
by tag format.

© Copyright 2000 to current year. 8:21 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

Click the + symbol to the left of each tag format to view details of each of the tags with that
tag format.
Each selected instrument must be renamed by editing all or some of the fields that make up
the tag number. The new document number is displayed in the New Tag No field.
The editing facilities on this screen are the same as on the first.
To continue click Next.
The next screen shows all datasheets associated with the loop instruments (if any).

Each selected instrument datasheet must be renamed by editing all or some of the fields
that make up the document number, including Sheet No. The new document number is
displayed in the New Doc No field.

© Copyright 2000 to current year. 8:22 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The editing facilities on this screen are the same as on the first.
To continue click Next.

The wizard shows all the proposed loops, instruments and datasheets.
To create the new items, click Copy.
AVEVA Instrumentation copies all the new items then stops and displays a log. For
example:

© Copyright 2000 to current year. 8:23 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

8.6 Delete Loops

To delete a loop select it from the Loop List and click New in the Records section of the
Home tab.
A message is then displayed asking for the deletion to be confirmed. If Yes is clicked, the
Delete Options window is displayed.

The window provides the option of either unassigning instruments from the loop (Unassign
Instruments from Loop), or deleting them (Delete Instruments in Loop).

© Copyright 2000 to current year. 8:24 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

If the delete option is selected, a further option to delete the associated instrument wiring is
available: Remove any Instrument Wiring.
Also, if there is a loop diagram for the loop it may be deleted by checking the Delete Loop
Diagram checkbox.
After the required options have been selected, click Delete to proceed with the deletion.
Click Cancel to cancel the deletion.

8.7 Import Loop Data from Excel

Engineer enables users to import instrument data and loop data into the AVEVA
Instrumentation project database from a Microsoft Excel Workbook. The two stage import
first imports Loops then assigns instruments to loops as defined in the Excel workbook
being imported.
For a description of this functionality, refer to the Common Functionality User Guide.

8.8 AVEVA P&ID Loops Import

Engineer includes facilities to import Loop data into the Loop List from the AVEVA P&ID.
Continue at:
• AVEVA P&ID Loop Data Import Configuration
• Import Loops from AVEVA P&ID

8.8.1 AVEVA P&ID Loop Data Import Configuration

Before importing loop data from AVEVA P&ID the user must select an AVEVA P&ID Project
file and set up mappings between AVEVA P&ID and AVEVA Instrumentation fields. Refer to
AVEVA P&ID Tag Data Import Configuration for further information.

8.8.2 Import Loops from AVEVA P&ID

To import loops from AVEVA P&ID, select AVEVA P&ID Import from the Integration
section of the Manage tab to display the Import from AVEVA P&ID window.

© Copyright 2000 to current year. 8:25 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The Import from AVEVA P&ID window displays totals of new and existing loops with the
option to import all the loops in a batch or one at a time.
The batch option processes all records together then displays a differences report enabling
users to accept or reject each change. The one by one option displays a differences report
for each record one at a time.
If that are any loops previously imported from AVEVA P&ID that have since been deleted in
AVEVA P&ID, the total of these is also displayed, and the Process deleted button becomes
active. Click Process deleted if these loops are also to be deleted from Instrumentation.
The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported AVEVA P&ID) data. If the one by one import option was
selected, the differences for a single record are listed.

If the batch option was selected, differences for all records are displayed.

© Copyright 2000 to current year. 8:26 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

To accept the changes either select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel ALL further importing click Stop Import
The Import Log then shows the user the import status and displays the successfully
imported files in the grid view.

8.9 AVEVA Schematic Model Loops Import

Engineer includes facilities to import loop data into the Loop List from the AVEVA Schematic
Model.
Continue at:
• AVEVA Schematic Model Loop Data Import Configuration

© Copyright 2000 to current year. 8:27 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

• Import Loops from AVEVA Schematic Model

8.9.1 AVEVA Schematic Model Loop Data Import Configuration

Before importing loop data from AVEVA Schematic Model the user must select an AVEVA
Schematic Model Version to import from and set up mappings between AVEVA Schematic
Model and AVEVA Instrumentation field. Refer to AVEVA Schematic Model Import
Configuration for further information.

8.9.2 Import Loops from AVEVA Schematic Model

To import loops from AVEVA Schematic Model, select Imports > Import from AVEVA
Imports > Import from AVEVA Schematic Model from the Tools tab to display the
AVEVA Schematic Model Login window.
If data has previously been imported into the project from AVEVA P&ID, a message is
displayed warning the user that because of this no data can be import from AVEVA
Schematic Model.

Clicking OK will terminate the process.

If no data has previously been imported into the project, a message is displayed warning the
user that, after importing data from AVEVA Schematic Model the user will be prevented from
importing data from AVEVA P&ID.

If the user clicks No a message window is displayed informing the user that the import has
been terminated.

Click OK to return to the Instruments grid view.

© Copyright 2000 to current year. 8:28 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

If the user clicks Yes the AVEVA Schematic Model Login window is displayed.

Complete the Project, Username, Password and Project MBD as appropriate and click
OK.

Note: If the field mappings have not been set, the AVEVA Schematic Model Data Import
Configuration window is displayed. Refer to AVEVA Schematic Model Import
Configuration for further information. If the user clicks Cancel, a message window is
displayed informing the user that the import cannot continue without the Field
mappings being set.

If field mappings have been setup, the Import from AVEVA Schematic Model window is
displayed:

© Copyright 2000 to current year. 8:29 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

The Import from AVEVA Schematic Model window displays totals of new and existing
loops with the option to import all the loops in a batch or one at a time.
The batch option processes all records together then displays a differences report enabling
users to accept or reject each change. The one by one option displays a differences report
for each record one at a time.
If that are any loops previously imported from AVEVA Schematic Model that have since
been deleted in AVEVA Schematic Model, the total of these is also displayed, and the
Process deleted button becomes active. Click Process deleted if these loops are also to
be deleted from Instrumentation.
The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported AVEVA Schematic Model) data. If the one by one import
option was selected, the differences for a single record are listed.

If the batch option was selected, differences for all records are displayed.
To accept the changes either select individual field data by clicking the Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be auto-selected).
To save the checked (accepted) data to the project, click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.

© Copyright 2000 to current year. 8:30 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel ALL further importing click Stop Import
The Import Log then shows the user the import status and displays the successfully
imported files in the grid view.

© Copyright 2000 to current year. 8:31 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Loop List

© Copyright 2000 to current year. 8:32 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

9 Instrument and Loop Wiring

AVEVA Instrumentation uses 'Wiring Rules' to automatically generate typical field instrument
wiring/cabling. Using the Wiring Rules features can save many hours otherwise required to
build devices and their associated terminal arrangements, cables, terminations etc in Wiring
Manager.
Refer to Instrument Wiring and Loop Wiring for how to apply Wiring Rules.
When a Wiring Rule is applied to a field instrument, the following are defined:
• Terminal arrangements - the number of terminals, their markings, sequence.
• Default wire numbers to be used on wire terminations.
• Default cable types - type of cable (individual cores, pairs or triad etc), whether
shielded/screened, and whether armoured etc.
• Default cable numbers - based of the instruments tag number fields from Instrument
Engineer.
• Default wire terminations at the field devices - how the cable is connected to the field
device terminals (core 1 to terminal 1, core 2 to terminal 2 etc).
• Default wire terminations at non-field device - how the cable is connected at the other
end.
When wiring based on a Wiring Rule is created, AVEVA Instrumentation creates all the
above automatically. Prior to saving this data AVEVA Instrumentation also enables users to:
• Change the default cable number created by the Wiring Rule.
• Select equipment the cable will terminate to at the other end (from a list of Junction
Boxes, Cabinets etc).
After accepting defaults (or making changes as required) the Field Device and terminals are
created, the cable is created and terminated at both ends (if equipment has been selected
at the other end). At the other end, AVEVA Instrumentation always uses the next available
spare terminals.
At any time after a Wiring rule is applied, the data that has been generated can be edited by:
• Re-running the Create Wiring command using same Wiring Rule - this enables users to
reassign a Cable No, reassign a Junction Box etc.
• Re-running the Create Wiring command using a new Wiring Rule - this updates
terminal arrangements, cable type, terminations AND enables users to reassign a
Cable No, reassign a Junction Box etc.
• Edit the cable details/type using Wiring Manager Cable Schedule user interface.
• Edit terminations using Wiring Manager - Equipment Terminations editing user
interface.

© Copyright 2000 to current year. 9:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

9.1 Instrument Wiring

Instrument Engineer can auto-create the field device, terminals, cables, their cores and wire
numbers and terminate cable cores at both the field device and Junction box ends of cables
based on assigned wiring rule for each specific Loop instrument.
This effectively completes field wiring in an efficient and simple manner, which may save
hundreds on man-hours on a large project.

Note: The PC must have a license for the Wiring Manager application for this feature to be
available from Engineer.

Note: Although Wiring Rules can be used to create field cables/terminations from Engineer,
this is limited to working on a tag by tag or Loop by Loop basis. AVEVA recommends
creating field wiring using Wiring Rules from the Wiring Manager's Equipment View
or Cable Block Diagram by assigning (allocating) field tags to Junction Boxes, which
is more efficient than doing it in Designer for each tag and Loop.

9.1.1 Create Tag Wiring using Wiring Rules

In the Add New Tag or Edit window for the instrument (see Edit Tag Details - Tab Details),
open the Detail tab and click on the Create Tag Wiring button.
The following window is then displayed:

Explanation of Fields:

Tag No The instrument tag number - non editable.

Note: Although the specified Wiring Rule (in the Wiring Config field) defines the
terminal configurations of the Field Device, users can select a different
configurations clicking on the button in the Tag No field and selecting from the list
of configurations in the Select a Field Device Terminal Configuration window
that is then displayed. See Select a Field Device Terminal Configuration.

© Copyright 2000 to current year. 9:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Loop Dwg Code The 'Loop Code' is used by AVEVA Instrumentation Datalinks to
map information into a loop drawing template when generating
CAD drawings. It is ONLY required if CAD loop drawings are to be
generated in Designer. This 'Loop Code' must be unique for the
current loop for CAD loop drawing creation.

Wiring Config The name of the Wiring Rule to apply to the tag. Select the rule by
clicking the button in the field. The Wiring Rule Definitions
window is then displayed (refer to Assign Wiring Rules to Tags for
details). Select the required rule from the list of rules and click OK.
The selected rule is then displayed in this field.

Junction Box This displays the name of the equipment the cable will run to.
Clicking on the button in this field will display a window used to
Assign a Junction Box.

Terminate When this checkbox is checked, cores will be terminated at the

Junction Box end (on the next available spare terminals). When it
is unchecked, cores will not be terminated at the Junction Box end.
The cores will need to be terminated manually, using Wiring
Manager, by dragging the cable or cores to the desired terminals.

Cable Number This shows the default cable number as created by the wiring rule
or the actual cable number from the AVEVA Instrumentation Cable
Schedule (if the cable has been created previously). Enter a new
value if required.

Cable Type This shows the base cable type. It can be changed by selecting
the cell command button that appears when the mouse is hovered
over this cell. The initial cable type comes from the Wiring Rule
catalogue cable (if the cable is not yet created) or from the Cable
Schedule (if the cable has been created previously). Clicking the
cell button displays the Select a Cable from Catalogue window
allowing a new catalogue cable to be selected.

Note: The core sequences of Wiring Rules override those of

catalogue cables. The connection order of a Wiring Rule is
always preserved even if this does not match the core
sequence order defined in the Cable Catalogue.

Cable Length Enter a Cable Length here. This length is saved in Wiring
Manager's Cable Schedule.

Command Buttons:

Create Creates all selected tags, cables, termination and other wiring data from
the Wiring Rules and data in this grid.

Save Saves the changed data in the grid, but does not create Wiring Rule data.
This enables users to pre-assign junction boxes etc prior to cable/device
creation.

Cancel Exits the window, not saving or creating wiring.

As soon the wiring data is created, all the information generated (or changed) may be
viewed in the Tag Wiring Check Report. Refer to Tag Wiring Check Reports.

© Copyright 2000 to current year. 9:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Select a Field Device Terminal Configuration

Although the specified Wiring Rule (in the Wiring Config field) defines the terminal
configurations of the Field Device, users can select a different configurations clicking on the
button in the Tag No field and selecting from the list of configurations in the Select a Field
Device Terminal Configuration window that is then displayed.

The Graphic tab displays graphical representations of each available configuration. The List
tab displays them in a simple list.
To select a configuration and exit the window, either double-click on it, or single click on it
and click Select.

Assign Wiring Rules to Tags

To select a wiring rule to apply to a tag, the user clicks the button in the Wiring Config field
of the Create Tag Wiring for window. The Wiring Rule Definitions window is then
displayed:

© Copyright 2000 to current year. 9:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Select the required rule from the list on the left. If required, use the facilities above the list to
filter the number of rules displayed.
A graphical representation of the rule is displayed on the right. Click OK to apply the rule to
the field device.
The window then exits, and the selected rule is displayed in the Wiring Config field of the
Create Tag Wiring for window. The Cable Number and Cable Type fields are also
completed or updated as appropriate.
See Wiring Manager documentation for information on creating and editing wiring rule
definitions.

Assign a Junction Box

When selecting a Junction Box when applying Wiring Rules, the following Assign <Tag
Number> to... window is displayed, initially listing all junction boxes defined in the current
plant area:

© Copyright 2000 to current year. 9:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Select the All Areas option to view equipment in all plant areas.
To assign a Junction Box, double-click on the required equipment tag.
Junction Boxes and other Equipment (other than field devices) can only be created in the
Wiring Manager module.

Note: In order to select another Tag as the Junction Box (cable end) connection that tag
must have previously been created by a Wiring Rule for it to appear in the List of
Equipment. For example, to connect a Field Element to a Transmitter, first the
Transmitter must be created, then the element must be assigned to the Transmitter
(e.g the Transmitter becomes the element's Junction Box).

Note: The instrument Signal Type is shown near the top of this window. This comes from
the Instrument's Signal Type field in the AVEVA Instrumentation Instrument Data
window. However any instrument may be assigned to any junction box, regardless of
signal type.

Note: The maximum number of cables that may be connected to a junction box may
(optionally) be specified in Wiring Manager. If the application of a wiring rule would
result in more than when the maximum number of cables being assigned to it, a
message is displayed to inform the user of this.

9.1.2 Tag Wiring Check Reports

Tag Wiring Check Reports show a graphical type report of all wiring connected to a tag. The
report may be printed directly to a printer or saved as a PDF, XPS or AutoCAD file.
To view a Tag Wiring Check Report, on the Edit window for the instrument, click the Tag
Wiring Check command button. The report is then displayed.
This option will only be available for tags that have had wiring created for them.
The Wiring Check Report window is then displayed:

© Copyright 2000 to current year. 9:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Note: If the PC has a license for Wiring Manager, on any equipment tag is right-clicked on,
AVEVA Instrumentation will display an option to allow access to the Wiring
Manager's Terminations window, which provides drag and drop editing of cable/wire
terminations, and an option to generate a termination report for the selected
equipment.

Note: If the PC has a license for Wiring Manager when any cable is right-clicked on,
AVEVA Instrumentation will display an option providing access to Wiring Manager's
Cable Detail window, which is used to view and edit the details of the cable.

Refer to Wiring Manager documentation for details of the above Wiring Manager facilities.
Various functions are available to the user via the File, Edit, View and Layout drop-down
menus, or by clicking the required button on the toolbar.

File Menu

File Saves the report to the database. This option is available on the
toolbar.

Refresh Updates and reloads the tag data and refreshes the window. This
option is available on the toolbar.

Export to PDF Exports the report into a .pdf format file in the projects Drawing
folder. The filename used is the Tag number.

Export to XPS Exports the report into an .xps format file in the projects Drawing
folder. The filename used is the Tag number.

Export to Exports the report to AutoCAD. The filename used is the Tag
AutoCAD number.

© Copyright 2000 to current year. 9:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Page Setup Displays the Page Setup window which enables the user to
change the paper size and source, the orientation and the size of
the margins.

Print Preview Displays the Print preview window which enables the user to view
the print before sending to a printer. This option is also available
on the toolbar.

Print Displays the Print window which enables the user to customise
the print. This option is also available on the toolbar.

Printing Enables the user to print the report to a defined size by selecting a
percentage. After selecting a percentage, the Print preview
window is displayed, enabling the user to view the print before
sending to a printer.

Preferences Display the Preferences window. Refer to Preferences.

Exit Closes the report window.

Edit Menu

Undo Undoes the last command. This option is also available on the
toolbar.

Redo Redoes the last Undo. This option is also available on the toolbar.

Trim Canvas Enables the user to change the size of canvas to the actually size
of the diagram.

Select All Selects all objects.

Find Equipment Displays the Find Text window, enabling the user to search for a
term.

Insert Note Opens a text box within the report which enables the user to type a
note. The text box can be positioned in the report by clicking on it
and dragging it to the required position.

Insert Rev Enables the user to add a revision information block.

Insert Document Enables the user to add a document number block.

No.

View Menu

Show Overview Display the Overview window which displays all the report pages.

Predefined Enables the user to select a predefined zoom percentage.

Percentages

Zoom Normal Reverts the report back to the default zoom.

Zoom to Fit Zooms to fit all the pages into the window. This option is also
available on the toolbar.

© Copyright 2000 to current year. 9:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Zoom In Zooms into the report. This option is also available on the toolbar.

Zoom Out Zooms out from the report. This option is also available on the
toolbar.

Layout Menu

Align Enables the user to move two or more selected nodes to the same
Horizontally row, inline with the first selected node.

Align Vertically Enables the user to move two or more selected nodes to same
column , inline with the first selected node.

Layout Enables the user to layout diagrams by automatically positioning

Equipment (Flat) the items and routing the links horizontally.

Layout Enables the user to layout diagram by automatically positioning

Equipment (Tree) the items and routing the links as a tree.

Make Sub Enables the user to select multiple items of equipment and group
Diagram them all together, keeping the item to be individually selected and
moved.

Layout Sub Enables the user to layout the items inside sub diagrams
Diagram automatically.

Group Selected Enables the user to select multiply items of equipment and group
them all together.

Ungroup Enables the user to ungroup multiply items of equipment which

Selected were grouped together using the Group Selected option.

Show Ferrule Numbers Checkbox

The only option on the toolbar not available on the menus is the Show Ferrule Numbers
checkbox. If ferrule numbers are to be displayed on the report instead of signal numbers,
ensure that this checkbox is checked.
The default setting for this checkbox is specified on the Cable/Wires tab of the Preferences
window.

Preferences
Tag Wiring Check Report preferences can be set from the Preferences window. To display
this window select Preferences from the File menu.

Note: In addition to the preferences described here, the default Enhanced Cable Block
Diagram cable label symbol defined in Wiring Manager may be used on Wiring
Check Reports instead of the normal symbol, depending on the Wiring Manager
preferences for the project.

© Copyright 2000 to current year. 9:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

The General tab is used to specify how the Tag Wiring Check Report is displayed.

© Copyright 2000 to current year. 9:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

The Cable/Wires tab is used to specify how the cable and wires will be displayed in the Tag
Wiring Check Report.

© Copyright 2000 to current year. 9:11 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

The Printing tab is used to set the default paper size, orientation and margins, the maximum
number of terminals that can be displayed on each page and to add a header and footer to
the pages.

© Copyright 2000 to current year. 9:12 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

The Export tab is used to define the settings to be used when exporting the Tag Wiring
Check Report to AutoCAD.

Note: The user must have AutoCAD installed on their workstation to export the Tag Wiring
Check Report successfully.

The user can revert the report references back to the default settings by clicking Use
Default.
Click OK to save the changes and close the Preferences window or Cancel to close the
Preferences window without saving any changes.
To commit the changes to the Tag Wiring Check Reports window click Apply. A warning
message is displayed informing the user that applying the new settings will cause the
diagram to reload.

© Copyright 2000 to current year. 9:13 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Click Yes to continue or No to terminate the process.

9.2 Loop Wiring

Instrument Engineer can auto-create the field device, terminals, cables, their cores and wire
numbers and terminate cable cores at both the field device and Junction box ends of cables
based on assigned wiring rule for each specific Loop instrument.
This effectively completes field wiring in an efficient and simple manner, which may save
hundreds on man-hours on a large project.

Note: The PC must have a license for the Wiring Manager application for this feature to be
available from Engineer.

Although Wiring Rules can be used to create field cables/terminations from Engineer, this is
limited to working on a tag by tag or Loop by Loop basis. AVEVA recommends creating field
wiring using Wiring Rules from the Wiring Manager's Equipment View or Cable Block
Diagram by assigning (allocating) field tags to Junction Boxes, which is more efficient than
doing it in Designer for each tag and Loop.

9.2.1 Create Loop Wiring using Wiring Rules

In the Add New Tag or Edit window for the instrument (see Edit a Loop in the Loop List),
click the Create Loop Wiring button.
The following window is then displayed:

The window shows all instruments assigned to the current loop. Only those instruments
selected will be processed by the Create command.

© Copyright 2000 to current year. 9:14 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Columns Explanation

Select Only those instruments that have their Select checkbox checked are
processed when the Create command is used.

TagNo The instrument tag number - non-editable (tags can only be assigned to
a loop using Engineer).

Note: Although the specified Wiring Rule (in the Wiring Config field) defines the
terminal configurations of the Field Device, users can select a different
configurations clicking on the button in the Tag No field and selecting from the list
of configurations in the Select a Field Device Terminal Configuration window
that is then displayed. See Select a Field Device Terminal Configuration.

Code The 'Loop Code' is used by AVEVA Instrumentation Datalinks to map

information into a loop drawing template when generating CAD
drawings. It is ONLY required if CAD loop drawings are to be generated
in Designer. This 'Loop Code' must be unique for the current loop for
CAD loop drawing creation.

WiringRule The name of the Wiring Rule to apply to the tag. Select the required rule
from the list of available rules (the list is only displayed when the mouse
is hovered over the cell).

Junction This displays the name of the equipment the cable will run to. A button is
Box displayed when the mouse is hovered of this cell. Clicking on that button
will display a window used to Assign a Junction Box.

Terminate When this checkbox is checked, cores will be terminated at the Junction
Box end (on the next available spare terminals). When it is unchecked,
cores will not be terminated at the Junction Box end. The cores will need
to be terminated manually, using Wiring Manager, by dragging the cable
or cores to the desired terminals.

Cable No. This shows the default cable number as created by the wiring rule or the
actual cable number from the AVEVA Instrumentation Cable Schedule (if
the cable has been created previously). Enter a new value if required.

Length Enter a Cable Length here. This length is saved in Wiring Manager's
Cable Schedule.

Cable Type This shows the base cable type. It can be changed by selecting the cell
command button that appears when the mouse is hovered over this cell.
The initial cable type comes from the Wiring Rule catalogue cable (if the
cable is not yet created) or from the Cable Schedule (if the cable has
been created previously). Clicking the cell button displays the
Catalogue Cable window allowing a new catalogue cable to be
selected.

Note: The core sequences of Wiring Rules override those of catalogue

cables. The connection order of a Wiring Rule is always
preserved even if this does not match the core sequence order
defined in the Cable Catalogue.

Command Buttons

© Copyright 2000 to current year. 9:15 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Create Creates all selected tags, cables, termination and other wiring data from
the Wiring Rules and data in this grid.

Save Saves the changed data in the grid, but does not create Wiring Rule
data. This enables users to pre-assign junction boxes etc prior to cable/
device creation.

Cancel Exits the window, not saving or creating wiring.

Terminate When this checkbox is checked, cores will be terminated at the Junction
Box end (on the next available spare terminals). When it is unchecked,
cores will not be terminated at the Junction Box end. The cores will need
to be terminated manually, using Wiring Manager, by dragging the cable
or cores to the desired terminals.

As soon the wiring data is created, all the information generated (or changed) may be
viewed in the Loop Wiring Check Report. Refer to Loop Wiring Check Reports.

Select a Field Device Terminal Configuration

Although the selected Wiring Rule defines the terminal arrangement of a Field Device, if
required users can select a different arrangement by clicking on the Tag No cell button that
appears when the mouse hover over this cell in the Create Loop Wiring for window (see
Create Loop Wiring using Wiring Rules).
The Select a Field Device Terminal Configuration window is then displayed:

The Graphic tab displays graphical representations of each available configuration. The List
tab displays them in a simple list.
To select a configuration and exit the window, either double-click on it, or single click on it
and click Select.

© Copyright 2000 to current year. 9:16 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Assign a Junction Box

When selecting a Junction Box when applying Wiring Rules, the following Assign window is
displayed, initially listing all junction boxes defined in the current plant area:

Select the All Areas option to view equipment in all plant areas.
To assign a Junction Box, double-click on the required equipment tag.
Junction Boxes and other Equipment (other than field devices) can only be created in the
Wiring Manager module.

Note: In order to select another Tag as the Junction Box (cable end) connection that tag
must have previously been created by a Wiring Rule for it to appear in the List of
Equipment. For example, to connect a Field Element to a Transmitter, first the
Transmitter must be created, then the element must be assigned to the Transmitter
(e.g the Transmitter becomes the element's Junction Box).

Note: The instrument Signal Type is shown near the top of this window. This comes from
the Instrument's Signal Type field in the AVEVA Instrumentation Instrument Data
window. However any instrument may be assigned to any junction box, regardless of
signal type.

9.2.2 Loop Wiring Check Reports

Loop Wiring Check Reports show a graphical 'loop diagram' type report of all wiring for
current loop. The report may be printed and saved as a PDF file. This report is only
available if the drawing has a valid loop number and wiring exists in the project wiring
database for the instruments in the current loop.
These Loop Wiring Check reports are for dynamic checking of current wiring created in
Wiring Manager associated with a loop's instruments.

To Create a Loop Wiring Check Report

From the Loop List select the Loop(s) to create Loop Wiring Check Reports for and click
Wiring on the List Tools - Loops tab.

© Copyright 2000 to current year. 9:17 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument and Loop Wiring

Or, in the Loop Edit window (see Edit a Loop in the Loop List), click Loop Check Report.
The report is then displayed. For example:

With the exception of the additional Export to Designer option on the File menu (see
below), all menu, toolbar and other facilities are identical to those of the Tag Wiring Check
Report. Refer to Tag Wiring Check Reports for details.

Note: If the PC has a license for Wiring Manager, on any equipment tag is right-clicked on,
AVEVA Instrumentation will display an option to allow access to the Wiring
Manager's Terminations window, which provides drag and drop editing of cable/wire
terminations, and an option to generate a termination report for the selected
equipment.

Note: If the PC has a license for Wiring Manager when any cable is right-clicked on,
AVEVA Instrumentation will display an option providing access to Wiring Manager's
Cable Detail window, which is used to view and edit the details of the cable.

Preferences
Loop Wiring Check Report preferences can be set from the Preferences window. To display
this window select Preferences from the File menu.
All preferences are identical to those of the Tag Wiring Check Report. Refer to Tag Wiring
Check Reports - Preferences for details.

Export to Designer
The is option creates a record of the diagram in the Drawing List in Designer and generates
an AutoCAD version of the Loop diagram.
Settings for the export, such as the seed file to be used, are specified on the Export tab of
the Preferences window.

© Copyright 2000 to current year. 9:18 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

10 Datasheets

Datasheets are stand-alone documents which the user can view, edit or exchange with third
parties. Refer to Datasheets (Specifications) for further information on the available
features.
Continue at:
• View/Edit Instrument Datasheets
• Datasheets List
• Add New Datasheets
• Edit Datasheet Information
• Assign Tags To Datasheets
• Delete Datasheet Options
• Print Datasheets
• Datasheet Revisions
• Datasheet Issues
• Import Datasheets from Excel
• Datasheet Publishing
• Merge Datasheets into a Single Document
• Document List
• Datasheet Form Catalogue

10.1 View/Edit Instrument Datasheets

Engineer enables the user to view and edit instrument datasheets as follows:
• From the Datasheets List, either double-click on the Datasheet record or highlight the
record in the Datasheets list and click Open on the List Tools - Datasheets tab.
• From the Instrument List or the Instrument Catalogue, click on the button that is
displayed in the Datasheet No cell when the mouse is hovered over it, as shown
below:

© Copyright 2000 to current year. 10:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

• When editing a tag, on the Datasheet tab of the Edit window, click the button next to
the Datasheet No field.

The datasheet is then displayed in the Datasheet viewer. Refer to the Datasheet Data Entry
for details.

Note: If the instrument tag or catalogue instrument is not currently assigned to a datasheet
when the button in the Instruments and Instruments Catalogue lists or on the
Datasheet tab is clicked, then Engineer will prompt users to assign it. Refer to Add
New Datasheets for details of how to accomplish this.

10.1.1 Datasheet Data Entry

A datasheet in opened in the Datasheet viewer window, with the datasheet number as its
title. Use this window to enter, view and edit datasheet details.

© Copyright 2000 to current year. 10:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

In this window, a number of facilities are available, as described below.

Enter or Modify Data

To enter or edit data, double-click any cell and type in the data. If the cell has a PickList, the
user can select a value from the drop-down list. Refer to Using PickLists.

Note: Only changes made to Process Data and data associated with form type can be
saved in this window. Changes made to Revisions, the Document Number and Tag
Numbers within this window cannot be saved from this window. To make these
changes use the appropriate Instrument List, Datasheet List and Datasheet List
Revisions windows.

Copy Data from another Datasheet

Data may be copied from any other tag assigned to the same datasheet form type (e.g
Pressure Transmitters in the above example) using the Copy button. Refer to Copy Tag
Data during Data Entry for details.

Editing a PickList
If a cell has a PickList attached, then if that cell was right-clicked on, a pop-up menu is
displayed. Select Edit PickList Values from that menu. The PickList edit window is then
displayed, in which values can be added, edited or changed in the selected PickList.
For example:

© Copyright 2000 to current year. 10:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Refer to Using PickLists for further information on editing PickLists.

Convert Process Units

A user can convert process units. Refer to Convert Process Units for more information.

Data Entry Command Buttons

Save Saves the data values to the database and opens it in an Excel
spreadsheet.

Save & Exit The Save & Exit option is accessed from a drop-
down list next to Save and saves the data values to
the database and to the Excel spreadsheet and
closes the datasheet.

Copy Enables users to copy another instrument tag's or catalogue

instrument's datasheet data to the tag targeted on the current
datasheet. To target a tag as being the tag to copy to, double-click in its
Tag Number cell prior to clicking this Copy command. Engineer then
displays a window containing a list of all tags and catalogue
instruments assigned to the same datasheet form type to choose from.
Refer to Copy Tag Data during Data Entry.

Undo Undoes the last change made. Any subsequent undo will roll back each
previous change.

Redo Reverses the last undo (see above) made.

Print Saves the data and prints the datasheet.

Print to PDF Saves the data to a PDF file and opens it.

© Copyright 2000 to current year. 10:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: The Print and Save commands use Microsoft Excel, therefore Excel must be
installed on the workstation to if these facilities are to be used. The Print
command uses the print area, print setup (Margins, scales etc.) as defined in the
datasheet form template file for the current project.

Preview Opens a print preview of the datasheet.

Issue Issues the datasheet by taking a snapshot of the data in the datasheet's
mapped cells and saving it to database for future reference. This
enables AVEVA Instrumentation to show changes between Issues.
The Issue option and its sub-menu options are not available for
datasheets assigned to catalogue equipment.
If the document has previously been issued, an Issue message window
is displayed informing the user to create a new revision before issuing.

Click Cancel to cancel the issue or OK to create a new revision. Refer

to Datasheet Revisions for further information on creating a new
revision.
After creating a new revision, the document is issued and an Issue
message window is displayed asking if the issued document should be
printed. Click Yes to sent to the document to the default printer or No to
close the Issue message window without printing the document.

Load Previous Loads the datasheet in a read-only window with the

Issue values it had at a selected issue.

Highlight Issue Highlights the cells containing values that have

Changes changed since a selected issue.

Reset Resets the datasheet to its last saved / opened state by clearing
“changed” cells and reverting the values back to original values.

Zoom Zooms the Datasheet Layout area according to the value selected from
drop down. Use the and buttons to decrement or increment
the zoom.

Preferences Opens Datasheet Change Preferences window. Not available for

datasheets assigned to catalogue instruments.

© Copyright 2000 to current year. 10:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Apply Default If this option is checked, then on the update of a value in a datasheet
Units cell, the default unit is appended with the value if no unit is had been
entered previously.

Close Exits without saving changes to the database.

Note: Right-clicking on a cell displays a special menu from which special characters (° ± ² ³
¼ ½ ¾ ?) can be inserted.

10.1.2 Copy Tag Data during Data Entry

Data may be copied from any other tag assigned to the same datasheet form type.
Click the Copy button on the Datasheet Data Entry window. The Copying Data to window is
then displayed:

The grid shows all fields associated with the datasheet as defined in the Datasheet Form
Catalogue Grid.

Select a Tag Select the tag from which data is to be copied from this list. Only
or Catalogue tag numbers assigned to the same datasheet form type will be
Instrument to available for selection.
Copy From

Accept Check this checkbox for the fields to be copied.

Note: To select all fields check the Accept All checkbox

Show Process Checking the Show Process Data checkbox displays the
Data process data in the grid view.

© Copyright 2000 to current year. 10:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Field The field name (as defined in the Datasheet Catalogue).

Existing Value The current value of each field for the target tag.

Proposed Value The data about to be copied, if accepted, from the selected
source tag, as chosen from the Select a Tag to Copy From list.

After all required fields values are selected, click Save to copy the data to the current tag or
Cancel to exit without copying data.

Note: Only fields associated with the datasheet are available to copy. Copying Instrument
Index data such as Tag Number, Service, Line or Equipment Number or Datasheet
title and Revision data is not possible with this feature.

Note: If the selected tag or catalogue instrument type is associated with a datasheet with a
different form type from the tag or catalogue instrument being copied to, a message
is displayed to inform the user of this and to give the option of keeping the existing
datasheet or replacing it with a datasheet derived from the form type linked to the
selected tag or catalogue instrument.

10.1.3 Convert Process Units

Engineer enables users to convert process units to another unit in the Datasheet Data Entry
window.
A user can convert process units by right-clicking on any ProcessData table field (cells
mapped to a ProcessData database field) that contains a Pressure, Flow, Density,
Temperature, Viscosity or Level value, or on any cell within the Datasheet Edit window
mapped to such fields.

© Copyright 2000 to current year. 10:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: The selected field must already contain valid numeric data along with a Process Unit
recognised by AVEVA Instrumentation.

Right-click on such a field to display the following menu:

The Change Process Units sub-menu includes all the supported units for that process and
enables the user to change from one unit type to another unit type without changing the
value. For example 64°C to 64°F.
The Convert Units sub-menu includes all the supported units for that process type. The
example below shows the sub-menu for a Temperature field:

To convert the selected field to a new unit and change the value to reflect this, click on the
required unit from the sub-menu.

Conversion Prefixes
AVEVA Instrumentation uses a smart algorithm to recognise SI unit prefixes automatically
as follows:

Si Prefix Name Power

y yocto -24

z zepto -21

a atto -18

f femto -15

p pico -12

n nano -9

u micro -6

m milli -3

c centi -2

d deci -1

h hecto 2

© Copyright 2000 to current year. 10:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

k kilo 3

M mega 6

G giga 9

T tera 12

P peta 15

E exa 18

Z zetts 21

Y yotto 24

Note: For the conversion to be successful these Si prefixes must be used with their correct
case. e.g KPa will not be recognised. It should be kPa.

Note: By default AVEVA Instrumentation is configured as follows:

• Absolute Zero = -273.15.

• 1 Atmosphere = 101325.

10.1.4 Datasheet Change Preferences

The Datasheet Change Preferences window enables users to set their own datasheet
change highlighting method for all project datasheets.
Access the window by clicking Preferences on the Datasheet Data Entry window.

These preferences affect the Datasheet Data Entry window and printed datasheets when
using the Print with Previous Issue's Changes print option and are applied once a
datasheet is Issued.

Note: In a multi-user environment there will only be one set of preferences that will be
applied to all the users, i.e. each user cannot have their own preferences.

© Copyright 2000 to current year. 10:9 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Issue Changes:

Font Select the font from the drop down to show in issue change highlighting.

Font Size Select or enter the font size of the text in issue change highlighting.

Bold Specify whether the text in issue change highlighting will be bold or not.

Back Colour Select the back colour for issue change highlighting of cells.

Fore Colour Select the text colour for issue change highlighting of cells.

Current Changes:

Font Select the font from the drop down to show in current change
highlighting.

Font Size Select or enter the font size of the text in current change highlighting.

Bold Specify whether the text in current change highlighting will be bold or
not.

Back Colour Select the back colour for current change highlighting of cells.

Fore Colour Select the text colour for current change highlighting of cells.

Printing:

Watermark The text that appears as watermark on each Datasheet when printing if
there are any changed values since the last issue.

Note: To stop AVEVA Instrumentation from adding a watermark enter

the word: NONE

10.2 Datasheets List

The Datasheets List is the main grid for adding and editing datasheets. Datasheets in this
grid are listed by document number. By default, all datasheets assigned to instrument tags
in the project are shown in the grid.

Note: Datasheets assigned to catalogue instruments are not listed in the Datasheets List
grid.

Access the Datasheets List

To open the Datasheets List, click Select in the Grids and Schedules section of the Home
tab.
Select Datasheets under the Lists heading from the list of grids that is then displayed. The
Datasheets List grid is then displayed:

© Copyright 2000 to current year. 10:10 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Datasheets List - List Tools Options

The following options are located on the List Tools - Datasheets tab

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Action Section

Open Open the selected datasheet for editing/viewing/print previewing of the

technical data (editing of title block and revision information should be
done from the Edit button). Displays the Datasheet Data Entry window.

Update Displays the Update options window which updates the spreadsheets
of the selected datasheets with the current project data. If an Excel
workbook file does not exists the file is created in the project's datasheet
folder.

Update with Updates spreadsheets of selected datasheets with the changes

Changes highlighted in the previous issues of the datasheets.

Issue Issues and updates selected datasheet(s). It takes a snapshot of the

data in the datasheet's mapped cells and saves it to database for future
reference. Refer to Datasheet Issues for further information.

Open Issues Displays the Issues window listing all the issues of the selected
For Selected datasheet. Refer to View a List of Previous Issues for further
information.

Open Issues Displays the Issues window listing all the issues of all datasheets in the
For All list. Refer to View a List of Previous Issues for further information.

Revisions Displays a list of all datasheets and their revisions. Refer to Viewing and
Editing Multiple Datasheet Revisions.

Add Displays the Revision Entry window, used to add a revision to the
Revision currently selected datasheet. Refer to Create a Revision.

© Copyright 2000 to current year. 10:11 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Edit Displays the Revision Entry window, used to edit the current revision
Revision of a selected datasheet. Refer to Edit a Revision.

Highlight Used to highlight which issued datasheets include data that has been
Documents changed in the database and therefore should be reissued. Refer to
for Reissue Highlight Datasheets for Reissue.

Tools Section

Batch Displays the Batch Assign Tags to Datasheets window, which lists all
Assign Tags instrument Tags not yet assigned to a datasheet and provides facilities
for the assignment of multiple tags to datasheets in a batch process.
Refer to Batch Assign Multiple Tags to Datasheets for details.

Printing Section

Number of Select the number of copies of selected datasheets required for printing.
Copies

Print Print all selected datasheets.

Print with Prints with changes from the previous issue highlighted.
Changes

Print To PDF Creates a PDF file of the selected datasheets.

Print To PDF Creates a PDF file of the selected datasheets with changes from the
with previous issue highlighted.
Changes

Refer to Print Datasheets for further information on these options

Export Section

To External Publishes documents to the area that was set up using the Setup >
System Datasheets Publishing Configuration option on the Project tab.
Refer to Datasheet Publishing.

To Displays a window in which selected documents can be merged into a

Document single document, which is then added to the Document List and can be
List published. Refer to Merge Datasheets into a Single Document for
further information.

Selected
Datasheets

Copy / Archive to Used to export datasheet files to a folder

Folder defined during the export process. Refer to
Export Datasheets to a Specified Folder.

Copy / Archive to Used to export datasheet files to a folder

Folder with Changes defined during the export process with
changes from the previous issue highlighted.
Refer to Export Datasheets to a Specified
Folder.

© Copyright 2000 to current year. 10:12 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Copy to User Defined Used to export datasheet files to a pre-defined

Names folder or folders with file names in a pre-
defined, user-defined format. Refer to
Exporting Datasheets.

Copy to User Defined Used to export datasheet files to a pre-defined

Names with Changes folder or folders with file names in a pre-
defined, user-defined format, with changes
from the previous issue highlighted. Refer to
Exporting Datasheets.

10.3 Add New Datasheets

New datasheets can be created from the Datasheets List, Instrument List and Instrument
Catalogue, as follows:
• To add a new Datasheet from the Datasheets list, click New in the Records section of
the Home tab. The Add Datasheet window is displayed.
• To add a new Datasheet from the Instrument List or Instrument Catalogue, either click
the button that appears when the mouse is hovered over the Datasheet No cell, or on
the Datasheet tab of the Edit window for an instrument or catalogue instrument, click
the button next to the Datasheet No field.
If the instrument has not been assigned to a datasheet, the Add Datasheet for:
window is displayed (if it has been assigned, the datasheet will be opened in the
Datasheet Data Entry window).
The Add a new Datasheet window and the Add Datasheet for: window are very similar.
The differences are that the Add Datasheet for: window only lists datasheet form types
relevant to the type of the instrument and that the instrument type and the area of the
instrument are displayed in the window.

© Copyright 2000 to current year. 10:13 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Enter details for the new datasheet as follows:

1. Enter a datasheet number in the Datasheet No field.
Note: The number will be used as the document number, as appearing on the printed
datasheet form, and as the file name used by the Excel spreadsheet.

2. Enter a sheet or page number in the Sheet/Page No field, unless the Use Next Sheet
No checkbox is checked.
If the Use Next Sheet No checkbox is checked, AVEVA Instrumentation will
automatically use the next available sheet number by searching for all other datasheets
with the same Datasheet No and using next highest sheet number. If none are found
then AVEVA Instrumentation uses '1'.
Note: The document number is made up of: 'Data Sheet No' + '-' + 'Sheet/Page No'. When
the new datasheet is saved, AVEVA Instrumentation will check that this document
number is unique. If the combination of Datasheet No and Sheet/Page No has been
used before, an error message is displayed. A different combination must then be
entered.

3. If required, filter the list of forms displayed in the window by selecting a form type
(Datasheet or Other) from the Form Type list.
Note: Equipment items can be only be assigned a Datasheet type form once. They may be
assigned Other type forms as many times as required.

4. Select the required datasheet form from the list provided (from the Datasheet Form
Catalogue Grid).

© Copyright 2000 to current year. 10:14 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

5. Click Next > to create the new datasheet. The new, blank, datasheet is then added to
the Datasheet List and the Add a New Datasheet window is displayed, used to assign
tag(s) to the datasheet and to add of other information relevant to the new datasheet.
The window then changes to display more facilities for entering datasheet information:

Enter the required details for the new datasheet.

Note: If further datasheets are added during the current session Instrument Engineer will
remember the last Plant Area, Datasheet No and Form Type pre-filling those values
in this form.

The window is the same as the Datasheet Information window, used for editing existing
datasheets. Refer to Edit Datasheet Information for details.

10.4 Edit Datasheet Information

The Datasheet Information window is used to assign tags to each specific datasheet and
edit information about the datasheet including its Datasheet Number (Document Number)
and the revision information that appears in the datasheet title block.
The user can also use this window to edit tag data (double-clicking on any assigned tag
number in the Tags tab, or clicking Open displays the Instrument Edit window).
To open the Datasheet Information window, with the Datasheets List open, click Edit in the
Records section of the Home tab.

© Copyright 2000 to current year. 10:15 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The window is also displayed when assigning datasheets to an instrument tag or catalogue
instrument, although it is called Add a New Datasheet or Add Datasheet for: during that
procedure. Refer to Add New Datasheets.
The datasheet and sheet numbers may be changed if required (remember the combination
of these two numbers must be unique for the project).
If required, enter or change the plant area and the contract, requisition and purchase order
numbers of the datasheet.
There are five tabs in the bottom section of the window:

Tags Lists all tags assigned to this datasheet, and is used to assign
further tags, or unassign tags. For further details, see below.

Note: The number of tags that can be assigned to a datasheet is defined in the
Datasheet Form Catalogue for the current form type.

Note: When assigning a datasheet to an instrument tag or catalogue instrument, the

tag or catalogue instrument in question is listed.

Revisions Lists all revisions for this datasheet, and is used to add, edit and
delete revisions. For further details, see below.

Notes Used to enter notes for the current datasheet.

User Fields Used to complete the user fields for the current datasheet.

Other Contains fields used to enter any other, miscellaneous, datasheet

attributes, i.e. an alternative document number, a work pack
number, a design status, and any additional remarks.

© Copyright 2000 to current year. 10:16 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: The Last Edit field displays the date and time when the datasheet data was last
[Link] user name of the individual that performed the edit is displayed in a tool-
tip when the mouse cursor is hovered over the field. Click the button in the field to
display the Audit Manager, which will display a list of all the changes to the datasheet
data.

Assign a New Tag or Catalogue Instrument to the Datasheet

Double-click on any empty Tag Number record to display the Select Tag(s) to Assign to
Datasheet window (see Assign Tags To Datasheets for details) listing all tags or catalogue
instruments in the project Instrument List that have not already been assigned to a
datasheet.
A double-click on any Tag Number already assigned to a datasheet, or selecting it or
clicking Open displays the Edit window used for viewing/editing of detailed data as
required. Refer to Edit a Tag in the Instrument List for further information.

Note: The number of tags that can be assigned to a datasheet is defined in the Datasheet
Form Catalogue for the current form type.

Note: In the case of catalogue instruments, only a single catalogue instrument may be
assigned to the datasheet. In other words, before assigning a different catalogue
instrument to a datasheet, the catalogue instrument currently assigned must first be
unassigned (see below).

Reassign a Tag Position in the Current Datasheet

Drag and drop one tag onto the position of another to exchange their positions. This will
automatically move all tag data on the corresponding datasheet to the new column and/or
row positions next time the datasheet is updated.

Remove a Tag or Catalogue Instrument from the Current Datasheet

Select an Instrument and click Un-Assign.

Note: Removing a tag or Catalogue Instrument does not delete the tag or its data from the
project database. If the tag or Catalogue Instrument is reassigned to another
datasheet of the same form type (e.g Venturi Tubes) the data will be inserted into
that datasheet, which is useful if tags need to be moved between datasheets.

© Copyright 2000 to current year. 10:17 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Revisions Tab
The Revision Tab displays the revision history for the selected datasheet. The number of
revisions displayed and the column descriptions can be changed using the Preferences
window. For more information, refer to Options and Setup.

Use the following buttons to add, edit and delete revisions:

Add Displays the Revision Entry window, used to add a new revision to
current datasheet. See Create a Revision.

Edit Displays the Revision Entry window, used to edit the currently selected
revision. See Edit a Revision.

Note: Double-clicking on any existing Revision will also open the

Revision Entry window.

Delete Used to delete the currently selected revision.

Note: Pressing the <Delete> key will also delete the currently selected
revision.

Save Changes
Changes made using this window are not saved until the Save button is clicked.

Note: AVEVA Instrumentation does not update the external Excel workbook file with any
changes until either the datasheet is opened using the Open command or updated
using the Update command on the List Tools tab of the Datasheet List.

10.5 Assign Tags To Datasheets

Tags can be assigned to single datasheets when those datasheets are being defined. A
facility is also provided to assign tags to batches of datasheets.
Continue at:
• Assign Tags from the Datasheet Window
• Batch Assign Multiple Tags to Datasheets

© Copyright 2000 to current year. 10:18 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

10.5.1 Assign Tags from the Datasheet Window

In Tags tab of the Add a New Datasheet window (see Add New Datasheets) or the
Datasheet Information window (see Edit Datasheet Information), either select an empty
tag number record and click Assign or double-click on an empty tag number record.
The Select Tag(s) to Assign to Datasheet window is then displayed:

The Select Tag(s) to Assign to Datasheet window shows all the tags that have not yet
been assigned to any datasheet of the DataSheet form type.

Note: Instruments can be only be assigned to a datasheet of the Datasheet type form once.
They may be assigned Other type forms as many times as required.

The tags list can be filtered to enable easier access to tags using standard grid facilities, and
the Match Operating Principle checkbox.
When the Match Operating Principle checkbox is checked, only those tags with the same
Operating Principle as the Catalogue type of the datasheet are listed. When the Match
Operating Principle checkbox is not checked all tags from the Instrument List which have
any operating principle that is not blank (empty) are shown.

Note: Prior to creating datasheets it is recommended that users assign an operating

principle to all tags that require a datasheet in the Instrument List as only those tags
will appear in this window for assignment to a datasheet.

Assign a Tag to the current Datasheet

Double-click on a Tag Number to assign the selected tag to the current datasheet. Repeat
the double-click selection to assign more than one tag (if the current datasheet has multiple
tags that are yet to be assigned).

Note: The selected tag(s) are allocated to the next available spare tag position on the
datasheet. To change tag positions then the tags can be dragged into a new position
using the Edit Datasheet Information window.

Alternatively, click the Select checkbox for each to be assigned, then click the Select
button.

© Copyright 2000 to current year. 10:19 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

10.5.2 Batch Assign Multiple Tags to Datasheets

Instrument Engineer enables users to batch assign multiple tags to datasheets and so
create multiple datasheets. Each batch assignment must be for the same datasheet form
type. Datasheet form types are defined in the AVEVA Instrumentation Datasheet Form
Catalogue Grid.
With the Datasheets List open, click Batch Assign Tags in the Tools section of the List
Tools - Datasheets tab.
The Batch Assign Tags to Datasheets window is then displayed:

The Batch Assign Tags to Datasheet window shows all the tags that have not yet been
assigned to any datasheet.
To assign multiple tags to a datasheet type, click the Select checkbox for each tag to be
assigned.
The selected tags are added to the Tag No list to the right of the main grid.

Note: Use the column filters and the Select All button to select multiple tag numbers.

Or drag each instrument record to the Tag No list (or drag all selected records).

Note: Initiate a drag by selecting the white space to left of each record. If multiple Tag
records are selected the drag method will assign all the selected tags.

To remove a tag from the Tag No list select it, then press the <Del> (Delete) key.

© Copyright 2000 to current year. 10:20 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

To Create Datasheets for all the Tags

Select a Catalogue Form type from the Catalogue Form list.
If required, filter the list of forms displayed in the Catalogue Form list. by selecting a form
type (Datasheet or Other) from the Form Type list.
Specify the document naming rules by selecting or entering data for at least one of the
following options:
• enter a document number prefix (e.g. '07-DS-') in the Prefix field.
• specify the use of the Tag Number as part of the document number by checking the
Use Tag Number checkbox.
• specify a numeric value to append to the above values in the Numeric Identifier field,
and whether the numeric value is to be auto-incremented for each datasheet (e.g.
'4001') by checking the adjacent Increment checkbox.
• specify a sheet number in the Sheet Number field and whether this to be auto-
incremented for each datasheet by checking the adjacent Increment checkbox.
Click Create.
Engineer will then create new datasheets in the Datasheet List naming each datasheet
document as specified by the above settings.

10.6 Delete Datasheet Options

To delete datasheets, select the datasheets in the Datasheets List and click Delete in the
Records section of the Home tab.
If a selected datasheet has been added to a document list (see Document List), it cannot be
deleted, and a message is displayed to inform the user of this.
Otherwise, the following window is then displayed:

© Copyright 2000 to current year. 10:21 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The window provides the following options:

Delete from List Only Deletes the datasheet records from Datasheet List, but
does not delete the Excel spreadsheets, if they exist.

Delete Datasheet File Only Deletes any existing Excel spreadsheets, but does not
delete the datasheet records in the Datasheet List.

Delete from List and Deletes both the spreadsheet files and removes the
Datasheet File datasheet records from Datasheet List.

Delete Process Properties Delete process properties from tags assigned to the
datasheets.

Delete Instrument Delete instrument properties from tags assigned to the

Properties datasheets.

Click Delete to continue or Cancel to exit.

10.7 Print Datasheets

Selected datasheets can be printed in batch mode from the Datasheets List, as follows:
• Select the datasheet records to be printed.
• Select the number of copies to be printed from the Number of Copies in the Printing
section of the List Tools - Datasheets tab.
• Select the required the print option from the Printing section of the List Tools -
Datasheets tab:

Print Sends the latest issue of the selected datasheets to the

default printer.

Print with Changes Sends the latest issue of the selected datasheets to the
default printer. The printed copy is printed with the changes
made from the previous issue highlighted. Highlighted
changes are as specified by the Datasheet Change
Preferences window.

Print to PDF Prints the latest issue of the selected datasheets to a PDF file
which is stored in the folder designated in the Project Data
window.

Print to PDF Changes Prints the latest issue of the selected datasheets to a PDF file
which is stored in the folder designated in the Project Data
window. The PDF file highlights the changes made from the
previous issue. Highlighted changes are as specified by the
Datasheet Change Preferences window.

Note: The spreadsheet file must already exist to be printed. The Update facility (see
Datasheets List - List Tools Options) can be used on multiple datasheets to create/
update the datasheet spreadsheet file from the database. This ensures the latest
database information (e.g Revisions, Instrument List data changes such as Tag No,
Service, P&ID etc.) will be used.

© Copyright 2000 to current year. 10:22 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: Printing is handled by Microsoft Excel. To print datasheets Microsoft Excel must be
installed on the workstation.

10.8 Datasheet Revisions

Revisions can be assigned to datasheets. Each revision has a unique identifier, and is
assigned a date. Other details such as a description and details of the individuals that
created, checked and approved the revision may also be specified.
Continue at:
• Create a Revision
• Edit a Revision
• Viewing and Editing Multiple Datasheet Revisions

10.8.1 Create a Revision

To create a revision for a datasheet:
• In the Datasheet Information / Add a New Datasheet / Add Datasheet for: window
for the datasheet (see Add New Datasheets or Edit Datasheet Information), click Add
on the Revisions tab.
• Or, select the datasheet in the Datasheet List and click Add Revision in the Actions
section of the List Tools - Datasheets tab.
To create a revision for multiple datasheets:
• Select the datasheets in the Datasheet List and click Add Revision in the Actions
section of the List Tools - Datasheets tab.
When revisions are added using this method the details entered in Revision Entry
window are assigned to all selected datasheets.
The Revision Entry window is then displayed:

If a single datasheet was selected, enter the new revision number in the Revision No field.
If multiple datasheets were selected, a different version of the window is displayed:

© Copyright 2000 to current year. 10:23 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Either enter a revision number in the Revision No field to be applied to all the selected
datasheets, or click the Auto Increment checkbox (this is not available when editing
multiple revisions, only when creating). The Revision No field is then disabled. When Save
is clicked, all the revision numbers of the selected datasheets are incremented by one, e.g.
if the current revision is “A”, then the next is “B” or if current revision is “2”, then the next is
“3” etc.
Double-click on the Date field to open a date selection form (or press the Enter key when
the Date field is selected).
The Description field contains a list of all previously created revision descriptions. Add a
new description by entering it in the field. Any new descriptions will be available for future
revisions.

Note: Which fields appear on this window (apart from the Revision No, Date and
Description fields) and their names is specified on the Datasheet tab of the Options
window. See Options.

10.8.2 Edit a Revision

To edit the current revision of a datasheet:
• In the Datasheet Information / Add a New Datasheet / Add Datasheet for: window
for the datasheet (see Add New Datasheets or Edit Datasheet Information), select the
revision on the Revisions tab and click Edit.
• Or, select the datasheet in the Datasheet List and click Edit Revision in the Actions
section of the List Tools - Datasheets tab.
To edit the current revisions for multiple datasheets:
• Select the datasheets in the Datasheet List and click Edit Revision in the Actions
section of the List Tools - Datasheets tab.
When revisions are edited using this method the details entered in Revision Entry
window are assigned to all selected datasheets.
The Revision Entry window is then displayed. Edit the details as required.

© Copyright 2000 to current year. 10:24 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

If multiple datasheets were selected, the window will be blank except for the Date field.
Refer to Create a Revision for details.

10.8.3 Viewing and Editing Multiple Datasheet Revisions

To view a list of all revisions of all datasheets in the Datasheet List, click Revisions in the
Actions section of the List Tools - Datasheets tab. The Revisions window is displayed:

To view the revisions for a single datasheet, click on the + icon next to its listing.

© Copyright 2000 to current year. 10:25 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

To view revisions for all datasheets, click Show All Revs.

10.9 Datasheet Issues

To issue a datasheet:
• Open the datasheet (see View/Edit Instrument Datasheets) and click Issue.
• Or, select the datasheet in the Datasheet List and click Issue in the Actions section of
the List Tools - Datasheets tab.
A progress dialog for the issue is displayed:

If the report has already been issued at the current revision, or has had no revisions created
for it, a message window is displayed to inform that the user that a new revision must be
created before issuing.

© Copyright 2000 to current year. 10:26 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Click Cancel to cancel the issue or OK to create a new revision. Refer to Datasheet
Revisions for further information on creating a new revision.
Once the revision has been created, or if neither of the above conditions apply, the
datasheet revision is issued, and opened in Microsoft Excel.
To view a list of previous issue, see View a List of Previous Issues.

10.9.1 Highlight Datasheets for Reissue

To highlight issued datasheets which include data that has been changed in the database,
and therefore require reissuing, select the datasheets to be checked from the Datasheets
List and then click Highlight Documents for Reissue on the List Tools - Datasheets tab.
The datasheets are then checked for changed data, and those that include changed data
are highlighted to the user by displaying an asterisk * in the Rev field after the revision
number.
The highlighting datasheets should then be issued again (refer to Datasheet Issues).

10.9.2 View a List of Previous Issues

AVEVA Instrumentation saves all previous Issues of datasheets. This enables users to
access any previous issued datasheets for information etc.
To view previous issues:
• Click Open Issues for Selected or Open Issues for All as required, accessible from
the drop-down menu displayed by clicking the button next to the Issue button on the
Datasheet window (see View/Edit Instrument Datasheets).

• Or, click Open Issues for Selected or Open Issues for All as required in the Actions
section of the List Tools - Datasheets tab.
The Issues window is then displayed:

© Copyright 2000 to current year. 10:27 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Command Buttons:

Open Open the selected issue in Excel.

Delete Deletes the selected issue.

Print Prints the selected issue(s).

Find Displays the Find window, used to search for any text string located
anywhere within the grid.

Filter Displays up window used to define Advanced Grid Filters for the grid.

Refresh Updates entire grid with latest database information (useful in multi-user
project environments).

Close Closes the window.

10.10 Import Datasheets from Excel

Engineer can import Excel spreadsheets, for example those from vendors or from other
departments (e.g Process department). Data imported from spreadsheets will replace data
on an individual cell/field basis. All differences between current and data to be imported is
highlighted to users, enabling acceptance or rejection of the data, again on a field by field
basis.

10.10.1 Import Datasheets

To import a datasheet into Engineer the following is mandatory:
• The Excel spreadsheet must be identical in layout to a Datasheet Form Catalogue
definition previously defined in Datasheets (ideally it would be exported from the
AVEVA Instrumentation project using the Export to Excel option on the Manage tab).
• The Excel spreadsheet file name (.xls) must be identical to a previously created
datasheet in the Datasheet List (the datasheet file name is in the format 'DocNo-Sheet'
- that is: the document number + '-' + Sheet Number).

© Copyright 2000 to current year. 10:28 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

• The Excel spreadsheet file must reside on an accessible disk (either on a network,
local hard disk or removable drive). Furthermore, if multiple spreadsheet files are to be
imported it is recommended that they all reside in same directory/folder.
Note: The easiest way to satisfy the above criteria is to create the datasheet using the
AVEVA Instrumentation Engineer application (this will satisfy the first two criteria
above), then copy the created Excel spreadsheet to a directory for editing in Excel.

To import an Excel datasheet, with the Datasheets List open, click From Excel in the
Import section of the Manage tab.
The Datasheet(s) Import window is then displayed:

Note: The entry in the Datasheet folder field defaults to the folder selected during the last
import.

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Click the button to the right of the Datasheet Folder field to display the Browse for Folder
window.

© Copyright 2000 to current year. 10:29 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Select the folder that holds the Excel spreadsheets and click OK. The Datasheet(s) Import
window refreshes and displays a list of valid spreadsheets in the selected folder.

Note: In this context a valid datasheet spreadsheet means the Excel spreadsheet file name
(.xls) must be identical to a previously created datasheet in the Datasheet List.

© Copyright 2000 to current year. 10:30 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

To select a spreadsheet to import, select the Import checkbox (on left of each Datasheet
filename) then click Import. To import all spreadsheets check the Select All checkbox
above the list then click Import.
Clicking Import processes each selected spreadsheet and displays a detailed list of
proposed changes, for example differences between data in the spreadsheets and the
current database.
To cancel without importing click Cancel.

10.10.2 Accept Changes

For each Excel spreadsheet selected for import, a detailed list of differences is shown.

Note: The list in this window shows all values that are different in the imported Excel
spreadsheet and the AVEVA Instrumentation database. Values that are the same are
not listed.

© Copyright 2000 to current year. 10:31 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Check the Accept checkbox of those changes that are to be imported.

To accept all changes, click on the Accept All checkbox. If necessary, users can then scroll
through the list of all field values and check or uncheck the Accept checkboxes on a field by
field basis.

Note: The import is done on a per tag basis. The tag value is shown in parentheses after
the field name.

Tag numbers are never imported. The data from each imported datasheet is applied to each
tag that has already been assigned to each datasheet, refer to Assign Tags To Datasheets
for further information.
To import the checked values click Import.
To cancel any import for the current Excel spreadsheet click Cancel.
For both of the above commands, if multiple files are selected for import Instrument
Engineer will display the next files 'Delta Values' window. If multiple files have been selected
for import, users can stop all imports by clicking the Stop Importing command.

10.11 Datasheet Publishing

Datasheets in the Datasheet List can be published, i.e. their Excel files saved to a pre-
defined location.
PDF versions of the published datasheets may also be produced.
The folder that datasheets are published to, whether or not PDF versions of the published
files are to be produced, and other options, are specified using the Publishing Configuration
window.

10.11.1 Publishing Configuration

Before datasheets can be published, a number of configuration options must be specified.
Select Setup > Datasheets Publishing Configuration from the Project tab. The Export to
External System Configuration window is then displayed:

© Copyright 2000 to current year. 10:32 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

In the Publishing folder field, enter the folder into which datasheets are to be published, or
click … and browse for it.
If PDF versions of published files are to be generated using Excel, in addition to the
published Excel files, check Publish as PDF.
If PDF versions of published files are to be generated using a PDF generator other than the
Excel PDF writer, in the Executable to handle publishing field, enter the name and
location of the executable file that will handle the publishing, or click … and browse for it. If
Publish as PDF is checked, this setting will be ignored.
For each published datasheet, an XML file containing selected datasheet data is also
produced in the publishing folder. To select the datasheet data that the XML file will include,
click Add. A blank row is added to the area below this button. From the drop down list in this
row, select the required datasheet data. Repeat for each type of datasheet data required.
To delete a row, select it and click Delete. A message will be displayed requesting that the
deletion be confirmed. Click Yes.
If no fields are selected, the XML files are not generated.
To save configuration changes and exit the window, click Save.
To exit the window without saving any changes, click Cancel.

© Copyright 2000 to current year. 10:33 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

10.11.2 Publish Datasheets

To publish datasheets, select them in the grid and click To External System in the Export
section of the List Tools - Datasheets tab. Multiple datasheets can be selected and
published.
The datasheets will then be published to the publishing folder along with (optionally) the
PDF and XML data files.
If PDF versions of the datasheets are to be generated using a PDF generator other than
Excel, this is opened and used to generate the PDFs instead.
Any errors that occur during the publishing process are reported in the Error Summary
window.

Click Continue to carry on with the procedure or Cancel to stop it.

10.12 Merge Datasheets into a Single Document

Multiple datasheets can be merged into a single document which can then be published.
Documents created by merging datasheets are listed in the Documents List grid. Refer to
Document List for further information.
Datasheets are merged using the Document Information window, which is accessible from
the Datasheets and Documents List grids.
To merge datasheets from the Datasheets grid, select the datasheets to be merged and
click To Document List in the Export section of the List Tools - Datasheets tab. The
Document Information window is then displayed.
To merge datasheets from the Document List grid, click New to display the Document
Information window.
To change the datasheets assigned to an existing document, select the document from the
Document List grid and click Edit to display the Document Information window.

© Copyright 2000 to current year. 10:34 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

If the Document Information window is accessed from the Datasheets grid, the
datasheets that were selected are listed in the lower half of the window on the Main tab.
These can be removed and further datasheets can be added.
If the Document Information window is accessed by clicking New on the Document List
grid, no datasheets are listed. Add datasheets as described next.
If the Document Information window is accessed by clicking Edit on the Document List
grid, the datasheets previously assigned to the document are listed. Add or remove
datasheets as required.

10.12.1 Assign Datasheets to the Document

To assign a datasheet to the document, click Assign DataSheet to display the Select
Datasheets window.

© Copyright 2000 to current year. 10:35 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

To select a datasheet, either double-click on it, or highlight it and click Select. The datasheet
is then added to the list in the Document Information window.

10.12.2 Unassign Datasheets from the Document

To unassign a datasheet from the document, click on the datasheet in the list in the
Document Information window and click UnAssign DataSheet. The selected datasheet is
then removed from the list and from the document.

10.12.3 Enter Basic Document Details

Basic document details are entered in the upper half of the Main tab.
Enter the number of the document in the Document Number field. The filename and path
of the document is displayed in the Document Publishing File field once the document is
saved.

Note: The filename will be the same as the document name.

Select the file type from the Format list, PDF, Excel or Zip. The Zip format is a collection of
Excel files, one for each document sheet, in a .ZIP file. The PDF and Excel formats are
single, multi-page files that include all the document sheets.
To select the datasheet that will be used as the front page for the document, click the Select
button next to the Front Sheet field. The DataSheet Catalogue window is displayed.

© Copyright 2000 to current year. 10:36 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The Datasheet Catalogue window lists all those datasheets from the catalogue of the Front
Sheet type. To create a new front sheet datasheet, click New. The Catalogue Information
window is then displayed, in which details of the new datasheet can be entered. Refer to
Add a New Datasheet Definition for details.
To select a datasheet, either double-click on it, or highlight it and click Select. Once a front
sheet datasheet is selected, it is displayed in the Front Sheet field. Click the adjacent Clear
button to de-select it and clear the field.
To generate an index sheet for the document, click Create next to the Index Sheet field. A
standard index sheet is then automatically generated for the document and is displayed in
the Index Sheet field. The Create button is then replaced by a View button. Click View to
open the index sheet in the Custom Report window from which it can be edited if required.
Refer to Reports for details. Click the adjacent Clear button to delete the index sheet.
To select the datasheet that will be used as the summary page for the document, click the
Select button next to the Summary Sheet field to display the Datasheet Catalogue
window. To create a new Summary Sheet datasheet, click New. The Catalogue
Information window is then displayed, in which details of the new datasheet can be
entered. Refer to Add a New Datasheet Definition for details. Follow the same procedure as
for front sheets, as described above.
To select a datasheet, either double-click on it, or highlight it and click Select. Once a
summary sheet datasheet is selected, it is displayed in the Summary Sheet field. Click the
adjacent Clear button to de-select it and clear the field.

© Copyright 2000 to current year. 10:37 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Revisions
Document revisions are added, edited and deleted using the Revisions tab.

Note: Revisions can also be added, edited and deleted from the Document List window.

To add a new revision, click Add to display the Revision Entry window.

Complete the fields as required.

Note: The text field descriptions displayed are dependant on the settings made in the
Preferences window. For further information refer to Options and Setup.

When creating a new revision, leaving the Revision No field blank will cause
Instrumentation to use the next revision number. e.g. if the current revision is "A", then the
next is "B" or if current revision is "2", then the next is "3" etc.

© Copyright 2000 to current year. 10:38 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The Date field defaults to the current date, but a different date may be selected if required.
The Description field contains a list of all previously created revision descriptions. Add a
new description by entering any required description. Any new descriptions will be available
for future revision entries.
Once a revision is created it is listed in the Revisions tab.
To edit a revision, select it and click Edit to display the Revision Entry window. Change the
revision details as required and click Save.
To delete a revision, select it and click Delete. The revision is then deleted.

Note: New revisions, changes to revisions and deletions of revisions are not saved to the
project database until the Save button is clicked.

Title
Enter the document title text in the fields in the Title tab.

User Fields
Enter any user/project specific text in the fields in the User Fields tab.

© Copyright 2000 to current year. 10:39 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Notes
Enter any notes or remarks in the fields in the Notes tab.

10.12.4 Save and Publish the Document

To save the document and exit the Document Information window, click Save.
The document is then published in accordance with the settings specified on the Main tab.
A Progress window displays the progress of the procedure.

© Copyright 2000 to current year. 10:40 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: Documents can also be published from the Document List window. See Document
List.

To exit the Document Information window without saving or publishing, click Cancel.

10.13 Document List

Multiple datasheets can be merged into a single document which can then be published.
Refer to Merge Datasheets into a Single Document.
These documents are listed the Document List grid, from where they can be viewed, edited
and published. New documents can also be created from this grid.
To open the Document List, click Select in the Grids and Schedules section of the Home
tab.
Select Document List from the list of grids that is then displayed. The Document List grid is
then displayed:

Refer to Working with the Data Grid for information on the grid controls including selecting a
document record, and sorting and filtering the grid data.
Document details cannot be edited directly in the grid. They are edited using the Document
Information window. Refer to Merge Datasheets into a Single Document for details.

Open a Published Document

Once a document has been published, it may be opened by clicking on the button that is
displayed in the Publishing Path field when the mouse cursor is hovered over it.
If the document has not been published, a message is displayed informing the user of this
when the button is clicked.

© Copyright 2000 to current year. 10:41 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Documents List - List Tools Options

The following options are located on the List Tools - Document List tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Action Section

Update Publishes the selected document. Refer to Publish Documents.

Revisions Displays a list of all documents and their revisions. Refer to View
and Edit Multiple Document Revisions.

Add Revision Displays a window for adding a new document revision. If multiple
documents are selected, a new revision may be added to each of
these. Refer to Add and Edit Revisions for Single Documents and
Add Revisions to Multiple Documents.

Edit Revision Displays a window for editing the most recent revision of document.
Refer to Add and Edit Revisions for Single Documents.

Refresh Sheet/ Updates the grid with the current sheet/page counts of the listed
Page Count documents.

10.13.1 Delete Documents

To delete documents, select the documents from the Document List and click Delete in the
Records section of the Home tab. The Delete Document? window is then displayed:

© Copyright 2000 to current year. 10:42 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Select the required deletion option:

Delete from List Only Deletes the documents from the Document List but does not
delete any published document files.

Delete Document Only Deletes published files but does not delete the documents
from the list.

Delete from List and Delete the documents from the Document List and delete
Document any published files.

Click Delete to proceed with the selected type of deletion.

Click Cancel to cancel the deletion.

10.13.2 Publish Documents

To publish documents, select them in the Document List grid and click Update on the List
Tools - Document List tab.
A message is then displayed to warn that files previously published from the document(s)
may be overwritten. Click Yes to proceed with the publishing or No to cancel.
If Yes is clicked, the documents are then published in accordance with the settings specified
on the Main tab of the Document Information window (see Merge Datasheets into a Single
Document). A Progress window displays the progress of the procedure for each selected
document.

10.13.3 Document Revisions

View and Edit Multiple Document Revisions

To view a list of all revisions of all documents in the Document List, click Update on the List
Tools - Document List tab. The Revisions window is displayed:

© Copyright 2000 to current year. 10:43 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

To view the revisions for a single drawing, click on the + icon next to its listing.
To view revisions for all drawings, click Show All Revs.
To edit an existing revision click Edit. The Multi-Field Edit (Bulk Edit) window is displayed.

© Copyright 2000 to current year. 10:44 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

• To edit a revision field, check the appropriate checkbox and enter the new value.
• Click Select all to select all fields for editing.
• Click Copy first record's data to copy the values for the revision first selected in the
Revision window into the fields.
• Once the required changes have been entered, click Save.
To add a new revision, click New. The Revision Entry window (described below) is then
displayed. Enter the required details and click Save.
To delete a revision, select the revision and click Delete. A message will then be displayed
requesting that the deletion be confirmed. Click Yes to confirm the deletion or No to cancel.

Add and Edit Revisions for Single Documents

To add a new revision for a single document from the Document List, click Add Revision on
the List Tools - Document List tab.

Note: Revisions can also be added and edited using the Revisions tab of the Document
Information window. Refer to Enter Basic Document Details for details.

The Revision Entry window is then displayed:

© Copyright 2000 to current year. 10:45 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Complete the fields as required.

Note: The text field descriptions displayed are dependant on the settings made in the
Preferences window. For further information refer to Options and Setup.

When creating a new revision, leaving the Revision No field blank will cause
Instrumentation to use the next revision number. e.g. if the current revision is "A", then the
next is "B" or if current revision is "2", then the next is "3" etc.
The Date field defaults to the current date, but a different date may be selected if required.
The Description field contains a list of all previously created revision descriptions. Add a
new description by entering any required description. Any new descriptions will be available
for future revision entries.
Once a revision is created it is listed in the Revisions tab of the Document Information
window. Refer to Enter Basic Document Details for details.
To edit a revision, select it and click Edit Revision on the List Tools - Document List tab.
The Revision Entry window is then displayed. Change the revision details as required and
click Save.

Add Revisions to Multiple Documents

To add a new revision to multiple documents, select the documents from the Document List
then click Add Revision on the List Tools - Document List tab.
The Revision Entry window is then displayed.

© Copyright 2000 to current year. 10:46 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Edit the revision details are described above.

When revision entries are added using this method the Revision Entry window entries are
assigned to all selected datasheets.

10.14 Datasheet Form Catalogue

All AVEVA Instrumentation Engineer datasheets are based on user-definable Excel
Worksheets that are used as the templates for each datasheet.
The Datasheet Form Catalogue contains all datasheet forms and their attributes, including:
• Name of datasheet type and its Operating Principle.
• Layout/Design (i.e. the name of Excel spreadsheet file).
• Database table(s) used to store data within the AVEVA Instrumentation database.
• Field definitions (one per spreadsheet cell is required).
• Spreadsheet cell to database field mappings (using AVEVA Instrumentation
DataLinks).
A catalogue datasheet definition is complete when each cell in the catalogue datasheet is
mapped to an AVEVA Instrumentation database field.
When a project datasheet is created, it is configured in accordance with a selected
catalogue datasheet. The data mappings will populate the cells of the project datasheet with
the required data from the project datasheet, both generic project data, and data specific to
the item that is the subject of the datasheet. In turn, changes to data in the datasheet will
automatically update the equivalent data in the database.

Suggested Workflow to create a new Catalogue Datasheet Template

The Excel spreadsheet layout must first be created in Microsoft Excel (97 to 2010) prior to
adding the new template form to the AVEVA Instrumentation Datasheets Catalogue. The
fastest ways to do this are to copy and modify an existing Datasheet spreadsheet provided
with Instrument Engineer, or to copy and modify one previously created for the project.
In completing the layout in Excel, pay attention to fonts, justification and merged cells to
complete the ideal form for a particular instrument type. All physical attributes of the form
including fonts, cell sizing/merging, cell formatting (bold, italics and justification etc.), print

© Copyright 2000 to current year. 10:47 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

setup, margins, colours, shading etc. are controlled by this Excel template. There is no
control of formatting/layout within AVEVA Instrumentation, which just transfers data between
the spreadsheet cells and the AVEVA Instrumentation database.
Once new spreadsheet layout is complete, register it in the Datasheet Form Catalogue Grid
(see Add a New Datasheet Definition).
Once the new Catalogue Datasheet template is registered, open this datasheet template in
design mode from the Datasheet Form Catalogue Grid List and define map the datasheet
cells to the appropriate database fields (see Map Database Fields to Datasheet Cells). This
step enables AVEVA Instrumentation to update each cell with the required database data
(and vice versa).

Note: AVEVA Instrumentation can only save data to/from the project database/Excel
workbook if a worksheet cell is mapped to a database field. Any other data will not be
saved.

Finally, while in the design mode, assign picklists cells for more efficient data entry (see
Assign a PickList to a Cell).
When this is completed, the new datasheet template is then ready for use on the project.

10.14.1 Datasheet Form Catalogue Grid

The Datasheet Form Catalogue grid is used to create new datasheet form definitions and to
edit existing definitions and templates.
To open the Datasheet Form Catalogue grid, click Select in the Grids and Schedules
section of the Home tab.
Select Datasheet Forms under the Catalogues heading from the list of grids that is then
displayed. The Datasheet Form Catalogue grid is then displayed:

The Datasheet Form Catalogue grid displays information for each datasheet form definition.

© Copyright 2000 to current year. 10:48 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Datasheet Form Catalogue - List Tools Options

The following options are located on the List Tools - Datasheet Catalogue tab:

Records Section

Refresh

New These common options are also located on the Home tab.
Edit Refer to the Common Functionality User Guide for details.

Delete

Actions Section

Open Opens the selected datasheet definition for editing. Refer to Map
Database Fields to Datasheet Cells and Assign a PickList to a Cell.

Open In Opens the selected datasheet template in Excel.

Excel

Printing Section

Number of Used to select the number of copies to be printed using the Print Forms
Copies option.

Print Forms Prints selected empty (blank) Catalogue templates (the datasheet Excel
spreadsheet template).

10.14.2 Add a New Datasheet Definition

The Excel spreadsheet layout must first be created in Microsoft Excel (97 to 2010) prior to
adding the new template form to the AVEVA Instrumentation Datasheets Catalogue. The
fastest ways to do this are to copy and modify an existing Datasheet spreadsheet provided
with Instrument Engineer, or to copy and modify one previously created for the project.
To add a new Datasheet definition to the project catalogue, with the Datasheet Form
Catalogue Grid grid open, click New in the Records section of the Home tab.
The Select Form Type window in then displayed:

Select the type of datasheet definition to be created and click Save.

© Copyright 2000 to current year. 10:49 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Select DataSheet to create a form for instrument datasheets. Select Other to create a form
for other types of document that can be generated for instruments, such as calibration
sheets, maintenance documents etc. Front Sheets and Summary Sheets are used when
datasheets are merged into a single documents (refer to Merge Datasheets into a Single
Document).
The Catalogue Information window is then displayed.

The version of the Catalogue Information window displayed above is that displayed if the
selected datasheet definition type was “DataSheet”. If the selected type was Front Sheet or
Summary Sheet, a different version is displayed:

Note: The ... button at the end of the File Name field can be used to locate any existing
spreadsheet file and to copy the selected file to the project datasheet template folder.
Any Excel file can be used, including Excel workbooks with multiple worksheets.

© Copyright 2000 to current year. 10:50 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The template folder for the current project is listed on the Project Data window, accessed by
selecting Edit Project on the Project tab.

To Copy an Existing Form Definition

A new form definition can be copied from any other form in the current project or from
another AVEVA Instrumentation project.
To copy an existing form select the Copy Definition button to display the Copy an Existing
Datasheet form definition window, used to select an existing datasheet form. Refer to
Copy Existing Catalogue Datasheet Definition for details.

Manually Create a New Form Definition

1. Enter a name for the new form in the Form Name field.
2. Enter a useful Description for the new form.
3. In the Max No. of Plant Connections field, enter the maximum number of plant
connections, i.e. the maximum number of mappings to the properties of process items,
that can be defined on the form.
4. Enter the Number of Tags that will be detailed on this form.
Note: The Max No. of Plant Connections and Number of Tags fields are not relevant to
Front Sheets and Summary Sheets and are not displayed when they are being
defined.

5. Enter the Excel spreadsheet file name in the File Name field. The file must exist in the
Project Datasheets template directory.
6. Select the file format (.xls or .xlsx).
Note: The ... button at the end of the File Name field may be used to locate any existing
Excel file. The file will then be copied to the template folder for the AVEVA
Instrumentation project and renamed to match the form name entered in this window.

7. Enter the spreadsheet cell dimensions (number of columns and Rows). These are
used to limit AVEVA Instrumentation's view of each template to those dimensions. This
restricts viewing to the number of columns and rows entered here.
8. From the Principle of Operation list, select the operating principle which best
describes the type of instrument(s) to be specified on this datasheet. The operating
principle is used to automatically match instruments from the Instrument List with the
form type definition.
This is not relevant to Front Sheet and Summary Sheet definitions and therefore the
field in question is not displayed.
If the Other form type was selected, the field default to the “Other” principle of
operation. A different principle of operation can be selected if required (this will not
change the form type).
9. Click Save to save the definition information or Cancel to exit without saving.
Note: The spreadsheets used for form definitions may include checkboxes. However,
checkboxes will not be displayed in the AVEVA Instrumentation, i.e. in the Datasheet
Design window or the Datasheet viewer window. Checkboxes therefore must be
replaced with a picklist with values of True and False only. Refer to Checkboxes on
Datasheets for details.

© Copyright 2000 to current year. 10:51 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

10.14.3 Edit Datasheet Definition Information

To edit a new Datasheet definition, select it from the Datasheet Form Catalogue Grid, and
click Edit in the Records section of the Home tab. The Catalogue Information window is
then displayed.

Once a catalogue datasheet is saved, the form name cannot be edited.

Refer to Add a New Datasheet Definition for details of how to enter data in this window.

10.14.4 Copy Existing Catalogue Datasheet Definition

When creating a new catalogue datasheet form definition, users can copy any existing form
definition by clicking the Copy Definition button on the Add a New Datasheet Definition
window.
The Copy an Existing Datasheet form definition window is then displayed.

© Copyright 2000 to current year. 10:52 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The window lists the existing Catalogue Datasheet form definition in the project.
To copy an existing form definition, double-click on the form record in the window above, or
select it and click Copy.
If required form definitions may be copied from a different project. Click Select a Project.
The Select an AVEVA Instrumentation Project window is then displayed. Select the
required project from the list of projects listed in this window. The Copy an Existing
Datasheet form definition window then displays the form definition in that project. Select
the required form definition as described above.

Note: AVEVA Instrumentation also provides facilities to import multiple form types from
another AVEVA Instrumentation project. Refer to Import Catalogue From Other
Project for details.

After selecting the form type, the window is closed and the Catalogue Information window
is displayed again. When that window is saved, the existing form definition is copied,
including the Excel file and field to cell mappings (DataLinks).

10.14.5 Map Database Fields to Datasheet Cells

The Datasheet Design window is used to add or modify the database field to workbook/
worksheet cell mappings for each form definition in the Datasheet Catalogue.
To display the window, elect the form definition from the Datasheet Form Catalogue Grid
and click the Open option in the List Tools - Datasheet Catalogue tab.

© Copyright 2000 to current year. 10:53 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The window shows the datasheet form layout as previously created using Microsoft Excel.
There are two main areas on this window:

Datasheet Layout
The left-hand area contains the spreadsheet layout and shows each cell as previously
defined in Microsoft Excel. The layout cannot be changed [Link] must be done using
Microsoft Excel. The grey coloured cells indicate which cells have been mapped (or linked)
to a database field.

Note: To see which DataLink (field) is mapped to a particular cell click in the cell and the list
view will highlight the [Link] the DataLinks List View (see below). The feature
works only when the Used checkbox is checked in the DataLinks List View.

DataLinks List View

The right-hand area contains a list of all DataLinks (database fields and properties)
previously defined in AVEVA Instrumentation. This list is used to map cells on the datasheet
template, to fields and properties within AVEVA Instrumentation for data transfer.
Fields from the following tables are available:
DSheets, for example: Document No, Rev, Sheet No., UserField1, UserField2 etc.
Instrument List, for example: Instrument Tag Number, Instrument Service,
Manufacturer, Model Number etc.
ProjectData, for example: Project Name, PlantName, Plant Location etc.
LoopList, fields for displaying properties of the loop the instrument is allocated to,
Loop No, Loop Service etc.
WorkPacks, for example: Work Pack Number, Work Pack Description etc.

© Copyright 2000 to current year. 10:54 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

InstProcessData>PlantConnection, these fields store data related to items of

process equipment created in the AVEVA Instrumentation Process Engineer Module
and associated with an instrument.

Note: Fields for both process equipment and process lines are stored in this table. Ensure
that when selecting a field it is relevant to the type of item (equipment or line) in
question.

ProcessProperties>PlantConnection, these fields store data related to process

lines created in the AVEVA Instrumentation Process Engineer Module and associated
with an instrument.

Note: The maximum number of plant connection DataLinks of each type is specified when
a form is defined.

Note: Data should be mapped to Instrument List, Process Data and Datasheet/Revs List
first. Once these common fields are mapped, then map any remaining cells to the
Generic fields in the DSHData table. DSHData is used a generic database location
for all datasheet information that lies outside Process Data and Instrument List data.
These fields can have their captions renamed for each specific datasheet form type
so that users can identify their contents when importing data for viewing multiple tag
data using the Browse Data by Form Type list (see View Data by Form Type).

Note: New properties and the fields to be used to represent them can be user-defined for
equipment. Refer to Add New Property Definition. See also the New Properties
button (described below).

Note: The Print button in this window prints the datasheet form with Datalink mappings.

When this window is first displayed, the DataLinks List view shows used DataLinks only.

Note: Sort the lists by clicking on the column header (e.g. In figure above: “Table” sorts by
Table name, “Field” sorts by field name, “Tag” sorts by tag name etc.).

Whether used or unused DataLinks are displayed is controlled by the Used checkbox. To
view only unused DataLinks, uncheck the Used checkbox. To display both used and
unused DataLinks, clear the Used/Unused filter by clicking on the “clear filter criteria” button
next to the Used checkbox.

Map a DataLink to a Cell

Drag the required DataLink from the Fields list to the desired cell and drop the DataLink onto
the cell. If the mapping is successful the cell will become grey.

Note: If the DataLink is for the first (Tag1) of a multiple tag datasheet then the dragging and
dropping of a Tag1 field will auto-assign all other DataLinks of the same field name if
both Tag1 TagNo and Tag2 TagNo fields are already mapped.
For example, if the user drags ElecVolts for Tag1, if the Automatic Copy for
multiple Tags checkbox (at top of window - only displayed for form definitions with
multiple tags) is checked, then Engineer will attempt to assign DataLinks for
ElecVolts to Tags 2, 3 and 4 also, using the row/column offset between Tag1 and
Tag2 to offset the other fields. The feature makes assigning mappings for multi tag
datasheets far more efficient.

Note: It is recommended that the DataLink list view is sorted by Field to more easily identify
the fields being mapped.

© Copyright 2000 to current year. 10:55 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Note: If a picklist is assigned to a field in the Grid Manager (see the Common Functionality
User Guide for details), the picklist will not automatically be available for that field
when mapped to a cell in a datasheet. The pick-list must still be assigned to the cell
using the facilities described below (see Assign a PickList to a Cell).

Unmap or Unassign a Mapped Cell

Right-click on the cell to display a menu and select the Delete DataLink option.

Note: Multiple cells or ranges can be selected and multiple Datalinks deleted from using
this option (hold the Ctrl key down to select multiple cells).

Command Buttons

Save Saves the mappings to the database.

Print Opens the datasheet excel file in a print preview window with all the
mapped field names populated in their respective cells.

Zoom Zooms the Datasheet Layout area according to the value selected

from drop down. Use the buttons to decrement or increment

the zoom by 10%.

New Opens a sub-menu with the following options:

Properties
New Instrument Data Property
New Process Data Property
Auto Create Properties
The first two options open the Property Definition window, used for
creating a new Instrument or Process data property as appropriate.
Refer to Add New Property Definition for details.
The Auto Create Properties option opens the Auto Create
Properties window, used to create multiple new properties with
attributes derived from headings on the datasheet. Refer to Auto
Create Properties for details.

Close Closes the window and confirms to save any changes made.

Automatic Only displayed for form definitions with multiple tags. Used to map
Copy for multiple datalinks of the same sort to multiple tags in a form definition
multiple Tags See Map a DataLink to a Cell for details.

Once saved, the new or modified Catalogue Form is ready to be used on the project. It is
recommended that the mappings be tested thoroughly prior to use on a project.

Note: Users should not modify these cell/field mappings for a datasheet type at the same
time other users are accessing datasheets of the same Catalogue type.

Change Field Captions for Instrument Properties

When mapping cells from the Instrument Properties table, users can define their own field
captions for when AVEVA Instrumentation displays the data outside the normal Datasheet
view. The Browse by Form Type facility (see View Data by Form Type) and the datasheet
import process (see Import Datasheets from Excel) will by default show the AVEVA

© Copyright 2000 to current year. 10:56 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Instrumentation field name, however a user-defined caption will be shown instead if a

caption has been defined.
To enter a user-defined caption, after a cell is mapped to a field, with the Used option
selected, double-click in the DataLink List view on any linked cell from the Instrument
Properties.
AVEVA Instrumentation will set the Caption column into edit mode, enabling users to enter
a caption/description, by clicking the button that appears in the cell when the mouse is
hovered over it, entering the caption in the Caption for: window that is then displayed, and
clicking Save.

10.14.6 Assign a PickList to a Cell

Once a PickList has been defined (refer to Using PickLists) it can be assigned to cells within
the catalogue datasheet for use during data entry.
While in the Datasheet Design window, right-click on any cell that has already been
mapped to a database field to display a pop-up menu:

Select the Add Picklist option, then select the PickList name from the sub-menu.
To define new PickLists select Add Picklist > Add New PickList and in the resulting text
box enter the name of new picklist to be added, then press enter (to define new items or
modify existing items in a PickList refer to Using PickLists).

To delete an existing picklist select Delete Picklist from the pop up menu.
To edit the values in an existing picklist select the Edit Pick List Values from the menu. The
PickList edit window will be displayed, enabling additional values to be added, edited or
changed in the selected PickList.
For example:

© Copyright 2000 to current year. 10:57 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Refer to Using PickLists for further information on editing PickLists.

10.14.7 Checkboxes on Datasheets

The spreadsheets used for form definitions may include checkboxes. However, checkboxes
will not be displayed in the AVEVA Instrumentation, i.e. in the Datasheet Design window or
the Datasheet viewer window (although they will be displayed in any Excel output).
Checkboxes therefore must be replaced with a picklist with values of True and False only.
For how to add a checkbox to an Excel spreadsheet and link it to a cell, refer to the
appropriate Microsoft Excel documentation. The following points should be noted however:
• The background colour of the cell should be set to white in order to hide the AVEVA
Instrumentation picklist value (i.e. True or False) when opened in Excel.
• The Number format of the linked cells must be set to General.
Create a picklist to be used as a substitute for a checkbox in the normal way (refer to the
AVEVA Instrumentation Common Functionality User Guide for details). The picklist must be
of the True/False data type.
The picklist must then be assigned to the appropriate property (refer to Property
Definitions), either an existing property or one created for this purpose. The property must
also be of the True/False data type.
In the Datasheet Design window, remember to assign the picklist to the checkbox cell (see
Assign a PickList to a Cell) as the picklist will not automatically be available for that field
when mapped to a cell in a datasheet, even the picklist is assigned to that field in the Grid
Manager.

10.14.8 Auto Create Properties

To create multiple new properties with attributes derived from headings on the datasheet,
click New Properties then Auto Create Properties. The Auto Create Properties window
is then displayed:

© Copyright 2000 to current year. 10:58 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

Click on the datasheet headings from which the attributes of the new properties are to be
based. As each heading is clicked on, default details derived from the heading text are listed
in the window. For example:

The default object type is InstrumentData. If required, change this to Process Data by
selecting ProcessData from the list of values available in the Object Type fields.
The rest of the default details can either be edited as described below, or in the Property
Definition window accessed by clicking on the button in the Edit field. Refer to Add New
Property Definition for details.

Specify Details of New Properties

If required, change the object type as described above.
The default property names and captions are copies from the selected heading text. Edit
these as required by direct entry into the Property Name and Caption fields.
If a property is of the Process_Data object type, if the new property has units, check the Has
Units checkbox (not used for InstrumentData property types).

© Copyright 2000 to current year. 10:59 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

The default data type is Text. Specify a different data type in the Datatype field if required.
To auto-map a new properties to the datasheet cell to the right of the heading from which it
was derived, check the AutoMap checkbox. Check the AutoMap All checkbox to check all
the AutoMap checkboxes.
To remove a property from the window, select it and then click Delete.

Create the New Properties

Click the Create button. The new properties will then be created (and mapped to datasheet
cells for those properties where this option was selected).
For properties of the Process_Data type that had their HasUnits checkbox checked, a
property definition for the units of the new property is automatically created at the same
time.
The name of a units property definition will be the name of the new property suffixed with the
units suffix specified in the Please enter a new Units Suffix window accessed from the
Property Definitions window (see Preferences - the default suffix is “Units”). The data type
of units property definitions is text. Neither this nor the name may be changed.
A report listing details of the created properties will be displayed:

10.14.9 Import Catalogue From Other Project

Catalogue Datasheets (form definitions) may be imported from another AVEVA
Instrumentation project in a multi project environment.
With the Datasheet Form Catalogue Grid open, select From Other Project in the Import
section of the Manage tab to display the Select an AVEVA Instrumentation Project

© Copyright 2000 to current year. 10:60 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

window. Select the project from which the Catalogue Datasheets are to be imported are
defined.
After selecting the project, the Catalogue Import window is displayed, which lists catalogue
forms within the selected project:

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Select the Catalogue Datasheet(s) to be imported and click Import. A progress window is
displayed.
If a catalogue datasheet or template with the same name as one being imported already
exists in the project database, a warning message is displayed. The user may choose to
overwrite the existing datasheet or template.
A warning message is also displayed if a datasheet exists in the current database has been
based on a catalogue datasheet with the same name as one being imported. Such
catalogue datasheets will not be imported.
AVEVA Instrumentation will then copy the selected catalogue forms from the selected
project to the current project, including their DataLinks (Database field/cell mappings).

10.14.10 Delete a Catalogue Datasheet Definition

To delete a catalogue datasheet definition, select it from the Datasheet Form Catalogue Grid
and click Delete in the Records section of the Home tab. Only one definition can be deleted
at a time.

© Copyright 2000 to current year. 10:61 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Datasheets

If the definition has been used to define a datasheet it cannot be delete and the following
message is displayed:

If the definition has not been used to define a datasheet, the Delete 1 datasheet window is
displayed:

If the definition is to be deleted from the list in the Datasheet Form Catalogue grid, but its
Excel file is not to be deleted, click Delete from List Only.
If the Excel file of the definition is to be deleted, but the definition is not to be deleted from
the list, click Delete Datasheet File Only.
If the definition is to be delete from the list, and its Excel file is to be delete as well, click
Delete from List And Datasheet File.
After the required option has been selected, click Delete to proceed with the deletion. Click
Cancel to cancel the deletion.

© Copyright 2000 to current year. 10:62 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

11 Instrument Catalogue

Many instruments created for a project will have very similar attributes. For example, there
may be dozens of control valves with very little difference between them except for their tag
numbers.
To reduce the amount of repetitive data entry that specifying these items this would
otherwise entail, a catalogue of user-defined instrument definitions can be set up. When an
instrument is being created, selected data from a catalogue definition can be copied to the
new instrument. This definition can be copied to all the instruments with similar attributes,
e.g. similar control valves.
Refer to Manually Add a Tag to the Instrument List the procedure for copying data from a
catalogue instrument.
Continue at:
• Instrument Catalogue Grid
• Add a New Catalogue Instrument
• Edit a Catalogue Instrument
• Import Catalogue Instruments from another Project
• Import Instrument Catalogue Data from Excel

11.1 Instrument Catalogue Grid

Catalogue instruments are viewed in, and are created and edited from, the Instrument
Catalogue grid.
To open the Instrument Catalogue grid, click Select in the Grids and Schedules section of
the Home tab.
Select Instruments under the Catalogues heading from the list of grids that is then
displayed. The Instrument Catalogue grid is then displayed:

Refer to Working with the Data Grid for information on the grid controls including selecting
an instrument record, and sorting and filtering the grid data.

© Copyright 2000 to current year. 11:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

Edit Data in the Grid

To edit data the user can either double-click on an instrument record, or select it and click
the Edit command button. The user can also edit most column data directly in the Grid itself
by selecting the cell and entering a new value, select a value from a Pick list etc.
The list of values comprising each picklist generally consists of those values from Using
PickLists, and any value that has been entered in the field in question. In other words,
manually entering a value into the picklist field will add that value to the picklist for future
use.

Note: Any value manually added directly into a grid picklist is not added to the picklist's
value list until the Refresh toolbar command is used or the grid is re-loaded (e.g.
Instrument Engineer is re-started).

Columns with a yellow coloured background, i.e. Name and DataSheetNo cannot be edited
directly in the grid. Datasheet No column fields includes a button for use in assigning,
viewing and editing datasheets for catalogue instruments. Refer to View/Edit Instrument
Datasheets.

11.2 Add a New Catalogue Instrument

To manually add a catalogue instrument to the project, click New in the Records section of
the Home tab to display the Add New Catalogue Instrument window.

Enter a project unique name for the catalogue instrument in the Name field.
Complete the rest of the fields with the data that is to be available for copying to project
instruments creating using this catalogue instrument.

© Copyright 2000 to current year. 11:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

For guidance on completing these fields, refer to Manually Add a Tag to the Instrument List.

Note: A datasheet may be assigned to a catalogue instrument. When an instrument is

created using the catalogue instrument, the selected datasheet may also be
assigned to the new instrument. Refer to View/Edit Instrument Datasheets.

Click Save to create the new catalogue instrument. The new catalogue instrument will then
be added to the list of catalogue instruments in the grid.

11.3 Edit a Catalogue Instrument

To edit a catalogue instrument, highlight the record in the grid and click Edit in the Records
section of the Home tab to display the Edit window.

Note: Double-clicking the record in the grid view also displays the Edit window.

Amend the details as required. For guidance on changing the data in the fields, refer to
Manually Add a Tag to the Instrument List.
Click OK to save the changes.

11.4 Import Catalogue Instruments from another Project

Catalogue instruments may be imported from another AVEVA Instrumentation project in a
multi-project environment.
With the Instrument Catalogue open, click From Other Project in the Import section of the
Manage tab to display the Select an AVEVA Instrumentation Project window. Using this
window, select the project from which the catalogue instruments are to be imported.

© Copyright 2000 to current year. 11:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

After selecting the project, the Instrument Catalogue Import window is displayed,
containing a list of all catalogue instruments within that project:

Note: To minimise the possibility that data currently being worked on by another user may
be affected by an import, a list of the users working on the current project is available
from the UserCount link. The number of current users is displayed next to the link.
This total includes the user performing the import.

Click the Select checkbox for those catalogue instruments that are to be imported. Click
Select All if all are to be imported.
Click Next >.
All the selected catalogue instruments are then validated. If any of the catalogue
instruments are found to be invalid, they are listed in the next window, for example:

© Copyright 2000 to current year. 11:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

Catalogue instruments are invalid if:

• They have the same name as a catalogue instrument in the current project (i.e. the
project being imported into). Catalogue instrument names must be unique within a
project.
• They are assigned to a datasheet that already exists in the current project.
• They are assigned to a datasheet with a form definition which does not exist in the
current project.
• They are assigned to a datasheet with a form definition that does exist in the current
project, but which has different data mappings.
If all selected catalogue instruments are valid or all are invalid, the window will display a
message informing the user of this.
Click Import to proceed with the transfer of the valid catalogue instruments. The button will
be disabled if no valid catalogue instruments are found.
The import Progress window is displayed:

As each catalogue instrument is imported, it is added to the Instrument Catalogue grid.

© Copyright 2000 to current year. 11:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Catalogue

Once the import is complete, an import log listing the catalogue instruments that have been
successfully imported is displayed:

Click Close to exit the import wizard.

11.5 Import Instrument Catalogue Data from Excel

Instrument Engineer includes facilities to import instrument catalogue data into the AVEVA
Instrumentation project database from a Microsoft Excel Workbook.
For a description of this functionality, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 11:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

12 Exports

This section describes the export options available on the Manage and List Tools tabs.
Continue at:
• Export to Excel
• Export to XPS and PDF Files
• Export Selected Datasheet Files
• Export to AVEVA NET

12.1 Export to Excel

The export contents of all the grids and catalogues accessible from the Select option on the
Home tab can be exported to an Excel spreadsheet with same layout of columns and rows.
Data can also be exported to an Excel spreadsheet from a number of windows that display
data in a grid.
For a description of this functionality, refer to the Common Functionality User Guide.

12.2 Export to XPS and PDF Files

The export contents of all the grids and catalogues accessible from the Select option on the
Home tab can be exported to PDF and XPS files.
For a description of this functionality, refer to the Common Functionality User Guide.

12.3 Export Selected Datasheet Files

The datasheet files (.xls files) of datasheets selected in the Datasheet list grid can be
exported to:
• a folder specified at time of export with file names formed from the document number
and sheet number in the normal way, and
• a pre-defined folder or folders with file names in a pre-defined, user-defined format.
The folder(s) and the file name format are specified using facilities accessed from the
Setup menu of the Project tab, as described below.
Datasheet files can be exported with or without changes made since the last issue
highlighted.
The .xls files of the selected drawing must be present in the Datasheet folder of the project.

© Copyright 2000 to current year. 12:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

12.3.1 Export Datasheets to a Specified Folder

Select the drawings in the Datasheets grid.
On the List Tools - Datasheets tab, click Selected Datasheets in the Export section, then
Copy/Archive to a Folder from the menu that is then displayed
If changes made since the last issue are to be highlighted, click Copy/Archive to a Folder
with Previous Issue's Changes highlighted instead.
A standard Windows Browse For Folder window is then displayed:

Use the window to select the folder to which the datasheets are to exported and click OK.
The export of the selected datasheets then takes place. A message is displayed when the
export is completed, for example:

© Copyright 2000 to current year. 12:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

12.3.2 Export Datasheets to Pre-Defined Folders with File Names in a Pre-

Defined Format
Before datasheets can be exported using this option, the folder or folders to which they are
to be exported and the format of the datasheet file names must be defined.

Setting the Folder Name and File Name Folder

To specify the folder and sub-folders that drawings are to be exported into, and the files
names that they will be given, click Setup on the Project tab. On the Setup menu, click
Export File Name/Folders.
The File Export Settings window is then displayed:

In the Root Folder field, enter the root folder under which the sub-folders that contain the
exported files are to be located. Click the … button to browse for the required folder.
If no sub-folders are specified, as described below, all the files will be exported into this
folder.
To specify the sub-folder structure, select the drawing attributes that will define the names of
the sub-folders and from the Sub Folder list.
To select an attribute, check the appropriate checkbox. The selected attribute is then
displayed in curly brackets in the field below the list.
As required, enter delimiter characters or text between the selected attributes in this field.
To specify the file name format of exported drawings, follow the same procedure as for sub-
folders, but using the File Name list and field.
Example:

© Copyright 2000 to current year. 12:3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

In the example above, a sub-folder structure of {ProjectNo}-Area{AreaNo} and a file name

format of {DocNo}-{Sheet}-{Rev} have been selected. The selected root folder is “C:\AI
Datasheets”.
Using these settings, from a project called “Project1”, drawings are exported with the
following details:

Area Document Number Sheet Number Revision

00 ABC123 1 A

01 XYZ890 1 B

This will result in the creation of folder structure and files as follows:
C:\AI Datasheets (root folder)
Project1-Area00 (sub-folder)
[Link] (exported datasheet file)
Project1-Area01 (sub-folder)
[Link] (exported datasheet file)

Exporting Datasheets
Select the datasheets in the Datasheets Grid.
On the List Tools - Datasheets tab, click Selected Datasheets in the Export section, then
Copy to User Defined Names from the menu that is then displayed.
If changes made since the last issue are to be highlighted, click Copy to User Defined
Names with Previous Issue's Changes highlighted instead.
The export of the selected datasheets then takes place. A message is displayed when the
export is completed, for example:

© Copyright 2000 to current year. 12:4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

12.4 Export to AVEVA NET

AVEVA Instrumentation Engineer includes facilities to export files of item data and report
PDF files for import into AVEVA NET.
The following can be exported:
• Instruments data
• Loops data
• Datasheets data
• Process data
• Documents data
• Reports and associated item data (i.e. of the items on the reports)
The files produced by the exported can subsequently be imported into AVEVA NET Portal
(refer to AVEVA NET documentation for details).

12.4.1 AVEVA NET Export Configuration

Before files can be exported for AVEVA NET, the export must be configured.
From the Project tab, click Setup, then Publish to AVEVA NET Configuration. The
AVEVA NET Export Configuration window is then displayed.

© Copyright 2000 to current year. 12:5 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

Instrumentation data of various types and from different sources can be exported to AVEVA
NET, for example instrument data or data from reports. From the Name field, select the type
of data export to AVEVA NET to be configured.
If a log file is to be generated for the export type, check the Log Enabled checkbox.
The Log File field will then become enabled. In the field, specify the file name and the
location of the log file (a .txt file). Click the adjacent button to browse for the required folder.
In the Staging Area field, specify the top level folder into which files are to be exported.
Click the adjacent button to browse for the required folder.
If the Create Trigger File checkbox is checked, a [Link] file (an empty text file) is
created in the staging area folder for each file type. The purpose of the [Link] file is to
trigger the AVEVA NET Portal’s import controller to automatically process all the files that
reside in the same folder.
If, for every object being exported, a separate output file is to be generated, check the
Output File Per Object checkbox.
To select mapping files for the export of data and specify other settings, click Settings. The
Non-CAD Mapping Configuration window is then displayed.

© Copyright 2000 to current year. 12:6 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

The mappings between Instrumentation data and AVEVA NET Portal format data are stored
in XML files, one for each of the types of mapping:
• Object Mapping
• Class Mapping
For details of these files, refer to AVEVA NET Export Configuration Files.
Click the appropriate … button to browse for the required mapping file.

Click the open file button to open the selected file. It will open in the default text editor,
for example Notepad.
If no file is specified in the field, a new, blank .txt file is opened. If a file is specified that does
not exist, the user will be asked if they wish to create that file at the specified location. If Yes
is clicked, a new blank .txt file is created and opened for editing.
To populate the fields with the default mapping files supplied with AVEVA Instrumentation,
click Copy Sample Files.

12.4.2 Export Data from Grids

To export data from the Instrument List, Loop List, Datasheets List, Process Data grid,
Document List grid and Reports grid, select the items from the grid and from the Manage
tab, click Publish to AVEVA NET in the Integration section.
The Export To AVEVA NET window is then displayed, showing the progress of the import:

Once the export is completed, the Export Report window is displayed, listing the items for
which a data export was requested and whether or not that export was successful or not.

© Copyright 2000 to current year. 12:7 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Exports

12.4.3 Export Overview

AVEVA Schematic Gateway is a common Gateway that will be used by different AVEVA
schematic applications to export various kinds of data to AVEVA NET. This Gateway refers
to various configurations which are provided to it through various configuration files
(described in sections below).
As of now, AVEVA Schematic Gateway processes data (provided to it in a form of a Dataset)
as well some external files (Excel spreadsheets - xls and xlsx, PDF files).
• Data provided to the Gateway through dataset gets processed and output gets
generated into EIWM format.
• Gateway processes excel spreadsheets and produces output in MHTML format.
• Gateway processes PDF files and produces output in PDF format.

© Copyright 2000 to current year. 12:8 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Work Packs

13 Work Packs

Work packs can be created which consist of collections of items with shared project
management requirements or properties. For example, all the items an individual user or
group of users is concerned with may be assigned to a single work pack. Time constraints
may be assigned to work packs, for example the required start and completion dates of
items in the a work pack, so that work can be more easily prioritised.
For a description of this functionality, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 13:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Work Packs

© Copyright 2000 to current year. 13:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Change Reports

14 Change Reports

The following change reporting facilities are available in AVEVA Instrumentation:

• Audit Manager
• Database Revisions

14.1 Audit Manager

AVEVA Instrumentation has an in-built Audit Manager that enables users to view database
changes made during the project in the database audit log. The Audit Log contains a list of
new and old database field values for each AVEVA Instrumentation object and includes a
time stamp and user's name who initiated the change.
For a description of this functionality, refer to the Common Functionality User Guide.

14.2 Database Revisions

AVEVA Instrumentation allows users to make a copy of the current database state by saving
the database as a Database Revision. At any time, the current database can be compared
to a saved Database Revision. The feature can be used to track changes between key
milestones in the project, for example between data when documents were 'Issued for
Tender', 'Issued for Purchase' or 'Issued for Construction'.
For a description of this functionality, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. 14:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Change Reports

© Copyright 2000 to current year. 14:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Reports

15 Reports

AVEVA Instrumentation provides facilities for creating and modifying reports. These are
available with the Reports grid.
For a description of these features, refer to the Common Functionality User Guide.
In addition, the following Engineer-specific “fixed” (non-editable) reports are accessible from
the Reports grid:

I/O List Opens a grid view showing which tags are assigned to which I/O
modules/channels.

Instrument Count Opens a grid view showing the number of each instrument per
project status/description.

Tags Assigned to Opens a grid view listing the tags assigned to a loop.
Loop

DCS New Opens a grid view listing new tags assigned to the DCS /IO
system.

DCS New with Opens a grid view listing new tags with signal types assigned to
Signal Type the DCS I/O system.

DCS Remove Opens a grid view listing tags removed from the DCS I/O
system.

PLC/ESD New Opens a grid view listing new tags assigned to the PLC/ESD I/O
system.

PLC/ESD New with Opens a grid view listing new tags with signal types assigned to
Signal Type the PLC/ESD I/O system.

PLC/ESD Remove Opens a grid view listing tags removed from the PLC/ESD I/O
system.

Tags Assigned to Opens a grid view listing tags assigned to datasheets.

Datasheets

Tags Not Assigned Opens a grid view listing tags not assigned to a datasheet.
to Datasheets

Instrument Index Opens a grid view displaying the instrument index, including
with Process process connection details.
Connections

© Copyright 2000 to current year. 15:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Reports

© Copyright 2000 to current year. 15:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Sizing Calculations

A Instrument Sizing Calculations

The following instrument sizing calculations can be performed using AVEVA

Instrumentation:
• Control Valve Sizing
• Relief Valve Sizing
• Flow Element Sizing
• Thermowell Vibrations
• Gas Compressibility Factor

Important: AVEVA Instrumentation provides Instrument Sizing Calculations for Estimating

purposes only.
End Users should not rely on AVEVA Instrumentation calculation results for
Design purposes.
AVEVA recommends using certified equipment vendor calculations for final
specification/purchasing.

For a description of these calculations, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. A:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
Instrument Sizing Calculations

© Copyright 2000 to current year. A:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
AVEVA NET Export Configuration Files

B AVEVA NET Export Configuration Files

The following configuration files will be used by the AVEVA Schematic Gateway to process
the input:
• Project Configuration
• Object Mapping
• Class Mapping
For a description of these files, refer to the Common Functionality User Guide.

© Copyright 2000 to current year. B:1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide
AVEVA NET Export Configuration Files

© Copyright 2000 to current year. B:2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Index

B New Mapping Definition 3:30, 3:42, 5:61,

5:66
Browse Data By Form Type . . . . . . . . . 5:70
import data
Excel . . . . . . . . . . . . . . . . . . . . 5:75
E
Edit Instrument Numbers . . . . . . . 5:21, 8:11
C Edit Multiple Instrument Tag Formats . 5:26
Export
Change Reports . . . . . . . . . . . . . . . . . . 14:1 Data from Grids . . . . . . . . . . . . . . . 12:7
audit manager . . . . . . . . . . . . . . . . 14:1 datasheets to specified folder . . . . 12:2
Class Definitions . . . . . . . . . . . . . . . . . . 3:25 Files . . . . . . . . . . . . . . . . . . . . . . . . 12:8
Classes . . . . . . . . . . . . . . . . . . . . . . . . . 3:25 Selected Datasheet Files . . . . . . . . 12:1
Create to AVEVA NET . . . . . . . . . . . . . . . . 12:5
Wiring Re-running . . . . . . . . . . . . . . 9:1 to Excel . . . . . . . . . . . . . . . . . . . . . 12:1
to PDF . . . . . . . . . . . . . . . . . . . . . . 12:1
D to XPS . . . . . . . . . . . . . . . . . . . . . . 12:1

Data
Import . . . . . . . . . . . . . . . . . . . . . . 10:28 F
Data Grid Find and Replace
working with . . . . . . . . . . . . . . . . . . . 2:5 Text in a Grid . . . . . . . . . . . . . . . . . . 2:5
Datasheets . . . . . . . . . . . . . . . . . . . . . . 10:1
data entry . . . . . . . . . . . . . . . . . . . . 10:2
view and edit . . . . . . . . . . . . . . . . . 10:1
G
Datasheets Lists . . . . . . . . . . . . . . . . . 10:10 Grid Filters
access . . . . . . . . . . . . . . . . . . . . . 10:10 advanced . . . . . . . . . . . . . . . . . . . . . 2:5
add . . . . . . . . . . . . . . . . . . . . . . . . 10:13 Grid Manager . . . . . . . . . . . . . . . . . . . . . 2:5
assign tag . . . . . . . . . . . . . . . . . . . 10:18
datasheet form catalogue . . . . . . . 10:47
I
datasheet information . . . . . . . . . . 10:15
import datasheets from Excel . . . . 10:28 Instrument Catalogue . . . . . . . . . . . . . . 11:1
process data . . . . . . . . . . . . . . . . . . . 6:1 Add a New Catalogue . . . . . . . . . . 11:2
grid . . . . . . . . . . . . . . . . . . . . . . . 6:1 Edit a Catalogue . . . . . . . . . . . . . . 11:3
property definitions . . . . . . . . . . . . . . 3:7 Grid . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Defining Instrument Copy Wizard . . . . . . . . . . . . 5:51

© Copyright 2000 to current year. Index page 1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

Instrument Engineer Features . . . . . . . . 1:1 L

change management . . . . . . . . . . . . 1:3
datasheets (Specifications) . . . . . . . 1:2 Loop
Instrument List . . . . . . . . . . . . . . . . . 1:1 Copy Wizard . . . . . . . . . . . . . . . . . 8:20
loop list . . . . . . . . . . . . . . . . . . . . . . . 1:2 Copying . . . . . . . . . . . . . . . . . . . . . 8:19
reports . . . . . . . . . . . . . . . . . . . . . . . 1:3 Import from P&ID . . . . . . . . . . . . . . 8:25
user security rights . . . . . . . . . . . . . . 1:3 Loop List . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Instrument List . . . . . . . . . . . . . . . . . . . . 5:1 access . . . . . . . . . . . . . . . . . . . . . . . 8:1
access . . . . . . . . . . . . . . . . . . . . . . . 5:1 add a loop . . . . . . . . . . . . . . . . . . . . 8:3
add a tag . . . . . . . . . . . . . . . . . . . . . 5:4 assign tags . . . . . . . . . . . . . . . . . . . 8:17
add new tag . . . . . . . . . . . . . . . . . . . 5:2 AVEVA P&ID loop data import configuration
assign instrument tags to loops . . . 5:30 8:25
assign process items to instruments 5:32 AVEVA Schematic Model loop data import
attachments (external documents) . 5:55 configuration . . . . . . . . . . . 8:28
copy instruments . . . . . . . . . . . . . . 5:51 copy existing loops . . . . . . . . . . . . 8:19
create instrument wiring using wiring rules create loop wiring using wiring rules 9:14
9:2 delete loop . . . . . . . . . . . . . . . . . . . 8:24
deleting instruments . . . . . . . . . . . . 5:35 edit a loop . . . . . . . . . . . . . . . . . . . . 8:8
edit a tag . . . . . . . . . . . . . . . . . . . . . 5:10 edit multiple loops . . . . . . . . . . . . . 8:11
edit engineering data for multiple instru- import loops from AVEVA Schematic Model
ments . . . . . . . . . . . . . . . . . 5:29 8:28
edit multiple . . . . . . . . . . . . . . . . . . 5:21 wiring check reports . . . . . . . . . . . . 9:17
Edit Tag Details . . . . . . . . . . . . . . . 5:14 Loop Type Catalogue . . . . . . . . . . . . . . 3:44
alarms/settings . . . . . . . . . . . . . 5:19
datasheet . . . . . . . . . . . . . . . . . 5:17 P
DCS system . . . . . . . . . . . . . . . 5:18
details . . . . . . . . . . . . . . . . . . . . 5:16 Process Data
general . . . . . . . . . . . . . . . . . . . 5:15 Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
PLC/ESD system . . . . . . . . . . . 5:18 Edit Multiple Tags . . . . . . . . . . . . . . 6:4
user . . . . . . . . . . . . . . . . . . . . . 5:19 Process Units
grid picklists . . . . . . . . . . . . . . . . . . . 5:2 convert . . . . . . . . . . . . . . . . . . . . . . 10:7
import data . . . . . . . . . . . . . . . . . . . 5:36 Project tab
AVEVA Schematic Model tag data im- options . . . . . . . . . . . . . . . . . . . . . . . 3:1
port configuration . . . . 5:42 preferences . . . . . . . . . . . . . . . . . . . 3:1
AVEVA Tags data import configuration Project Voltages . . . . . . . . . . . . . . . . . . . 3:6
5:48 Property Definitions . . . . . . . . . . . . . . . . 3:8
AVEVADiagrams data import configura-
tion . . . . . . . . . . . . . . . 5:50 R
Excel . . . . . . . . . . . . . . . . . . . . 5:36
loop data from Excel . . . . . . . . 8:25 Reports . . . . . . . . . . . . . . . . . . . . . . . . . 15:1
tags from AVEVA P&ID . . . . . . 5:39
tags from AVEVA Schematic Model T
5:44
Tag
special grid features . . . . . . . . . . . . . 5:2
assigning to loop . . . . . . . . . . . . . . 8:17
viewing/editing datasheets . . . . . . . 5:34
Tag Formats . . . . . . . . . . . . . . . . . . . . . 3:17
Instrument Signal Type . . . . . . . . . 9:6, 9:17
edit . . . . . . . . . . . . . . . . . . . . . . . . . 3:20
Instrument Type Catalogue . . . . . . . . . . 3:34
new . . . . . . . . . . . . . . . . . . . . . . . . 3:17
Instruments Catalogue
Importing from Excel . . . . . . . . . . . 11:6
Importing from other Projects . . . . . 11:3 U
Issues
User Interface . . . . . . . . . . . . . . . . . . . . . 2:1
Issue Datasheets . . . . . . . . . . . . . 10:26
ribbon menus . . . . . . . . . . . . . . . . . . 2:2
Reissue Drawings . . . . . . . . . . . . 10:27
View Previous Issues . . . . . . . . . . 10:27

© Copyright 2000 to current year. Index page 2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

V
View datasheets by form type . . . . . . . . 5:70

W
Wiring Rules
Applying . . . . . . . . . . . . . . . . . . . . . . 9:1
overview . . . . . . . . . . . . . . . . . . . . . . 9:1
Running . . . . . . . . . . . . . . . . . . . . . . 9:1
Work Pack . . . . . . . . . . . . . . . . . . . . . . . 13:1

© Copyright 2000 to current year. Index page 3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Engineer User Guide

© Copyright 2000 to current year. Index page 4 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.