AVEVA Instrumentation

Common Functionality
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 Common Functionality User Guide

Revision Sheet

Date Version Comments / Remarks

17 Dec 2010 12.1 Initial issue.
March 2012 12.1 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
April 2017 12.1.SP6 Updates incorporated
February 2019 12.2 Updates incorporated
January 2020 12.2 Fix 2 Updates incorporated
June 2020 12.2.SP1 Updates incorporated
August 2020 12.2 SP2 Updates incorporated
February 2021 12.2.SP3 Updates incorporated
Instrumentation Common Functionality User Guide
 Instrumentation Common Functionality User Guide

Instrumentation Common Functionality

User Guide

Contents Page

Common Functionality
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

AVEVA Instrumentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

Benefits of using AVEVA Instrumentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Foreign Language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2

User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

Open an AVEVA Instrumentation Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Database Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Project Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7
Home Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9
Manage Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9
View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10
List Tools Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11
Quick Access Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:11
Cleartype Effects on Windows 7 and Windows 8.1 . . . . . . . . . . . . . . . . . . . . . 3:12

Data Grids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Open a Grid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Close a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

© Copyright 2000 to current year. i 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

Row, Column and Cell Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

Row (Record) Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Column (Field) Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3
Merge Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Split a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Group Data in a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:7
Group Grid Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:7
Group by Multiple Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Ungroup Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Grid Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:9
Apply Column Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:9
Apply Excel Style Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:10
Apply Advanced Grid Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:12
Remove Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:14
Edit Grid Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15
Pick Lists and Buttons in Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:15
Copy, Cut and Paste Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:16
Undo and Redo Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:17
Other Common Grid Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:18
Right-Click Context Sensitive Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:20
Find and Replace Text in a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:20
Find Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:21
Replace Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:22
Grid Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:22
Change to another View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:23
Create a New Grid View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:24
Edit and Delete Grid Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:29
AVEVA Integration Grid Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:29
Import AVEVA Integration Configuration Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:31
Grid Window Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:33
Print a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:34

Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Area Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2
Area-Based Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:5

Pick Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

Create, Edit and Delete Pick Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2

© Copyright 2000 to current year. ii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

Create New Pick List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3

Edit Pick List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3
Delete Pick List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
Merge Pick Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
View and Edit Pick List Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5
Edit Pick List Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6
Add Values to a Pick List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7
Delete Pick List Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7
Save Changes to Pick List Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7

Import and Export Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Import from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6
Export to XPS and PDF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
AVEVA Integration and the Compare/Update Facility . . . . . . . . . . . . . . . . . . . . 7:7
AVEVA Integration Import Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
Specify Compare/Update Row Colours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:16
Import, Compare and Update Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:16

Work Packs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Import from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:4

Change Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1

Audit Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1
Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2
Save Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:3
Compare Changes between Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:4

Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Fixed Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:3
Create a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:4
Create Revision Sub-Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11
Edit Report Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:12
Create and Edit Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:13
Report Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:17
View and Print Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:18
Report Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:24
Create a Revision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:25

© Copyright 2000 to current year. iii 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

Edit a Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:26

Viewing and Editing Multiple Document Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:26
Report Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:30
Highlight Reports for Reissue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:31
View Previous Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:31
Highlight Changes Since a Selected Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Export to and Import from Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Export Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Import from Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:35
Import Reports from Another Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:37
Edit Report Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:38

Claims . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Instrument Sizing Calculations . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1
Control Valve Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
Formulas Used For Liquids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2
Formulas Used For Gases (Compressible Fluids) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:4
Typical Values for FL and XT and Fd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:6
Why Molecular Weight and Compressibility are Missing . . . . . . . . . . . . . . . . . . . . . . . . . . . A:6
Relief Valve Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:7
Fundamental Equations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:7
Application to Relief Valves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:9
Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:12
Flow Element Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:13
Calculation Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:14
Pressure Loss . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:15
Other Remarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:15
Thermowell Vibrations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:16
Tapered Thermowells Natural Frequency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:16
Analysis of a Cylindrical (Parallel) Thermowell (or Sample Quill) . . . . . . . . . . . . . . . . . . . A:18
Order of Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:20
Gas Compressibility Factor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:21
Compressibility Factor by Redlich-Kwong Equation of State . . . . . . . . . . . . . . . . . . . . . . . A:21
Equation of State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:21
Redlich-Kwong EoS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:22
Expression of Z as a Function of Reduced Pressure and Reduced Temperature . . . . . . . A:23
Solving Equation 4.2.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:24

© Copyright 2000 to current year. iv 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

AVEVA NET Export Configuration Files . . . . . . . . . . . . . . . . . . . . . .B:1

Project Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:1
High level Structure of the Project Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:1
Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:2
Object Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:7
High Level Structure of the Objects Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:7
Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:7
Classes Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:8
High Level Structure of the Classes Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:8
Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:8
Presentation Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:8
High Level Structure of the Presentation Mapping File . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:9
Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:9

© Copyright 2000 to current year. v 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

© Copyright 2000 to current year. vi 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Introduction

1 Introduction

The AVEVA Instrumentation Common Functionality User Guide describes AVEVA

Instrumentation functionality that is common to the Designer, Engineer, Process Engineer
and Wiring Manager modules in the AVEVA Instrumentation suite. It also provides an
overview of AVEVA Instrumentation, its uses, features and advantages.
For details of module specific functionality, refer to the appropriate module documentation.

1.1 Guide Structure

Introduction Describes the purpose and content of this document.

AVEVA An overview of the features and advantages of AVEVA

Instrumentation Instrumentation.

User Interface Describes those aspects of the user interface common to

multiple AVEVA Instrumentation modules.

Data Grids Describes the common features of data grids in AVEVA

Instrumentation.

Areas Describes the procedure for adding plant areas to the project
database. All objects in AVEVA Instrumentation are assigned to
one of these areas.

Pick Lists Describes pick lists and how to edit them.

Import and Export Describes import and export procedures that are common to
Procedures multiple AVEVA Instrumentation modules.

Work Packs Describes the procedure for creating and editing work packs,
collections of items with shared project management
requirements or properties.

Change Reports Describes the Audit Manager, which enables users to view
database changes made to the project, and the Project
Revisions facility, used to track changes between key
milestones in the project.

Reports Describes how to create and modify reports in AVEVA

Instrumentation.

Claims Describes how to clear any multi-user locks placed on grid

records.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Introduction

Instrument Sizing An appendix the instrument sizing calculations that may be

Calculations utilised in AVEVA Instrumentation.

AVEVA NET Export An appendix describing the configuration files used by the
Configuration Files AVEVA Schematic Gateway to process data exported from
AVEVA Instrumentation.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA Instrumentation

2 AVEVA Instrumentation

AVEVA Instrumentation is used to manage Instrumentation design data and documentation.

The AVEVA Instrumentation suite of modules uses an advanced user interface based on the
Microsoft® Office Fluent™ user interface, integrated with a SQL Server relational database.
Much of the data can be created through automated functions, design rules, picklists and
use of catalogue data, reducing the need for manual data entry.
Reports in AutoCAD DWG, Excel spreadsheet, report and PDF formats can be generated
quickly, and automated production of design documentation ensures design integrity and
efficiency.

AVEVA Instrumentation can be used to:

• Manage instrument data.
• Produce instrument datasheets.
• Manage project cables, equipment terminal arrangements and wire terminations.
• Produce Cable Schedules / BOM, instrument and other reports.
• Produce detailed cable and wiring termination reports in PDF and AutoCAD format.
• Manage CAD drawings, allow bulk assignment of revisions, bulk printing etc.
• Automate production of loop diagrams, junction box and marshalling cabinet
termination diagrams in AutoCAD format (data from Instrument Index and datasheets
can be shared with drawings).

Modules of the AVEVA Instrumentation Suite are:

• Instrument Designer.
• Instrument Engineer.
• Instrument Wiring Manager.
• Instrument Process Engineer.
• Instrument Security Manager.

2.1 Benefits of using AVEVA Instrumentation

Projects will be completed on a shortened schedule, consuming fewer man-hours:
• More efficient data entry than conventional practice (e.g. stand-alone drawings,
documents, and databases/spreadsheets versus integrated database system). In many
cases the data is automatically created from “rules”.
• Documents can be auto-generated from the database (DWG, PDF and XLS), resulting
in major productivity gains.
• Easier to implement large (or small) scale design changes.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA Instrumentation

Projects using AVEVA Instrumentation are less error prone than conventional design
methods:
• Data is checked and validated by the database system.
• Data is electronically transferred, reducing errors and associated checking time.
• Use of a relational database means that data changed in one place is changed
throughout the database and reflected on all deliverables generated using that content.
• Construction and commissioning time is reduced due to improved design accuracy.

2.2 System Requirements

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

2.3 Foreign Language Support

All AVEVA Instrumentation application modules and project databases support foreign
language data entry using Unicode text including a mixture of languages (e.g. English and
Russian in the same dialog, datasheet, drawing and/or report).
Additionally, AVEVA Instrumentation supports translation of the data grid column headings
of the user interface into any foreign language. AVEVA Instrumentation has full translations
for English, Korean, Chinese (Simplified), Japanese, Russian, Spanish and French provided
with it.
If a company would like to update any translations or add a new foreign language AVEVA
can provide users with a software tool that will allow an engineer to update translations for
all dialog captions/labels by entering the appropriate text in a desired language. This
translator tool is available free of charge, however the translations will need to be returned
to AVEVA so they can be included in AVEVA Instrumentation after we regenerate the
associated language files.

Note: Changing the language only changes the header titles of data grid columns, it will not
change other labels etc. in the interface, any data that has already been input by
users, or templates (so none of the drawings, schedules or datasheets that use
those templates will change).

Note: Windows Region and Language settings support displaying decimal symbols as
commas. In AVEVA Instrumentation decimal symbols are currently displayed as
decimal points regardless of this setting.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

3 User Interface

The User Interfaces of the Designer, Engineer, Process Engineer and Wiring Manager
modules share a number of common features:
• The procedure for selecting and opening projects. See Open an AVEVA
Instrumentation Project for details.
• Most commands, facilities and utilities of these modules are accessed from a number
of tabs. Refer to Tabs for details.
• Options on these tabs can be added to the Quick Access Toolbar for convenient
access. The default location of this toolbar is above the tabs, but it can be moved below
them if required. Refer to Quick Access Toolbar for details.
• Project data in AVEVA Instrumentation is viewed and edited using a number of data
grids. For details of the common features of the data grids, see Data Grids.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

3.1 Open an AVEVA Instrumentation Project

When an AVEVA Instrumentation module is started, the user must first login to their AVEVA
Connect account, via which licensing is managed. The AVEVA Connect Sign In window is
displayed:

Enter the applicable AVEVA Connect Email address and password, and click Sign In.

Note: Once the user has logged in, they will not need to do so again for 24 hours.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Next, the Select an AVEVA Instrumentation Project window is displayed, from which the
required project can be selected:

The Select an AVEVA Instrumentation Project window can also be opened by selecting
the Open Project option from the Project Tab of all modules.
Double-click on the project to be opened, or click on it then click Select.
The login procedure then depends on the authentication type of the project (see the Security
Manager User Guide for details).
• If Windows Authentication (the default option) is the authentication method being used
for the project, the project is then opened.
• If SQL Server Authentication is the authentication method being used for the project,
the SQL User Login window is displayed:

Enter valid SQL server login details and click OK. The project is then opened.
• If AVEVA Project Authentication is the authentication method being used for the
project, the Project User Login window is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Enter valid project user login details and click OK. The project is then opened.
If the project database is at an earlier version than that of the product, it will need to be
upgraded before it is opened. See Database Upgrade.
If the project is being opened for the first time, the following message is displayed:

Click OK to continue. The project then opens.

To create further projects, select the New button on the Select an AVEVA Instrumentation
Project window. The Create a New AVEVA Instrumentation Project window is then
displayed. Refer to the Installation User Guide for details.

3.1.1 Database Upgrade

If the version of AVEVA Instrumentation is more recent than that of a project database, the
database must be updated to the same version as that of the application before the project
can be opened.
A message is displayed when such a project is opened. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Click Yes to continue.

The Login window is then displayed:

Enter the password for Security Manager and click Login. Refer to the Security Manager
User Guide for more details of Security Manager and passwords.
The Database Upgrade window is then displayed:

Select the product version to upgrade to from the list and click Upgrade.
A message is then displayed. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Click OK to proceed with the upgrade. The progress of the upgrade is displayed:

After the upgrade is finished, select the project from the Select an AVEVA Electrical
Project window to open it.

3.2 Tabs
On opening, the Designer, Engineer, Process Engineer and Wiring Manager modules each
display 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 applicable.
When a module is opened, the Home tab is initially displayed.

If required, the tabs, apart from their titles, can be hidden to save space.

To hide the tabs, right-click on them and select the Minimize the Ribbon option from the
menu that is then displayed, double-click on any tab, or click the button the right-hand end of
the ribbon (next to the Help button).
Repeat the above procedure to “un-hide” the tabs.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

3.2.1 Project Tab

Open Project Displays the Select an AVEVA Instrumentation Project

window, used to select and open another AVEVA
Instrumentation project. The current project is closed. See
Open an AVEVA Instrumentation Project for details.

Edit Project Displays the Project Data window enabling editing/viewing of

some project information and folders/file locations. Refer to
the Installation User Guide for details.

Work Packs Accesses the Work Packs sub-menu, used to activate and
deactivate Work Pack mode for a selected Work Pack, create
new Work Packs and add and remove drawings to and from
them. See Work Packs for details.

Print Used to print the current grid. Displays a Print Preview

window which displays a screen capture of current grid, and
including various printing options. See Print a Grid for details.

Setup Provides access to the Setup sub-menu. See below.

Languages This option enables the user to select a different language

from a menu. Selecting a different language requires AVEVA
Instrumentation to restart the application. AVEVA
Instrumentation applications always start in the last selected
language. Refer to Foreign Language Support in the
Installation User Guide for more information.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Colour Schemes AVEVA Instrumentation supports multiple colour schemes

(skins).
Selecting a different colour scheme from this menu
immediately changes grid and tab skins. AVEVA
Instrumentation applications always start in the last selected
colour scheme. Each AVEVA Instrumentation module uses
independent skins so each can have its own colour scheme.

Options Displays the Options window which enables editing/viewing

of user preferences for the module. Refer to module
documentation for details.

Exit Used to close the module.

Setup Sub-Menu
The following options are common to each module.

Add/Edit Plant Areas Used to create and edit plant areas for the project. Refer to
Areas for details.

Add/Edit Plant Area Used to create and edit plant areas for the project. Refer to
Types Areas for details.

Edit Pick Lists Displays the Pick List (All) window enabling users to add
and edit PickLists, including the adding of new items to
PickLists. Refer to Pick Lists for further information.

Publish to AVEVA NET Displays the AVEVA NET Export Configuration window.
Configuration Refer to module documentation for details.

Refer to module documentation for details of other options on this menu.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

3.2.2 Home Tab

Lists Section

Select Used to select and open a data grid. See Open a Grid for
details.

Manage Used to select, create and edit grid views. See Grid Manager
for details.

Clipboard Section
These options in this section are used to cut, copy and paste from and to a data grid. See
Copy, Cut and Paste Commands for details.

Records Section
These options are used to refresh data in a grid, and to create edit and delete records. For
details see Other Common Grid Commands.
The options in this section are also located on the List Tools tabs.

Grid Actions Section

These options are used to perform various actions relating to grid data. For details see
Other Common Grid Commands.

Find & Replace Section

Used to find and replace values in a grid. See Find and Replace Text in a Grid for details.

3.2.3 Manage Tab

Changes Section
These options provide access to the Audit Manager, which enables users to view database
changes made to the project, and the Project Revisions facility, used to track changes
between key milestones in the project. See Change Reports for details.

Multi User Section

The Claims option is used to clear any multi-user locks placed on grid records.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Local Integration Section

The options in this section provide access to facilities for integrating module data with other
AVEVA products. For details refer to the appropriate module documentation.

Service Integration Section

The options in this section provide access to facilities for integrating module data with data
from other AVEVA products and Excel via a service, including compare and update facilities.
See AVEVA Integration and the Compare/Update Facility.

Import Section
The options in this section provide access to facilities for importing data into AVEVA
Electrical from Excel and other AVEVA Electrical projects.
For details of the common procedure for importing from Excel, see Import from Excel.
For details of other Excel import procedures and imports from other projects, refer to the
appropriate module documentation.

Export Section
The options in this section provide access to facilities for exporting data from AVEVA
Instrumentation to Excel, XPS and PDF files.
For details of the procedure for exporting from Excel, see Export to Excel.
For details of the procedure for exporting to XPS and PDF files, see Export to XPS and PDF
Files.

3.2.4 View Tab

Window Section
The options in this section are used to change the arrangement of grid tabs. Refer to Grid
Window Options for details.

Grid Options Section

The options in this section are used to switch on and off grid facilities such as row and
column pinning, data grouping and column filtering.
For details, see Row, Column and Cell Display Options, Group Data in a Grid and Grid
Filters.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

3.2.5 List Tools Tab

The List Tools tab contains options specific to the grid which is currently being viewed. If no
grid is open, the tab will not be displayed.
It also includes the options from the Records section of the Home tab (see Other Common
Grid Commands for details).
The name of the tab will be the name of the current grid.
For details of the options on this tab, refer to the appropriate module documentation.

3.3 Quick Access Toolbar

Options on the tabs can be added to the Quick Access Toolbar for quick and convenient
access.
By default, the toolbar includes the Undo and Redo buttons (see Undo and Redo Changes
for details).

To add a tab option to the toolbar, right-click on it and select the Add to Quick Access
Toolbar option from the menu that is then displayed.

The option is then added to the toolbar.

By default, the toolbar is located above the tabs. If required it can be moved below the tabs
by selecting the Show Quick Access Toolbar Below the Ribbon option from the right-click
menu shown above, or the Show Below the Ribbon option from the Customize Quick
Access Toolbar menu displayed by clicking the arrow at the end of the toolbar.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Once the toolbar is below the ribbon, the menu options become Show Quick Access
Toolbar Above the Ribbon and Show Above the Ribbon, and are used to move the
toolbar back to its original position.
The Customize Quick Access Toolbar menu also includes options for removing and
returning the Undo and Redo buttons from and to the toolbar.

3.4 Cleartype Effects on Windows 7 and Windows 8.1

AVEVA Electrical is optimised to use Cleartype effects for fonts in Windows 7 and Windows
8.1. This feature improves text appearance on most Windows windows. It is suggested that
Cleartype effects are selected to enable clearer viewing of text in AVEVA Instrumentation
(and other applications on the desktop).
Open the Control Panel.
If Control Panel options are being displayed in the “Category” configuration, select
Appearance and Personalization and then Display.
If Control Panel options are being displayed in the “Small Icons” or “Large Icons”
configuration, select Display.
Select Adjust Clear Type Text from the list of options on the right-hand side of the window.
The ClearType Text Tuner window is then displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

Check the Turn on ClearType checkbox. Click Next and step through the tuning wizard.
Finally, click Finish to implement the changes.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
User Interface

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4 Data Grids

Project data in AVEVA Instrumentation is viewed and edited using a number of data grids,
one for each category of data.
This section describes data grid functionality common to multiple AVEVA Instrumentation
modules.

4.1 Open a Grid

To open a data grid, click Select in the Lists and Schedules section of the Home Tab.
The list of the grids in the current module is then displayed. For example:

The list may be divided into categories of grid, e.g. Lists and Catalogues, as in the example
above.
Click on a grid name to open it.
Each grid is displayed in its own tab. To switch from one open grid to another, click on the
appropriate tab title. Options for changing the arrangement of grid tabs are available. Refer
to Grid Window Options for details.
When a list is opened, an additional “List Tools” tab, named after that grid and containing
commands specific to that grid, is displayed (if there are any).

Record Loading Options

By default, if a list contains more than 1000 records, only the first 1000 of those records are
loaded and displayed in the grid. As the user scrolls down the grid, once the initial 1000
records have been scrolled past, the next 1000 batch of records is displayed and so on until
all the list records are displayed. The default number of records initially loaded can be

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

changed to any value from 100 to 100000 by changing the Grid Lazy Loading setting in the
Options windows of the Engineering modules. A user may also choose to load all the
records in a grid at once by selecting the Load All option on the Home Tab.

Grid Information
The grid view in use and the number of records currently displayed in the grid is shown at
the bottom left of the AVEVA Instrumentation window:

If the list that the grid displays contains more records than are initially displayed (i.e. 1000),
then this will be indicated as follows:

Refer to Grid Manager for details of grid views.

4.1.1 Close a Grid

To close a data grid, either right-click on the grid name on its tab and click Close, or click
the X button in the top-right corner of its tab.

4.2 Row, Column and Cell Display Options

A number of options are available to change how the rows, columns and cells of data grids
are displayed. Continue at:
• Row (Record) Display Options
• Column (Field) Display Options
• Merge Cells
• Split a Grid

4.2.1 Row (Record) Display Options

Select a Single Row

To select a single row in a grid, click immediately to the left of the first column of the row. An
arrow is displayed indicating the selected row, and the row is highlighted in a different
colour.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Select Multiple Rows

To select multiple rows, use one of the following methods:
• Hold down the control key (Ctrl) and select the individual rows by clicking immediately
to the left of the first column. Holding down the Ctrl key while selecting a row adds the
row to the selected rows. To deselect a row, click on it again.
• Hold down the shift key (Shift) and select a row by clicking immediately to the left of the
first column. Then select another row. Both the selected rows, and all the rows listed
between the two rows are then selected.
• Press Ctrl-A on the keyboard or select Select All Rows on the Home Tab. All rows in
the current grid are then selected, excluding any rows filtered out.

Pin Rows
When a row is pinned it remains at the top of the grid even when the grid is scrolled down,
so that it is always in view.
Pin icons are displayed to the left of the first column of a grid if the facility for pinning rows is
turned on for it. If not, to activate the facility for pinning rows for the current grid, check the
Pinned Rows checkbox in the Grid Options section of the View Tab.
To pin a row, click on its pin icon.

When a row is pinned, its pin icon changes orientation, so that its point is downwards.
To unpin a row, click its pin icon again.

4.2.2 Column (Field) Display Options

Note: For grids not provided with the grid management facility (see Grid Manager), if
columns are resized or re-ordered, these changes are saved between sessions.

Resize
To resize a column, click and hold on the line between columns and drag the line left or right
to make it wider or narrower. Double-clicking on the line will resize the column to fit the
longest string of characters within that column.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Change Column Order

To change the order that columns are displayed in from left to right, click and hold a column
header and drag it to a new position. Two arrows are displayed to assist the user in
positioning the column.

Sort a Grid
The user can sort the Data Grid on any combination of fields by clicking on a column (field)
name. To sort by multiple fields hold the <Shift> key while making selections. The grid will
be sorted in the order that the columns are selected.

Pin Columns
When a column is pinned, it automatically becomes the first (left-hand most) column of the
grid, and remains displayed at the left-hand side of the grid even when the grid is scrolled to
the right, so that it is always in view.
Pin icons are displayed in headings of a grid if the facility for pinning columns is turned on
for it. If not, to activate the facility for pinning columns for the current grid, check the Pinned
Column checkbox in the Grid Options section of the View Tab.
To pin a column, click on its pin icon.

When a column is pinned, its pin icon changes orientation, so that its point is downwards.
To unpin a column, click its pin icon again.

Column Summaries
The average, count (i.e. number of values), minimum, maximum and total values of a
column containing numbers only can be calculated and displayed beneath the column.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Sum icons are displayed in the headings of a grid if the summarise columns facility is turned
on for it.

If not, to activate the facility for the current grid, check the Column summaries checkbox in
the Grid Options section of the View Tab.
To specify which summaries are to be displayed, click on the icon. The Select Summaries
window is then displayed:

Check the checkboxes for the summaries which are to displayed, then click OK.
The selected summaries are then displayed beneath the column. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.2.3 Merge Cells

Adjacent cells within a column that contain identical values can be merged so that they are
displayed as a single cell. For example:

To turn on this facility for a grid, check the Merged cells checkbox in the Grid Options
section of the View Tab.

4.2.4 Split a Grid

A grid can be split into left and right sections. When this is done, the two sections scroll
separately, i.e. if the columns in one section are scrolled, the columns in the other sections
remain as they are.
To split the grid into sections, select the vertical line to the left of the left horizontal scroll
arrow and drag it to the right to divide the grid in two.

Drag the line back to its original position to remove the split.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.3 Group Data in a Grid

The format of the display of items can be changed so that records with attribute values in
common are grouped together. Items can be grouped by single and multiple attributes.
Continue at:
• Group Grid Data
• Group by Multiple Attributes
• Ungroup Data

4.3.1 Group Grid Data

The format of the display of items can be changed so that records with attribute values in
common are grouped together. For example, records can be grouped according to their
Area or Loop Number.
A grouping panel is displayed above the column headings the grouping facility is turned on.

If not, to activate the facility, check the Grouping panel checkbox in the Grid Options
section of the View Tab.
To group data, drag and drop the column heading of the attribute in question into the
grouping panel.

The grid then changes to display the name of each group in the following format:
<Attribute Name>: <Attribute Value> <(Number of records in the group)>.
The name of the column that records are grouped by is displayed in the grouping panel.

To view the items within a group, click on the "+" button next to the group name. The items
are then listed under the name. Press the "-" button to close the list.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Note: The fields within a group can be fixed, sorted, moved and filtered in the normal way.

4.3.2 Group by Multiple Attributes

Records can be grouped by more than one attribute. For example, by Area and then by
Loop Number. To group by a second attribute, for example Loop Number, drag and drop the
heading of this attribute into the grouping panel.
If the heading of the second attribute (e.g. Loop Number) is dropped to the right of the first
attribute (Area), items will be grouped first by (Area), then by (Loop Number).
For example, each group of item records with the same Area will be sub-divided into groups
of items with the same Loop Number.

If the second heading is dropped to the left of the first heading, records will be grouped the
other way round.

4.3.3 Ungroup Data

To ungroup data, drag and drop the column heading or heading from the grouping panel
back to the column bar.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.4 Grid Filters

Filters can be applied to grids so that they show only certain records. For example, only
items of a particular type. Various types of filtering can be applied. Continue at:
• Apply Column Filters
• Apply Excel Style Filters
• Apply Advanced Grid Filters
• Remove Filtering
Note: Filters are applied to all records in a grid, not just those records currently loaded and
displayed in a grid, i.e. a filter to display a subset of records will return all the records
that meet the filter criteria whether they are currently displayed or not.

4.4.1 Apply Column Filters

Column filters are applied using the facilities provided in the filtering row, which is displayed
beneath the column headings of a grid. If this row is not displayed for a grid, turn it on by
checking the Column filtering checkbox in the Grid Options section of the View Tab.

To apply a basic column filter, select a filter criterion, for example, ‘Starts with’, ‘Contains’ or
‘Does not end with’ from the drop-down list displayed by clicking the left-hand button in the
filtering row of the column.

If a value is selected without a criterion being selected, the ‘Starts with’ criterion is applied by
default.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Then either enter a value in the field to the right of the criterion selection button, or click on
the button to the right of this field and select a value from the list that is then displayed.

The list contains every value in the column, plus ‘Custom’, ‘Blanks’ and ‘NonBlanks’. If
‘Custom’ is selected the window used to construct advanced grid filters is displayed. Refer
to Apply Advanced Grid Filters for details.
If ‘Blanks’ is selected rows without a value in the column are displayed when the filter is
applied. If ‘NonBlanks’ is selected rows with a value in the column are displayed.
The selected value is displayed in the field between the two buttons.
The filter is then applied to the grid.

4.4.2 Apply Excel Style Filters

Excel style filters can also be applied. To activate this facility, check the Excel style filtering
checkbox in the Grid Options section of the View Tab. The Column filtering checkbox
must be checked before the Excel style filtering checkbox is checked.
To apply an Excel style filter to a column, hover the cursor over the filter row field for that
column and click on the button that is then displayed at the end of the field.
The following window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

The window lists all the values in the column, plus ‘All’ and ‘Blanks’.
Next to each item in the list there is a checkbox. To filter out a value from the column,
uncheck its checkbox. To uncheck all values, uncheck the ‘All’ checkbox. Check the ‘All’
checkbox again to check all the checkboxes again.
If the ‘Blanks’ checkbox is checked, rows without a value in the column are displayed when
the filter is applied.
When the required filter conditions have been selected, click OK to close the window and
apply the filter.
The filter is then applied. The value that the column is being filtered by is displayed in the
filtering row field for the column. If the column is being filtered by multiple values or by a text
filter (see below), ‘Custom’ is displayed.
To edit an Excel style filter, access the Excel style window filter again and change the filter
criteria as required. To clear the filter, click Clear Filter. See also Remove Filtering.

Text Filters
More advanced filters can be applied by clicking Text Filters. A list of text filtering criteria is
then display, plus ‘Custom Filter’.

Click on the required criterion. The advanced filtering window is then displayed with the
selected criterion selected in the Criteria field and the current column selected in the Field
field.
If the ‘Custom Filter’ option is selected, the advanced filtering window is displayed without
the Criteria field being completed.
See Apply Advanced Grid Filters for details of advanced filtering.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.4.3 Apply Advanced Grid Filters

To add or change an advanced filter to the current grid view, in the Grid Actions section of
the Home Tab click Filter. The Filter window is then displayed:

Add a New Criteria

Select the field by entering or selecting a value from the Field list.
Select a filter criteria from the Criteria list.
Enter a value in the Value option, or select from Value list.

Add Additional Criteria

Select + Filter from the toolbar.
Another row of filter lists (Field, Criteria and Value) is then displayed. Between the first and
second rows the operator ‘AND’ is displayed in blue text (meaning that only records that
satisfy both of the criteria will be included after filtering has been applied). Click on this to
change it to ‘OR’ (meaning that records that satisfy either of the criteria will be included after
filtering has been applied).
Enter the details additional criteria as required. Any number of additional criteria may be
defined.
The toolbar can be used to change the order of filter criteria and to add brackets around
them. See below for more information on the toolbar, and on filter criteria.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Apply the Filter

To apply the Filter, click Apply.

Note: Some filter criteria such as 'Begins With' use a wild card match to filter values. Do not
supply any wild card characters such as '*' or '%' as AVEVA Instrumentation handles
this for the user.

More Information about Filter Criteria

Filter Criteria Description Example Comments

Value

Exact Match Field = Value 1234 Shows all records where Field = 1234

Begins With - Field like XX* XX Shows all records where Field begins
Partial Match with two characters XX

Ends With - Field like *XX XX Shows all records where Field ends with
Partial Match two characters XX

Contains - Field like XX Shows all records where Field contains

Partial Match *XX* two characters XX

In List Field = A or B A, B, C Shows all records where Field exact

or C matches any values in list

Greater Than Field ≥ Value 1234 Shows all records where Field ≥ 1234
Or Equal To

Less Than Field < Value 1234 Shows all records where Field < 1234

Less Than Or Field ≤ Value 1234 Shows all records where Field ≤ 1234
Equal To

Greater Than Field > Value 1234 Shows all records where Field > 1234

Not Exact Not Field = 1234 Shows all records where Field does not
Match = 1234

Not Begins With Field like T T Shows all records not beginning with T
Partial_Match

Not Ends With Field like T T Shows all records not ending with T
Partial_Match

Not Contains Field like T T Shows all records not containing T

Partial_Match

Is Empty Is Field = Shows all records where Field is empty

(nothing)

Not Empty Not Field = Shows all records where Field is not
(nothing) empty (no characters)

Not Null Not Field = Shows all records where Field is not Null
Null

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Note: A database NULL means nothing has ever been entered in this field, whereas Empty
means that current value is empty (no characters).

Command Buttons

Apply Exits the Filter window and applies the filter to the current grid.

Cancel Exits the Filter window without changing any filters in the current grid.

Toolbar Commands

+ Filter Adds a new Filter row to the Filter definition

- Filter Removes the selected Filter row from the filter definition

Change Join Toggles the selected logical join between AND and OR

+( Adds a left bracket to the filter expression

-( Removes a left bracket from the filter expression

+) Adds a right bracket to the filter expression

-) Removes a right bracket from the filter expression

-() Removes all brackets

Test Filter Tests the Filter

Ç Up Moves a Filter row up

È Down Moves a Filter row down

2 Clear Filters Clears all filters in the current grid

4.4.4 Remove Filtering

To remove a column filter, including an Excel style column filter, click the clear filter button
for the column:

To remove all filtering from the current grid, in the Grid Actions section of the Home Tab
click Clear Filters.
To remove only column filtering from a grid, either click the clear filters button at the start of
the filtering row, or select the Clear Column Filters option from the Right-Click Context
Sensitive Menu.
To remove only advanced filtering from the grid, select the Clear Temporary Filters option
from the Right-Click Context Sensitive Menu.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.5 Edit Grid Data

Data in columns with pale blue backgrounds (see the Status cells in the example below)
can be edited directly in a grid by selecting the appropriate cell and entering a new value or
by selecting a different value from a list of values.
If a value is changed in a grid, its cell is highlighted with a bright blue background (see the
first Loc cell in the example below).

Columns with a pale yellow coloured background cannot be edited directly in the grid (see
the Loop Service cells in the example above), and can only be edited, if they are editable at
all, using the appropriate Edit window for the type of record.
For further details of the facilities for editing grid data, refer to:
• Pick Lists and Buttons in Cells
• Copy, Cut and Paste Commands
• Undo and Redo Changes

4.5.1 Pick Lists and Buttons in Cells

Many cells in grids can be completed by selecting a value from a list of values.
In some cases, cells can only be completed with a value in a list. In others, users may enter
other values as well. depending on how the list of values was configured (for details of how
lists of values are created and edited, refer to Pick Lists).
If a cell can be populated from a list of values, a button will be displayed if the mouse cursor
is hovered over it. For example:

Click on the button to display the list of values. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

To complete the cell with a value, select it from the list.

Some cells may be completed by selecting a value from a different window. Additional
details relating to values already in such cells may also be viewed in these windows, and a
different value selected.
Such windows may be accessed by hovering the mouse over the cell in question, and
clicking the button that is then displayed. For example:

4.5.2 Copy, Cut and Paste Commands

To copy the content of a cell in a grid, select the cell and click Copy in the Clipboard section
of the Home Tab, or right-click and select Copy Text from the Right-Click Context Sensitive
Menu, or press Ctrl+C.
To cut the content of a cell in a grid, select the cell and click Cut in the Clipboard section of
the Home Tab, or press Ctrl+X.
To paste into a cell in a grid, select the cell and click Paste in the Clipboard section of the
Home Tab, or press Ctrl+V. Data can only be pasted into cells that can be directly edited, i.e.
typed into.
If copied or cut values are pasted into another application, the column heading is also
pasted.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.5.3 Undo and Redo Changes

Changes to data in a grid can be undone and redone using buttons located in the Quick
Access Toolbar.

Undo Undoes the last row edit. Any subsequent undo will undo each row's
edits on a row by row basis.

Note: Deletions of records and changes to records performed using

editing windows cannot be undone using this command.

Redo Reverses the last undo (see above) made to data in the grid.

The last change made can be also be undone by selecting that cell it was made in and
pressing Ctrl+Z. Pressing Ctrl+Z again will redo the change.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.6 Other Common Grid Commands

The following commands are located in the Records and Grid Actions sections of the
Home Tab and are available for most grids. Commands which are specific to particular grids
are located in the List Tools tabs. Refer to the appropriate module documentation for
details.
Most of these options are also available from the Right-Click Context Sensitive Menu.

Records Section:

New Displays a window used to create a new item.

Edit Displays a window used to edit an existing item selected from the grid.

Note: In most grids, the user can double-click on an item to open an editing window.

Delete Enables deletion of selected item(s) from the grid. A confirmation

message window is displayed to confirm deletion. In some grids, users
will also be asked whether any associated data or files should also be
deleted.

Refresh Updates the entire grid with the latest database information (useful in
multi-user project environments).

Note: These options are also available on the List Tools tabs.

Grid Actions Section:

Select All Rows Used to select every row in a grid. Refer to Row (Record)
Display Options.

Vertical View Displays selected rows in a vertical format (columns) for 'side
by side' editing. See below for an example.
Click on this option again to change the grid back to the default
display format.

Auto Size Columns Automatically sizes each column in the grid view to fit the
longest string of characters.

Filter Used to apply a filter to the data in a grid. Refer to Grid Filters.

Clear Filters Used to remove filtering from the data in a grid. Refer to Grid
Filters.

Quick Report Displays the grid in the Report Viewer window. Refer to View
and Print Reports for details of this window and its facilities.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Example of records in “Vertical View” mode:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.7 Right-Click Context Sensitive Menu

Context-sensitive menus are displayed when a user right-clicks on a grid record. The menu
provides access to many of the grid commands. For example:

Commands common to most or all grids are described in this document. Grid-specific
commands are described in the appropriate module documentation.

4.8 Find and Replace Text in a Grid

Any text string within a grid can be found, highlighted and optionally replaced.
Continue at:
• Find Text
• Replace Text

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.8.1 Find Text

To find text within a grid, enter the string to be searched for in the field in the Find &
Replace section of the Home Tab and either click Next or the button with the magnifying
glass symbol next to that field. The first row that contains a match is then highlighted and
the cell that contains the match is selected.
Click Next or the magnifying glass button again to find the next match. Click Previous to
select previous matches for the current search.
If no matches are found, a message is displayed to inform the user of this.
The drop-down list in the field lists all the strings searched for in the current sessions.
Alternatively, click Find in the Find & Replace section of the Home Tab. The Find and
Replace window is then displayed:

Enter the string that is to be searched for in the Find What field. If the string has already
been searched for during this session, it can be selected from the drop down list accessible
from this field.
Click Options >> if a more refined search is required. Additional fields are then displayed in
the window:

From the Within drop down list, select which columns are to be searched. By default, all
columns are searched, but a single grid column can be selected if required.
From the Search drop down list, select the direction in which the search will take place: All
(i.e. up and down, the default setting), Up, or Down.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

From the Match drop down list, select the matching criteria for the search: Partial Match -
Contains (default), Partial Match - Begins With, Partial Match - Ends With, or Complete
Match
Check Match Case if only text in the grid that matches the case of the text entered in the
Find What field is to be found. The checkbox is unchecked by default.
To proceed with the search, click Find Next.
The first row that contains a match is then highlighted and the cell that contains the match is
selected.
Click Find Next again to find the next match.
If no matches are found, a message is displayed to inform the user of this.
Click Close to exit the window.

4.8.2 Replace Text

To find and replace text either click Replace in the Find & Replace section of the Home
Tab, or if the Find and Replace window is already open, click on the Replace tab.
The Replace tab of the Find and Replace window is then displayed:

Specify the search options as described above.

In addition, enter the text that is to replace the found text in the Replace With field.
To proceed with the search and replace, click Find Next.
The first row that contains a match is then highlighted and the cell that contains the match is
selected.
If this text is to be replaced, click Replace.
Whether or not a replace is implemented, click Find Next to find the next match.
If no matches are found, a message is displayed to inform the user of this.
Click Close to exit the window.

4.9 Grid Manager

The Grid Manager enables users to define their own sets of data fields (columns), default
column orders, default sorting and predefined data filters for most AVEVA Instrumentation

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

data grids available in AVEVA Instrumentation modules. These sets of fields are called
'Views' and typically contain a subset of all available fields. These include the project-
specific properties that may be setup in the Engineer and Process Engineer modules.
The name of the current View is displayed on the left-hand side of the bar at the bottom of
the AVEVA Instrumentation window.

Note: If the user is working in a project and the Security option has been activated in
Security Manager, the user may not have permissions to perform all grid
management tasks. Contact the System Administrator for further information.

Note: Some grids are not provided with the grid management facility. However for these
grids, if columns are resized or re-ordered, these changes are saved between
sessions (see Column (Field) Display Options).

The feature enables each user to restrict the grid to display only those fields that are
required for their current task. Users can easily change between Views by selecting from the
list of Views created in the project. New Views can be created by any user and can be set to
Public, which allows any other AVEVA Instrumentation user, to use the view, or set to
Private, which restricts access to only the user that created the View.
Each grid is provided with a default View called ‘AVEVADefault’ which cannot be edited or
deleted. It may however be copied and the copy then edited.
Some grids are also provided with an ‘Integration’ View which is used to specify the fields
available for attribute mapping when configuring AVEVA Integration Imports. These can be
edited, but not deleted.
Continue at:
• Change to another View
• Create a New Grid View
• Edit and Delete Grid Views
• AVEVA Integration Grid Views
• Import AVEVA Integration Configuration Mappings

4.9.1 Change to another View

Click Manage in the Lists and Schedules section of the Home Tab to display the Grid
Views window. The Grid Views window lists of all the previously defined Views for the
current data grid that are 'Public' or were created by the current user:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

To change to a View, click on View Name and then click Apply, or double-click on the View
Name.
Once selected, the data grid will refresh with the View fields, sort order, data filters, etc.

4.9.2 Create a New Grid View

Users can add a new View by either creating an entirely new View, or by copying and editing
an existing View.
• To copy a View, select the existing View record and click Copy Selected from the pull-
down menu next to New.
• To create a new View, click New to display the List Manager window with the View tab
displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

The Grid Name is the name of the current data grid and is non-editable (this View is based
on the Instrument List data grid).
Enter a View Name and optional Description.
Views can be marked Public, which allows any other users to use this View, or set to
Private, which restricts access to the user that created the View. If a View is to be Public,
tick the Public checkbox.

Field Definition
All views must contain at least one database field (column). To define the View fields, click
the Fields tab to display a list of fields available for the current data grid:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

To select/de-select fields, click each fields checkbox in the Select column. The user can add
as many fields as required.
The user can rename the titles in the Caption column fields by clicking in the field and
changing the text. The new title will be used in the Grid View.
If required, select a pick-list from the PickList field. The associated list of values will then be
available from the field in question. Refer to Pick Lists for details of how pick-lists are
created and edited. If a field has “Not Applicable” in its PickList field then that field in a grid
is completed from a source other than a pick-list.

Note: If a locked pick-list is assigned to a field, only values from that list may be entered in
that field. This includes imported values. If an attempt is made to import a value into
such a field that is not in the assigned pick-list, the import of that value will fail.

Note: If a pick-list is assigned to a field, and that field is displayed in a window, the pick list
will not be available for that field in the window. However, if the pick-list is locked the
field will be read-only in the window.

When all the fields have been selected, click Save to save the fields for the new View.

Layout
All the fields selected in a View can be located in any order or sequence within the data grid
and have their default widths pre-set.
To define the Layout, click Layout to display the selected fields.

Note: The user must select fields prior to defining the Layout.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

To change the order of the fields, click on the field Caption and drag the column to the
desired location.

Note: Two arrows are displayed to assist the user in positioning the field.

To change the default column width, click on the vertical dividing line and drag the dividing
line to the required width.

Note: Double-clicking on the dividing line will size the column to fit the largest string of text
within that column.

To save the new Layout, click Save.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Sorting
Use the Sorting tab to define the fields by which the View will be sorted.
The View Fields list displays all fields for the View. Check the Show Used Only checkbox if
only those fields selected for the View (in the Fields tab) are to be displayed.
To select a field to sort the View by, double-click on it in the View Fields list. It is then moved
to the Sort By list. Repeat for as many fields as required.
The order of fields in the Sort By list will be the sort order of the View. In the example below,
data in the View will be sorted first by Area, and then by Tag Number.

To remove a field from the Sort By list, double-click on it. It is then returned to the View
Fields list.

Filtering
Use the Filtering tab to apply filtering to a View.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

The Filtering tab is used in the same way as the Filter window. Refer to Apply Advanced
Grid Filters for details.

4.9.3 Edit and Delete Grid Views

Note: The default View for a grid ‘AVEVADefault’, cannot be edited or deleted.
Integration Views can be edited, but not deleted.

Edit Views
Users can edit Views (except where noted above) by selecting the View in the Grid View
window and clicking Edit.
The List Manager window is then displayed, showing the details of the View. Use the
window to edit these details as described in Create a New Grid View.

Delete Views
To delete a view, select the view in the Grid View window and click Delete. A message will
then be displayed requesting that the deletion be confirmed. Click Yes to continue.

4.9.4 AVEVA Integration Grid Views

Some grids are provided with an ‘Integration’ grid View which is used to specify the fields
available for attribute mapping when configuring AVEVA Integration Imports (refer to AVEVA
Integration Import Configuration for details).
The list of destination (AVEVA Instrumentation) attributes available for mapping is restricted
to those fields specified in the Integration grid View associated with the AVEVA
Instrumentation list that the data will be imported into. This is so that users are not required
to scroll through potentially very long lists to find the required attributes.
Integration grid views can be edited, but not deleted.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

To edit an integration view, select it from the Grid View window and click Edit. The List
Manager window will then be displayed.
For Integration Views, only the View and Fields tabs are available:

In the View tab, edit the Description if required.

In the Fields tab, edit the fields for the View to define the list of AVEVA Instrumentation
attributes available for mapping during AVEVA Integration setup.

Refer to Create a New Grid View for how to define the View fields, and the other facilities of
the window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

For Integration Views, the List Manager window also includes facilities for importing
attribute mappings setup in other projects. Refer to Import AVEVA Integration Configuration
Mappings for details.

4.9.5 Import AVEVA Integration Configuration Mappings

For Integration Views (see AVEVA Integration Grid Views), the List Manager window also
includes facilities for importing attribute mappings previously setup in other projects.
Click the Import Mappings button on the List Manager window. The Import Mappings
window is then displayed:

Select the data source type (AVEVA Engineering, AVEVA Everything 3D, AVEVA Diagram
or AVEVA P&D) from the Select Source field.
By default, AVEVA P&D is selected, as shown above. Enter the server name, specify the
server login details, and select the source AVEVA P&ID project database.
If any of the other sources is selected, the window will change to look like this:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

Click the ... button next to the Browse XML field, and browse for the XML file in which the
required settings are stored.
The default locations and file names are:
• For AVEVA Engineering 14.1:
Project Location/Defaults folder/CUConfigs1.0/ EngineeringAISetting.xml
• For AVEVA Engineering 14.1.1 and 14.2:
Project Location/Defaults folder/CUConfigs2.0/ EngineeringAISetting.xml
• For AVEVA Diagrams:
Project Location/Defaults folder/CUConfigs2.0/ SchematicAISetting.xml
• For AVEVA E3D 2.1:
Project Location/Defaults folder/CUConfigs2.0/ DesignAISetting.xml
When the required data has been entered for the selected source, select the Import button.
The import will then take place. At the end of the process, a message will be displayed to
inform the user of its success or failure. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.10 Grid Window Options

The following options for arranging data grid tabs are available in the Windows section of
the View Tab:

New Horizontal Tab To view more than one grid tab at a time, with the two tabs
displayed side-by-side, open the two grids and click this option.
Instead of the two grids being displayed as tabs, with one
“behind” the other, the grid view is then split vertically, with each
grid being displayed in one half of the grid view. The grid
currently selected is displayed in the right-hand half of the grid
view.
If three or more grids are open when the option is selected, these
additional grids are displayed as tabs in the left-hand side of the
grid view.
If an additional grid is opened once the option has been selected,
this grid is displayed as a tab in the same half of the grid view as
the currently selected grid.

New Vertical Tab This option works in the same way as the New Horizontal Tab
option except that grids are displayed one on top of the other, i.e.
the grid view is split horizontally.

Tabbed View This option will arrange all currently open document windows
such as loops and datasheets into a single tabbed window. The
user can click on a tab to display the content of that window.
If grids are to be displayed in tabs, check this checkbox (this is
the default setting).
If each grid is to be displayed in a separate window, uncheck this
checkbox.

Move to Previous If the grid view has been split into two parts using either the New
Tab Horizontal Tab or New Vertical Tab option, use this option to
move the current grid from the left-hand or top grid half to the
right-hand or bottom grid half.
If all grids are moved from a grid view half, the grid view half is
closed and the grid view reverts to the default tabbed view.

Move to Next Tab If the grid view has been split into two parts using either the New
Horizontal Tab or New Vertical Tab option, use this option to
move the current grid from the right-hand or bottom grid half to
the left-hand or top grid view half.

Note: Grids can also be moved from one grid view half to another by clicking on the grid
title and dragging and dropping it into the other grid view half.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

4.11 Print a Grid

To print the currently displayed grid:
• From the Right-Click Context Sensitive Menu select the Print Grid View option, or
from the Grid Actions section of the Home Tab, select the Quick Report option. The
grid is then displayed in the Report Viewer window (see View and Print Reports), from
where it can be printed.
• From the Right-Click Context Sensitive Menu select the Print Grid option, or from the
Project Tab, select the Print option.
The Print Preview window is then displayed.

The window displays a preview of the grid. Click the Print toolbar button to print it, or select
the Print option from the File menu. The File menu also includes a Page Setup option,
which accesses the standard Windows Page Setup window.
Thumbnail images of each page are displayed in the left-hand pane of the window. The
section of the page currently being viewed in the main viewing pane is blanked out in the
thumbnail (see the example above).
To close and open the thumbnail pane, select the Thumbnails option from the View menu.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

The following toolbar buttons are available:

Hand Tool Used to drag the page view in any direction. Click on the page
with this tool activated, drag the page until the required view is
visible, then release the mouse button.
Also available on the Tools menu.

Snapshot Tool Used to take screen captures of a page, or part of a page.

Captures are copied to the clipboard.
To take a capture of an entire page, click on the page with this
tool activated. To take a capture of a part of a page, click on one
corner of the area to be captured, then drag the cursor to the
opposite corner of the area and release the mouse button.
Also available on the Tools menu.

Dynamic Zoom When this tool is active, the page will be zoomed into when the
Tool cursor is dragged up the page or the mouse wheel rolled up, and
zoomed out when it the cursor is dragged down or the mouse
wheel rolled down.
Also available on the Tools menu.

Zoom In Tool When this tool is active, left-clicking the mouse on a page will
zoom into that page to the next standard zoom level.
Also available on the Tools menu.

Zoom Out Tool When this tool is active, left-clicking the mouse on a page will
zoom out from that page to the next standard zoom level.
Also available on the Tools menu.

Page Width Sets the view to same width as the current page.
Also available on the View menu.

Margin Width Sets the view to the width of the margins of the grid image on the
current page.
Also available on the View menu.

Whole Page Sets the view to display the entire current page.
Also available on the View menu.

Zoom In Zooms into the page to the next standard zoom level.
Also available on the View menu.

Zoom Used to change the zoom level the value selected from the list
accessed from this field, or typed into this field.
Also available on the View menu.

Zoom Out Zooms out from the page to the next standard zoom level.
Also available on the View menu.

Continuous Removes the gaps between the different pages of the preview in
the main view. Click this button again to replace the gaps.

Page Layout Opens a drop-down list from where various page layout options
can be selected.

Close Preview Closes the Print Preview window.

Also available from the File menu (Exit option).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Data Grids

First Page Displays the first page of the preview.

Also available on the View menu.

Previous Page Displays the previous page of the preview.

Also available on the View menu.

Next Page Displays the next page of the preview

Also available on the View menu.

Last Page Displays the last page of the preview

Also available on the View menu.

Previous View Changes the display the previous view.

Also available on the View menu.

Next View Changes the display the next view.

Also available on the View menu.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

5 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.

Note: An Area can be a sub-area of another area.

Note: Access control restrictions to Plant Areas may be setup in the Security Manager
module, which may restrict the access of users to certain Plant Areas. Refer to Area-
Based Access Control for further details.

Select Setup > Add/Edit Plant Areas from the Project Tab to display the Areas window. If
Areas already exist in the project, these will be displayed in the Areas window grid view.

To add a new Plant Area, click New to display the Area Information window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

Enter a number for the new Area in the Area No field.

Areas with the same number cannot be created within the same parent area, nor can “root”
areas (i.e. Areas with no parent areas) have identical numbers. If duplicate numbers are
detected, an error message will be displayed to inform the user of this when OK or Apply is
clicked.
The Area Type is selected from the drop-down list. The user can create a new Area Type by
clicking the arrow next to the Area Type field. Refer to Area Types for further information.
The Parent Area field allows the new Area Type to be placed within an existing Area Type
by selecting from the drop-down list. The Parent Area field will not become active if a
criterion associated with the Area Type is set to Must be Root. Refer to Area Types for
further information.
Complete the Description and Short Description if required.

Note: The short description can be used in AVEVA Instrumentation documents such as
datasheets and loop lists if the full Area description is too long to be used in those
documents.

Click Save to create the new Area and return to the Areas window. The new Area will be
displayed in the Areas window grid view.
Click Cancel to return to the Areas window without creating a new Area.
To delete an Area, select it from the grid list and click Delete. A message will be displayed
asking the user to confirm the deletion.

Click Yes to confirm the deletion and return to the Areas window. The deleted Area will be
deleted and removed from the grid view.
Click No to cancel the deletion and return to the Areas window.
Clicking Close on the Areas window closes the window and returns the user back to their
original view.
In a grid view, the available Plant Areas can be viewed by clicking on any cell in the Area (or
AreaNo) column, and clicking the button that is displayed to the right of the column. A drop-
down list of the Plant Areas is displayed.

5.1 Area Types

Each Area in a project is of an Area Type which defines whether or not an Area can be a
parent area for sub-areas, and whether it can be (or must be) a root area.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

To add or edit an Area Type, select Setup > Add/Edit Plant Area Types from the Project
Tab to display the Area Types window.

The Area Types window displays a grid list all the currently available Area Types and the
criteria associated with each Area Type.
To add an Area Type, select New to display the Area Type window.
The Area Type window can also be displayed by clicking the arrow to the right of the Area
Type field on the Area Information window. Refer to Areas for more information.

The user must add a Name to the Area Type. From the Path Delimiter list, select the
character (if one is required) to be displayed in area paths of areas of this area type.
Select which criteria to associate to the Area Type by checking one or more of the four
checkboxes.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

Note: If the checkbox Must be Root is selected, the checkbox Can be Root is
automatically checked by the system and becomes inactive.

Can Contain Areas Allows the Area to contain Sub-Areas.

Can be Root Allows the Area to be a Root (top level) Area or a Sub-Area
of another Area. If the Area is allocated a Parent Area it
cannot be selected as a Parent Area and vice versa.

Must be Root Specifies that the area must be a Root (top level) area and
cannot be a Sub Area.

Can Contain Equipment Allows the Area to contain equipment.

Click Save to create the new Area Type.

Click OK to return to the Area Types window. The new Area Type will be displayed in the
Area Types window.
Clicking Cancel on the Area Type window returns the user back to Area Types window
without creating a new Area Type.
To edit an existing Area Type, select from the grid list and click Edit. The Area Type window
will be displayed with the current Name and criteria fields populated.

The user can make the required changes and click Save.
Click OK to return to the Area Types window. The edited Area Type will be displayed in the
Area Types window.
Clicking Cancel on the Area Type window returns the user back to Area Types window
without editing the Area Type.
To delete an Area Type, select from the grid list and click Delete. If the Area Type was used
to create one or more Areas, it cannot be deleted. A message will be displayed to inform the
user of this. Otherwise, a message will be displayed asking the user to confirm the deletion.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

Click Yes to confirm the deletion and return to the Area Types window. The Area Type will
be deleted and removed from the grid view.
Click No to cancel the deletion and return to the Area Types window.
Clicking Close on the Area Types window closes the window.

5.2 Area-Based Access Control

Access control restrictions to Plant Areas may be setup in the Security Manager module. If
this is the case, the Areas to which users have access to, and the level of their access is
based on the group that they are in.
For example, users in group A may have full read and write access to objects in Area 1, but
only read-only access to objects in Area 2, and no access at all to objects in Area 3 (objects
in this area will not even be visible to the user in data grids for example).
The levels of access to areas are as follows:

Full Access allows a user to add, edit and delete data in the area

Read-Only allows a user to view the details of objects in the area,

but not edit or delete it, and to create reports that include
the object data

Read-Only (Allow allows a user to view object data, create reports and
Connections) make connections to objects in the area (e.g. users may
assign a supply in the area to a load in a full access
area)

No Access stops a user from viewing the objects in the area,

including disabling of editing and reporting

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Areas

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

6 Pick Lists

Many grid cells, datasheet cells and window fields can be, or must be, completed by
selecting from lists of values.
For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

These “Pick Lists” can be edited by the user if required. Users can define new pick lists, add,
edit and delete values in existing pick lists, and delete pick lists.
Select Setup > Edit Pick Lists from the Project tab to display the Pick List window.

The Pick List (All) window initially displays the name of every pick lists in the PickList
Name column. The data type of each pick lists is displayed in the Data Type column. Pick
lists are listed in alphabetical order.

6.1 Create, Edit and Delete Pick Lists

AVEVA Instrumentation provides facilities to create new pick lists and to edit, merge and
delete existing pick lists. Continue at:
• Create New Pick List
• Edit Pick List
• Delete Pick List
• Merge Pick Lists
The values of existing pick lists can also be edited. Refer to View and Edit Pick List Values
for details.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

6.1.1 Create New Pick List

To create a new pick lists, click New. The PickList Details window is then displayed:

Enter a unique name for the new pick list in the PickList Name field.
From the DataType list, select the data type for the new pick list:

The default type is “Text”. All values added to the pick list must be of the selected data type.
If a grid cell etc. with which the list is allocated to must be completed using one of the pick
list values, check the Locked checkbox. Otherwise leave it unchecked, meaning that other
values may be entered in addition to those in the list of values.

Note: If a pick list is assigned to a field in the Grid Manager (see Grid Manager), and that
field is displayed in a window, the pick list will not be available for that field in the
window. If the pick list is locked it will be a read-only field in the window, if it is not
locked, it will not be read-only.

Click Save to exit the window and save the new pick list.
Click Cancel to exit the window without saving the new pick list.

6.1.2 Edit Pick List

To edit the properties of a pick list, select the pick list from the list and click Edit. The
PickList Details window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

The name of an existing pick list cannot be changed.

If required, change the data type and locked status.

Note: The data type cannot be changed if the pick list has any values assigned to it. These
values must be deleted first.

Click Save to exit the window and save the changes.

Click Cancel to exit the window without saving the changes.

6.1.3 Delete Pick List

User-defined pick lists can be deleted.
To delete a pick list, select it from the list and click Delete. A message requesting that the
deletion be confirmed is then displayed. Click Yes to complete the deletion. A message is
displayed to confirm that this has taken place.
Pick lists supplied with the product cannot be deleted. A message is displayed to inform the
user of this if they attempt to delete such a pick list.

6.1.4 Merge Pick Lists

Multiple pick lists may be merged into a new pick list.
To merge pick lists, select the pick lists to be merged from the list of pick lists and click
Merge PickList.
All selected lists must have the same data type. If they are not, a warning message is
displayed.
At least two pick lists must be selected. A maximum of five pick lists can be merged at once.
If less than two or more than five pick lists are selected, an error message is displayed.
If two to five pick lists are selected, the Merge Picklist window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

Enter the name of the new pick list in the Merged Picklist Name field. The name must be
not have been used for any other pick list.
Enter a caption for the new pick list in the Merged Picklist Caption field.
The pick lists that form the new, merged pick lists may optionally, if user-created, be deleted
as part of the process. If this is required, check the Delete existing Picklists checkbox.
Pick lists supplied with the product cannot be deleted. If a supplied pick list has been
selected for merging, if the checkbox is checked a message will be displayed informing the
user of this and the checkbox will revert to being unchecked.
The pick lists selected for merging are listed in the lower part of the window. Select which of
the selected lists are to be merged into the new list by clicking on them, or click the All
option if all selected pick lists are to be merged.
Click Save to exit the window and save the new merged pick list, which is then added to the
list of pick lists and populated with the values from the selected lists.
Click Cancel to exit the window without saving the pick list.

6.2 View and Edit Pick List Values

To set the window to only display the values in a pick list, hover the cursor over the PickList
Name field of the list, and click on that button that is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

The values in the list are then displayed. The name of the selected pick list is displayed in
the window title bar.

Continue at:
• Edit Pick List Values
• Add Values to a Pick List
• Delete Pick List Values
• Save Changes to Pick List Values

6.2.1 Edit Pick List Values

Click in the cell that contains the value and type in the new value. The entered value must
be of the correct data type for the list.
The description may also be edited (or added) if required.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

6.2.2 Add Values to a Pick List

To add an item to a pick list, select the required pick list from the drop-down list and then
click Add Item. A blank field is added to the bottom of the list of pick list values. Enter the
new value in this field. The entered value must be of the correct data type for the list.
If required, enter a description in the adjacent Description field.

6.2.3 Delete Pick List Values

Select the value or values to be deleted and click Remove Item.
A message is displayed requesting that the deletion be confirmed. Click Yes to confirm the
deletion.

Note: If a deleted value has already been assigned to a grid cell, datasheet cell or window
field it will not be deleted from that cell or field. In the case of grid cells and window
fields, the deleted value will continue to be available for selection for items of that
type (for example, an instrument or a drawing) while any item of that type still has the
deleted value assigned to it.

6.2.4 Save Changes to Pick List Values

To save changes made to a pick list, click Save. The window then reverts to displaying the
list of pick lists.
To display the list of pick lists again without saving, click Back.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Pick Lists

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

7 Import and Export Procedures

A number of import and export facilities are common to the AVEVA Instrumentation
engineering modules. See:
• Import from Excel
• Export to Excel
• Export to XPS and PDF Files
• AVEVA Integration and the Compare/Update Facility

7.1 Import from Excel

The following can be imported from an Excel spreadsheet using this procedure.
In Designer:
• Drawings
• Hookup Drawings
• Hookup Item Catalogue Data
In Engineer:
• Instruments
• Loops
• Process Data
• Instrument Catalogue
In Process Engineer:
• Process Data
• Process Equipment
• Process Lines
In Wiring Manager:
• Cable Gland Catalogue Data
• Cable Gland Adaptor Catalogue Data
Note that other data can be imported from Excel spreadsheets, but the procedures in these
cases are different from that described in this topic. Refer to the appropriate module
documentation for details.

Note: A grid cannot be imported into by more than one user a time. The grid will be locked
to other users during the import process. However, if an import process is interrupted
unexpectedly, e.g. by a server problem, a power cut etc, the grid may remain locked.
A facility is therefore provided in Security Manager to unlock grids locked by Excel
import processes. Refer to the Security Manager documentation for details.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The Excel Spreadsheet

The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading.
Furthermore, the Excel file must contain an identity column, e.g. the drawing number
column for imports to the Drawing list. Advanced users can also map against a foreign key
field, a field in each record that can be a primary key field of each record in the excel file. If
mapping using this identity column, the identity column is ignored and records in the
database are searched and updated based on the foreign key field.
Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.
While processing records to be imported, if a record already exists in the database AVEVA
Instrumentation will show the differences between the imported data and the AVEVA
Instrumentation data, allowing the user to accept/reject the proposed changes on a record
by record (and field by field) basis. If the record does not exist in AVEVA Instrumentation
and the user accepts the importation of the record, AVEVA Instrumentation will create a new
record for that drawing or catalogue item.

The Import Procedure

Open the appropriate grid. For example, if importing instrument data in Engineer, open the
Instrument List grid.
On the Manage Tab, click From Excel in the Import section.
The Select excel workbook to import window is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The 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 as required.
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

Selecting the New button in the previous window displays Mapping Name and Description
fields and changes the New button to Save.

Once the details for the mapping have been entered, click Save. The mappings will be
saved and Saved Mappings drop down will have the newly added mapping name
appended to it.

Note: It is not compulsory to save the mappings to import data, data can also be imported
by just clicking on the Import button at any time. However it is useful to save the
mappings if an import with those mappings is to be performed multiple times.

Importing the Data

To proceed with the import of Excel data, click Import.
The Import Options window is then displayed. This is used to specify whether records are
to be imported one by one (Process each Tag and Show Differences one by one) or in a
batch (Batch Process all Tags and Show Differences at end).
If the batch option is selected all records are processed together and a differences report is
displayed when this process is complete, enabling users to accept or reject each change. If
the one by one option is selected, a differences report for each record is displayed before
the next record is processed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

If import mapping are being tested, the Process each Tag and Show Differences one by
one option is recommended.
Once the required option has been selected, AVEVA Instrumentation will go ahead and
process the data. The Import Differences window is displayed either once for all
differences or multiple times for each record, as explained above.

The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported Excel) data.
To accept the changes either, select individual field data by clicking Accept checkbox for
each.
Alternatively, select the Accept All checkbox at the top of this window. All Accept
checkboxes will then be checked (individual records may then be unchecked if required).
To save the checked (accepted) data, click Save.
If the Batch Process all Tags and Show Differences at end option was selected, the
process is then complete.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

If the Process each Tag and Show Differences one by one option was selected, AVEVA
Instrumentation will then proceed to the next tag record to be imported and display the
differences in the Import Differences window.
To cancel any import for the current tag record, click Close. AVEVA Instrumentation will then
proceed to the next record to be Imported.

Note: To cancel all further importing, click Stop Import.

Once the import procedure is complete, an Import Log window will be displayed, in which
details of the import are displayed (records successfully imported, errors, warning etc.).

7.2 Export to Excel

The contents of all the grids 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 example the Import Log window.

Note: All records in a grid are exported, not just those records currently loaded and
displayed in a grid.

To export the contents of a grid to an Excel spreadsheet, open the appropriate grid. On the
Manage Tab, click Export to Excel in the Export section.
The Save file as window is then displayed.

Select the location to which the Excel file is to be saved, enter the file name, and click Save.
The export then takes place.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The contents of a grid (except the Seed List in Designer) may be exported to a spreadsheet
with an extra column which is automatically populated with a unique identifying number for
each row of data.
To produce a spreadsheet in this format, proceed as described above, but select the Export
to Excel (With Id) option, accessible by clicking the arrow next to the Export to Excel
option.
To export to a spreadsheet from a grid in a window, click the Export to Excel button and
specify the file name and location as described above.

7.3 Export to XPS and PDF Files

The contents of grids can be exported to XPS and PDF files.
To export the contents of a grid to XPS or PDF files, open the appropriate grid. On the
Manage Tab, click Export to XPS or Export to PDF as appropriate in the Export section
(the Export to XPS option is accessed by clicking the arrow next to the Export to PDF
option).
A Save file as window is then displayed. Select the location to which the file is to be saved,
enter the file name, and click Save. The export then takes place.

7.4 AVEVA Integration and the Compare/Update Facility

The Compare/Update facility can compare and update data provided by a service from
another AVEVA product, or an Excel spreadsheet.

Note: This service must also be installed and setup. See AVEVA Integration Service User
Guide for details.

If required, differences in data in these other sources can be used to update data in the
current project.
The facility interfaces with the following AVEVA products:
• AVEVA P&ID 12.1.SP2 Fix 2 and above (12.1.SP2 Fix 5 and above is needed to import
loop data)
• AVEVA Engineering 14.1 and above
• AVEVA Diagrams 14.1 and above
• Everything 3D (E3D) Design 2.1 and above
Before using the facility compare/update configurations must be set-up, e.g. attribute
mappings between the AVEVA Instrumentation project and the data source, data filters etc.
These are created and edited as described below.
Continue at:
• AVEVA Integration Import Configuration
• Specify Compare/Update Row Colours
• Import, Compare and Update Data

7.4.1 AVEVA Integration Import Configuration

At least one configuration must be setup and be available for selection before the Compare/
Update facility is used.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

To create and edit configurations, click Setup > AVEVA Integration Services > Import
Configuration from the Project Tab.
• If a service has been configured, the following message is then displayed (for
example):

Click Yes to connect to the configured service. The Service Import Configuration
Settings window is then displayed.
• If the service has not been setup, the Configure Integration Service Location
window is displayed, which is used to edit (if required), test and save the service setup:

Once this has been done, click Exit.

The Service Import Configuration Settings window is then displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

Note: To edit the configured service, click the Service button to open the Configure
Integration Service Location window (see above).

Select the data source from the Select Source list. The list consists of the data source
types that have been configured as services.

Login to Source
Once the source is selected, the user must then login to it. Select the Login button. The
appropriate project selection and login dialog is then displayed for the source.
For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

Select the project for which the configuration will be created, edited or deleted. Enter a
password if required. Click the Connect button.

Choose Mode of Operation

Once the login is complete, the options in the main part of the window become available.

Continue at:
• Create Configurations
• Edit Configurations
• Delete Configurations
• Copy Existing Configuration
• Rename Existing Configuration

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

Note: Once the login is complete, the Login button is replaced by a Logout button. Use
this to disconnect from a project without exiting the window.

Create Configurations
To create a new configuration, select the Create new configuration option, and click Next
>.
The following configuration settings are then displayed:

The source data is the data that will be the basis of comparison.
Enter the name of the configuration in the Configuration Name field and select the element
type that the configuration is concerned with from the Element Type list.
Enter or select a group name in the Group field. Similar configurations can be collected into
groups if required.
The user can create different configurations for different types of elements such as
Equipment, Pipes etc.
Select the appropriate object type of the source elements from the Object Type Mapping
list.

Note: Instead of a specific object type, Database Views may be selected when setting up
mappings to Dabacon source databases. Using a DBView will enable access to any
referenced object in the Dabacon database.

From the Name Attribute list, select the attribute of the selected element type which is to
serve as the name attribute of items in the source.
From the Unique Attribute list, select the attribute which is to serve as the unique key
attribute of source items.
Click Next >. The following configuration settings are then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The target data is the data in the selected AVEVA Instrumentation database. Target data is
compared against source data.
From the Object Type list select the type of object in the target database.
Select the name and unique attributes that will automatically get populated in the respective
fields.
If the Compare/Update procedure finds unmatched objects, it can create corresponding new
objects in the target database. Check Allow Insertion if this is to be enabled.
Click Next >. The following configuration settings are then displayed:

Add filters to limit the population of source data that will be used in the comparison.
Click Add Filter to add a filter condition and specify its details in the row that is then
displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

To add a further filter condition, select either the AND or OR “join” as required, then click
Add Filter again and enter the second condition.
Continue until all required conditions have been entered.

Note:

• For filter conditions IN and NOT IN user will have to provide each string value in
“double quotes”.
• If there are multiple values, then values should be comma separated (for example for
the IN condition, multiple values can entered as follows “AAA”,”BBB”,”CCC”, and in
case of a single value as follows “AAA”).
• In the case of integer values, users do not need to enter double quotes.
• For all other conditions, the user will provide only a single value. Double quotes are not
required for string values and integer values.
To delete a condition, select it and click Delete Filter. To delete all conditions. check the
Delete all filters checkbox and then click Delete Filter.
Click Next >. The following configuration settings are then displayed:

Click on Add Mapping to add an empty attribute mapping row to the list, then select the
source and target attributes in the dropdown lists.

Note: The list of destination (AVEVA Instrumentation) attributes available for mapping is
restricted to those fields specified in the Integration Grid View associated with the
AVEVA Instrumentation list that the data will be imported into. This is so that users
are not required to scroll through potentially very long lists to find the required
attributes. Refer to AVEVA Integration Grid Views for details.

If the data source is an AVEVA Engineering project, additional attribute mapping options
relating to units are available.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

• Remove unit
If this checkbox is checked for an attribute, then the unit of that attribute will be
removed and only the value will appear.
For example, the units of a line size attribute may be removed (100mm to 100).
• Replace unit
To remove a part of an attribute value, enter the part which is to be removed f in the
Replace unit field and select the Remove unit checkbox.
For example, the units of a line size attribute may be modified from 100.00mm to 100 if
‘.00mm’ is entered. Replace unit must be used in conjunction with Remove unit.
• Convert unit
If the Convert unit checkbox is checked for an attribute then the unit for that attribute
will be converted into another unit based on the list (Metric/Imperial Equivalent Sizes)
of value provided in P&ID Administrator application.
For example, the units of a line size attribute may be changed from millimetres to
inches.
Select a mapping row and click Delete Mapping to remove it. To delete all mappings. check
the Select All Mappings checkbox and then click Delete Mapping.
Click the Finish button.
A message is then displayed to inform the user that the new configuration has been created.
For example:

Click the OK button to complete the procedure.

Edit Configurations
To edit an existing configuration, select the Edit existing configuration option.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

A list of existing configurations set up for the selected data source type is then displayed.

Select the configuration to be edited and click Next >.

Step 2 of the configuration process is then displayed, as described above. The Source
Element data in this step cannot be edited, nor can the Destination Element data in step 3.
Use the Next > button to step through to steps 4 and 5. The source filter and attribute
mapping settings in these steps may be edited. See above for details.

Delete Configurations
To delete a configuration, select the Delete existing configuration option.
A list of existing configurations set up for the selected data source type is then displayed
(see above). Select the configuration to be deleted and click Finish.
The selected configuration is then deleted.

Copy Existing Configuration

To copy a configuration, select the Copy existing configuration option.
A list of existing configurations set up for the selected data source type is then displayed
(see above). Select the configuration to be copied and click Finish.
The selected configuration is then copied. A message is displayed to confirm this. The
copied configuration can now be edited as required (see above).

Rename Existing Configuration

To rename a configuration, select the Rename existing configuration option.
A list of existing configurations set up for the selected data source type is then displayed
(see above). Select the configuration to be renamed. Its name then becomes editable in the
list field. Type in the new name, and click Finish.
The selected configuration is then renamed. A message is displayed to confirm this.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

7.4.2 Specify Compare/Update Row Colours

The colours used indicate the status of the data when comparing and updating data is setup
using the Colour Settings window, accessed by selecting Setup > AVEVA Integration
Services > Compare/Update Colour Configuration from the Project Tab.
The Colour Settings window is then displayed:

To change a colour, click the Background button next to it. A dialog is then displayed from
which the required colour is selected.

7.4.3 Import, Compare and Update Data

To import data, and to compare and update data, use the facilities in the Service
Integration group of the Manage Tab.
Select the product from which data is to be imported from the Products list, and the click
Connect.
Select the configuration group from the Group list. If the required group is not available, the
list may be refreshed by clicking Refresh Groups.

Note: A configuration must have been setup for the selected product and group. Refer to
AVEVA Integration Import Configuration for details.

Click Import Data. The results of this are then displayed in the Compare/Update window.
For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The imported objects shown in the tab named after the selected data source.
By default, 1000 records are displayed at once. Use the Next button to view the next page
of records, and the Previous button to view the previous page. The current page and total
number of pages is displayed next to these buttons.

Note: The number of records displayed per page is controlled by the No of records per
page setting on the Integration Settings tab of the Preferences window in AVEVA
Instrumentation Engineer.

Note: The background colours of the object rows indicates the status of the objects in the
rows. Refer to 7.4.2: Specify Compare/Update Row Colours for the meaning of these
colours and how to change then.

To view all the attributes of a specific object, select the All Mapped Attributes option from
the Side-by-Side Menu (see above). To view only attributes that have different source and
target values, select the Differences Only option instead.
To select an object to be imported, check its Accept checkbox. Click Accept All to check all
the Accept checkboxes.
The attributes of all the objects are shown in the Attribute Details tab.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

This tab displays the attributes of source objects alongside the attributes of the source
(AVEVA Instrumentation) objects.
The Accept checkboxes of objects that have their Accept checkboxes checked on the
other tab are checked automatically. Check and uncheck attribute checkboxes as required.
When all required Accept checkboxes are checked, click Update Database to import the
selected data.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

The Update database dialog is then displayed:

The window displays a summary of the changes that will be made to the database. To
implement these changes, select the UpdateDB button.
The update then takes place. A summary of the changes is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Import and Export Procedures

Click Close to exit the window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Work Packs

8 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 a work pack, so that work can be more easily prioritised.
When the user starts the application, if work packs have been created, the Select a
WorkPack window is displayed from which the user can select a work pack. The user can
choose not to select a work pack by clicking Operate without WorkPack.

The Select a WorkPack window can also be accessed by selecting Work Packs > Open
from the Project Tab.
To create a work pack, click New to display the Work Pack window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Work Packs

To edit an existing work pack, select it from the list and click Edit to display the Work Pack
window with the current work pack properties displayed.

The user must give the work pack a WorkPack No but the description and four user fields
can be left blank.

Note: It is advisable to enter information in some of the fields for later reference.

The user can then assign a start and end date for the work pack by selecting dates in the
Date Started and Date Required fields.
Click Save to create the work pack or save changes and return to the Select a WorkPack
window where the new work pack will be displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Work Packs

Click Cancel to exit the WorkPack window and return to the Select a WorkPack window.

Once a work pack has been created, items, for example drawings or instruments, can be
assigned to it. To assign items to a work pack, select the required items in the appropriate
grid view and select Work Packs > Assign to Work Pack from the Project Tab to display
the Select a WorkPack window. Select the required work pack from the list and click
Select. The WorkPack number selected will be displayed against the items in the
WorkPackNumber field in the grid view.

Note: When working in a work pack, any newly created objects will automatically be
assigned to the current work pack.

Note: The WorkPackNumber column is not selected for display in the AVEVADefault Grid
View. If it is required to be displayed, a new grid layout must be created with the field
visible.

To un-assign an item from a work pack, select the item in the grid view and select Work
Packs > Un-Assign from Work Pack from the Project Tab. The grid view is refreshed and
the selected item is removed from the work pack.
The user can view the items assigned to a work pack by selecting Work Packs > Open
from the Project Tab and selecting the work pack from the list displayed on the Select a
WorkPack window. The grid view will be refreshed to display only the items in the selected
work pack.
Work packs can be deleted by selecting Work Packs > Open from the Project Tab to
display the Select a WorkPack window. Select the work pack to be deleted from the list and
click Delete. If items have been assigned to the work pack, a Delete confirmation window
will be displayed informing the user that items are assigned to the Work Pack and asking if
the user wants to delete the work pack. The user can select Yes to delete the work pack or
No to cancel the deletion and return to the Select a WorkPack window. If Yes is selected all
items assigned to the work pack will be un-assigned.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Work Packs

8.1 Import from Excel

When importing from Excel, if the user is working in a work pack, a message is displayed
asking whether or not the imported data should be assigned to that work pack.

Clicking Yes will assign all the imported records to the work pack. Clicking No will import all
the records without assigning them to the work pack.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

9 Change Reports

The following change reporting facilities are available in AVEVA Instrumentation:

• Audit Manager
• Database Revisions

9.1 Audit Manager

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

Note: The audit log may be cleared, either entirely or for a range of dates, using facilities
provided by the AVEVA Instrumentation Security Manager.

The Audit Manager is accessed by clicking Audit Log in the Changes section of the
Manage Tab. The Audit Manager window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

By default the Audit Manager displays all database changes for the current AVEVA
Instrumentation module and grid. The grid shows the most recent change at the top.
The Audit log includes the user name and date/time of the change. The user name is the
Windows login name of the user that changed the data in AVEVA Instrumentation.
Data from other AVEVA Instrumentation objects can be selected from AVEVA
Instrumentation Object Type list (more than one can be selected).
The Apply Date/Time filter enables the list to be filtered between user defined dates/times.
The Apply Limit enables the list to be limited to a user defined maximum. The most current
changes are always included, effectively removing the early project changes from the list.
The Tools menu includes an Export to Excel command, used to export the data to Excel.

9.2 Database Revisions

AVEVA Instrumentation enables users to make a copy of the current database state as a
Database Revision. At any time, the current database can be compared to a saved
Database Revision. This 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'.
To access the Database Revisions facility, select Database Revisions from the Changes
section of the Manage Tab. AVEVA Instrumentation will then open the Project Revisions
window:

This window shows all previously saved Database Revisions (if any have been saved).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

Toolbar Menus

Command Description

New Saves the state of the current project database as a revision for
change reporting in the future with the Save Database Revisions
window.

Delete Deletes the selected Database Revision.

Compare Displays the Compare Changes between Database Revisions to

compare current database state with the selected Database Revision.

Find Finds a value in the grid.

Filter Displays a window to filter the grid.

Refresh Refreshes (re-loads) the grid with data from the database.

Close Closes this window.

Continue at:
• Save Database Revisions
• Compare Changes between Database Revisions

9.2.1 Save Database Revisions

Prior to comparing changes, a Database Revision must be saved.

To Save a Database Revision

From the Database Revisions window, click New in the toolbar menu. This displays the
Save a Project Revision window:

To save the current database state as a Database Revision, enter a unique Revision
Number and (optionally) descriptions and a user name, click Save to save the revision.

Note: If the current database is large (i.e. there are many entries) this action may take a
few minutes to complete.

Note: It is recommended that Database Revisions are saved only when all other engineers
and designers have exited AVEVA Instrumentation applications.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

9.2.2 Compare Changes between Database Revisions

Prior to comparing changes a Database Revision must be saved. Refer to Save Database
Revisions.
To compare a previously saved Database Revision to the current database, from the
Database Revisions window, click Compare in the toolbar menu.
The Compare Database Revisions window is then displayed:

To compare the current database state to the Database Revision selected in the previous
Database Revision list, select the Change Report type from the list on the right-hand side of
the Compare Database Revisions window.

Note: Multiple Change Reports may be selected by clicking on any number of types in the
list.

To run the Compare Reports, click Compare.

Note: If the current database is large (i.e. there are many entries) this action may take a
few minutes to complete particularly if multiple detail reports are run.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

When the comparison reports are completed, AVEVA Instrumentation will display any
differences in a grid. For example:

This grid shows all changes for the selected Change Report (in this example 'Instrument
Details’).
The changes can be printed or exported to Excel by using the appropriate toolbar
commands.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Change Reports

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

10 Reports

For each module, AVEVA Instrumentation is supplied with a number of “fixed” pre-defined
reports that cannot be edited by users.
AVEVA Instrumentation is also provided with facilities that enable users to create, modify
and customise reports.
The list of fixed, user-generated and custom reports, and the facilities for creating and
editing them, are available from the Reports grid, which is available in each module. To
open the grid, click Select in the Grids and Schedules section of the Home tab.
Select Reports from the list of grids that is then displayed. The Reports grid is then opened:

The grid shows a list of all previously defined reports for the module, including those
supplied with AVEVA Instrumentation.

Note: Refer to Data Grids for information on the grid controls, including how to select a
record (a Report).

Access Rights to Reports

As with other project data, different users may have different levels of access rights, as
specified using the Security Manager module.
In addition to the standard access rights that may be associated with all types of project
data, users may have the following access rights to reports:
• Full Access (No Edit Query) - users with this level of access have full access rights
except that they cannot edit the SQL queries that reports are constructed from (see
Create and Edit Custom Reports).
• Read Only (Allow Issue & Revs) - users with this level of access cannot edit or delete
reports but they may issue them (see Report Issues) and create revisions for them (see
Report Revisions).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

For further details of access rights, refer to the Security Manager module guide.

Reports - List Tools Options

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

Records Section
Refresh

New These common options are also located on the Home tab.
Edit Refer to the Other Common Grid Commands for details.

Delete

Actions Section
Open Opens the selected report for viewing, printing and editing.

Preferences Used to access and edit report preferences. Refer to Report

Preferences.

Issue Issues and updates selected report(s). Refer to Report Issues.

Open Issues Displays the Issues window listing all the current issues for the selected
For Selected report. Refer to View Previous Issues for further information.

Open Issues Displays the Issues window. Refer to View Previous Issues for further
For All information.

Add Used to create a new revision. Refer to Create a Revision.

Revisions

Edit Used to edit the current revision. Refer to Edit a Revision.

Revisions

Open Displays a list of all drawings with revisions (and their revisions). Refer
Revisions to Viewing and Editing Multiple Document Revisions.
For Selected

Open Displays a list of all drawings with revisions (and their revisions). Refer
Revisions to Viewing and Editing Multiple Document Revisions.
For All

Highlight Used to highlight which issued reports include data that has been
Documents changed in the database and therefore may need to be reissued. Refer
for Reissue to Highlight Reports for Reissue.

Import Section
From Used to import a report from a report template file. Refer to Import from
Template Report Templates.

From Other Used to import reports from another AVEVA Instrumentation Project.
Project Refer to Import Reports from Another Project

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Export Section
Export To Used to export a report to a report template file. Refer to Export Report
Template Templates.

Note: Only the Refresh, New and Open options are available when a fixed report is
selected in the grid.

Continue at:
• Fixed Reports
• Create a New Report
• Edit Report Details
• Create and Edit Custom Reports
• Report Preferences
• View and Print Reports
• Report Revisions
• Report Issues
• Export to and Import from Report Templates
• Import Reports from Another Project
• Edit Report Layouts

10.1 Fixed Reports

To view and print a fixed report, select it from the Reports grid and click Open. The report is
then displayed. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Note: Fixed reports cannot be edited, deleted, issued, exported, imported, or have
revisions applied to them.

The window includes facilities for printing the report and exporting it to an Excel
spreadsheet.
For further details of the available fixed reports, refer to the appropriate module
documentation.

10.2 Create a New Report

Click New on the Home tab to display the Select Type Report window:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

The dialog lists all the grids, tables etc. in the module for which reports can be generated,
plus “Custom”. The “Custom” option is used to construct reports from SQL queries on
project data.
Select the required option and click OK.
If the “Custom” option was selected, the Custom Report Editor dialog is displayed.
Continue at Create and Edit Custom Reports.
If a grid was selected, the AVEVA Instrumentation Report dialog is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Note: New reports can also be created by copying an existing report. Select the report to
be copied, then click the down-arrow button next to New. From the menu that is then
displayed, select Copy Selected. The AVEVA Instrumentation Report window is
then displayed, populated with details of the copied report.

Enter Basic Details

Select the plant area that the report is associated with from the list in the Area field.
The Grid Name field displays the name of the selected grid and cannot be changed.
Enter a unique name for the report in the Document No field. Enter a description in the
Description field.

Note: The Document No and Description fields must be completed.

Set the report to be “public” for the project by checking the Public checkbox. Access to the
report is restricted to the current user if the checkbox is left unchecked.
If required, enter a full title for the report in the Title 1 and Title 2 fields.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Specify the Required Fields

Click the Fields tab to show a list of fields available for use in the report.

To select/de-select fields, click each fields checkbox in the Select column. The user can add
as many fields as required.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Define Report Sort Order

Define a sort order by clicking Sorting to select the field(s) to sort by in the new report.

The View Fields list displays all fields for the report. Check the Show Used Only checkbox
if only those fields selected for the report (in the Fields tab) are to be displayed.
To select a field, double-click it in the View Fields list to move it to the Sort By list.
The order of fields in the Sort By list will be the sort order of the report. In the example
above, data in the report will be sorted first by Area, and then by Tag Number.
To remove a field from the Sort By list, double-click on it. It is then returned to the View
Fields list.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Define Report Filters

Use the Filtering tab to apply filtering to a report.

The Filtering tab is used in the same way as the Filter window. Refer to Apply Advanced
Grid Filters for details.

Report Revision
To add a revision to the report, click Revisions to display the revision fields.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

To add a revision, click Add to display the Revision Entry window.

Note: Revisions can also be added, edited, deleted and viewed using facilities directly
accessible from the Report Manager window. Refer to Report Revisions.

Note: An unused revision needs to be available before a report can be Issued.

Complete the fields with the required revision data (entry of a revision number is
mandatory).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Note: 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.

Note: 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 revisions.

Click Save. The Revisions window is then displayed again with the new revision added to
the list of revision.
To edit a revision, select the revision from the list and click Edit to display the Revision
Entry window. Change the values as required and click Save. The amended values will be
displayed in the list.
To delete a revision, select the revision from the list and click Delete. A message is
displayed requesting the user to confirm the deletion.

Click Yes to confirm the deletion and return to the Revisions window. The selected revision
is then removed from the list. Click No to cancel the deletion.

Save the Report

Click Save. The window closes, and the new report is saved and added to the list of reports
in the Reports grid. It’s type will be that of the grid from which the report data is derived.

10.2.1 Create Revision Sub-Reports

Once a report has been saved, a sub-report can be created for the report revision data,
which can be added to the report itself. If this is required, click Create Revisions Sub
Reports on the Revisions tab. The following message is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

A new custom report is then created and added to the list of reports. It’s name will be the
name of the main report with “Rev” appended to the end. Refer to Create and Edit Custom
Reports for details on editing custom reports.
Follow the instructions in the message to add the sub-report to the report. Refer to Edit
Report Layouts for details.

10.3 Edit Report Details

To edit a report, select it from the Reports list and click Edit.

Note: Fixed reports cannot be edited. The Edit option is disabled for reports of this type.

The AVEVA Instrumentation Report window is then displayed:

Edit the report details as required.

Edit Report Queries

Once a report has been saved, an Edit Query button is available on the window. This is
used to access the Custom Report Editor window, which is used to edit the queries from
which the report is constructed.
When this button is clicked, the following message is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

As the message states, editing the report queries will change the report into a custom
report.
If Yes is clicked, the Custom Report Editor window is displayed. Refer to Create and Edit
Custom Reports for further details.

View Revisions Sub-Reports

If a revision sub-report has been added to the report it can be viewed by clicking View
Revisions Subreport to on the Revisions tab. The Report window is then displayed.
Refer to Create and Edit Custom Reports for further details of custom reports.
Refer to View and Print Reports for details of the Report window.

10.4 Create and Edit Custom Reports

Custom reports are reports defined by the user from SQL queries on project data.
To create a custom report, click New on the Home tab to display the Select Type Report
window:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Select the Custom option and click OK. The Custom Report Editor window is then
displayed.
Custom reports can also be created by amending the queries from which reports generated
from a list are constructed (see Create a New Report). Reports edited in this way are
automatically converted into reports of the “custom” type. To edit a report in this way, click
the Edit Query button on the AVEVA Instrumentation Report window, as described in Edit
Report Details. The Custom Report Editor window is then opened, with the current queries
of the report displayed.
Revision sub-reports are also custom reports, and can be edited in the same way as other
reports if required. Refer to Create Revision Sub-Reports for information on how to create a
revision sub-report.
To edit a custom report, select it from the Reports list and click Edit. The Custom Report
Editor window is then displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Enter or Edit Basic Details

Select the plant area that the report is associated with from the list in the Area field.
The Grid Name field displays the name of the selected grid and cannot be changed.
Enter a unique name for the report in the Document No field. Enter a description in the
Description field.

Note: The Document No and Description fields must be completed.

Set the report to be “public” for the project by checking the Public checkbox. Access to the
report is restricted to the current user if the checkbox is left unchecked.
If required, enter a full title for the report in the Title 1 and Title 2 fields.

Add and Edit Queries

To add an SQL query, click Add Query. The SQL Query Maker is then displayed, in which
the query can be defined.
To edit an existing query, select it from the list beneath the button and click Edit Query. The
SQL Query maker is then displayed with definition of the selected query displayed for
editing.

Note: In order for user-defined properties to be available when constructing queries for
custom reports, the Available for Custom Reports checkbox for those properties
must be checked. Refer to the Engineer or Process Engineer module documentation
for details.

For information on how to use the SQL Query maker, refer to the Active Query Builder User
Guide or visit www.activequerybuilder.com.
To delete a query, select it from the list beneath the button and click Delete Query. A
message is displayed requesting that the deletion be confirmed. Click Yes to proceed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Click Save to save changes to the report definition and exit the window.
Click Cancel to exit the window without saving.

10.5 Report Preferences

Preferences can be set for each report type.

Note: Changes to preferences only apply to reports created after those changes were
made. Existing reports are not affected.

To set report preferences, click Preferences on the List Tools - Reports tab. The Select
Type Report window is then displayed:

Select a report type and click OK. The Report Preferences window is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Select the font, font size, boldness, background colour and row height for each report
section.
Select the colour in which changes between a selected issue and the current data in a
report are to be highlighted in the Issue Changes section.
Click Save to save changes to the preferences and exit the window.
Click Cancel to exit the window without saving.

10.6 View and Print Reports

To view a report, and to access facilities to print, export, e-mail and edit the layout of the
report, either double-click on the report in the Reports grid, or click on it and click Open on
the List Tools - Reports tab.
The Report window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

The report is displayed in the main part of the window. Above the report display, are
displayed a toolbar and menus.

Note: This window is also displayed when the Quick Report option on the Home Tab is
selected, displaying the current grid as a report.

Report Window Command Buttons

The following command buttons are provided.

Search Opens a Find window with standard facilities, used to search for
text within a report.

Print Used to print the current report. Opens a standard Windows

Print Options window.

Quick Print Used to print the report using the default printer settings.

Page Setup Used to configure the report page. Opens a standard Windows
Page Setup window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Scale Used to scale the report. Opens the following drop-down:

Hand Tool Changes the cursor to the hand tool, which can be used to pan
around the report.

Magnifier Changes the cursor to the magnifier tool, used to change the
report view by zooming in and out.

Zoom Out Used to change the report view by zooming out.

Zoom % Used to adjust the report view by the zoom percent value.

Zoom In Used to change the report view by zooming in.

First Page Used to display the first page of a report.

Previous Page Used to display the previous page of a report.

Next Page Used to display the next page of a report.

Last Page Used to display the last page of a report.

Multiple Pages Used to change the report view to display multiple pages.
Opens the following drop-down:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Colour Background Used to change the colour of the report background, as

selected from the following drop-down:

Watermark Used to add a text or picture watermark to the report. Opens the
Watermark window:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Export Document Used to export the report as a file.

Displays the following menu, from which the file format is
selected:

Once the file format is selected a window is displayed from

which export options relevant to the selected file type can be
selected, for example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Click OK.
A standard Save As window is then displayed which is used to
specify the location that the file is to be exported to. Click Save
to complete the export.

Send via E-mail Used to save the report as a file and send the file via e-mail.
Displays the following menu, from which the file format is
selected:

Once the file format is selected a window is displayed from

which options relevant to the selected file type can be selected,
for example:

Click OK.

A standard Save As window is then displayed which is used to

specify the location that the file is to be saved to. Click Save to
complete the save.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Edit Layout Opens the Report Designer, used to edit the layout of the report.
Refer to Edit Report Layouts.

Highlight Issue Used to highlight changes between different issues of the

Changes for: report. Refer to Highlight Changes Since a Selected Issue.

Exit Closes the Report window.

Report Window Menus

The following menu options are provided:

File Menu
Page Setup Used to configure the report page. Opens a standard Windows
Page Setup window.

Print Used to print the current report. Opens a standard Windows

Print Options window.

Quick Print Used to print the report using the default printer settings.

Export Document Used to export the report as a file. See Report Window
Command Buttons for details.

Send via E-mail Used to save the report as a file and send the file via e-mail.
See Report Window Command Buttons for details.

Exit Closes the Report window.

View Menu
Page Layout Used to select either a facing (the default) or continuous page
layout.

Status Bar Used to show (the default) or hide the status bar at the bottom
of the window.

Customize Opens a window which can be used to customize the menus

and toolbars.

Background Menu
Colour Used to change the colour of the report background. See
Report Window Command Buttons for details.

Watermark Used to add a text or picture watermark to the report. See

Report Window Command Buttons for details.

10.7 Report Revisions

Revisions can be viewed, created, edited and deleted from the AVEVA Instrumentation
Report window (refer to Create a New Report). An unused revision must exist before a
report can be Issued.
These facilities are also directly accessible from the List Tools - Reports tab. For details,
continue at:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

• Create a Revision
• Edit a Revision
• Viewing and Editing Multiple Document Revisions

10.7.1 Create a Revision

To create a revision for a report select the report, then click Add Revision on the List Tools
- Reports tab.
The Revision Entry window is then displayed:

Complete the fields with the required revision data (entry of a revision number is
mandatory).

Note: 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 revisions.

Note: 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.

Click Save when the required details have been entered.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

10.7.2 Edit a Revision

To edit the current revision of a report, select the report and click Edit Revision on the List
Tools - Reports tab. The Revision Entry window is then displayed with the details of the
current revision displayed for editing.

10.7.3 Viewing and Editing Multiple Document Revisions

Details of revisions for either a selected report or for all reports in the module can be viewed
and edited.

View and Edit All Revision of a Report

To view a list of all revisions for a single report, select the report and then click Open
Revisions for Selected on the List Tools - Reports tab. The Revisions for Report:
<report name> window is displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

To add a new revision, click New. The Revision Entry window (see Create a Revision) is
then displayed. Enter the required details and click Save.
To edit an existing revision click Edit. The Revision Entry window (see Edit a Revision) is
then displayed.
To edit multiple revisions, select them and click Edit. The Multi-Field Edit (Bulk Edit)
window is displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

• 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 made, 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.
A sub-report can be created for the report revision data, which can be added to the report
itself. If this is required, click Create Revisions Sub Reports. The following message is
then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

A new custom report is then created and added to the list of reports. It’s name will be the
name of the main report with “Rev” appended to the end. Refer to Create and Edit Custom
Reports for details on editing custom reports.
Follow the instructions in the message to add the sub-report to the report. Refer to Edit
Report Layouts for details.

View and Edit All Revisions of All Reports

To view a list of all revisions of all reports in the Reports grid, click Open Revisions for all
on the List Tools - Reports tab. The Revisions window is displayed:

To view the revisions for a single report, click on the + icon next to its listing.
To view revisions for all reports, click Show All Revs.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

To add a new revision, click New. The Revision Entry window (see Create a Revision) is
then displayed. Enter the required details and click Save.
To edit an existing revision click Edit. The Revision Entry window (see Edit a Revision) is
then displayed.
To edit multiple revisions, select them and click Edit. The Multi-Field Edit (Bulk Edit)
window is displayed. Proceed as described above.
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.

10.8 Report Issues

To issue a report, select it and then click Issue on the List Tools - Reports tab. A
confirmation request message is then displayed. For example:

Click Yes.
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:30 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Click Cancel to cancel the issue or OK to create a new revision. Refer to Report Revisions
for further information on creating a new revision. Once the revision has been created, the
issue procedure automatically resumes.
See also:
• Highlight Reports for Reissue
• View Previous Issues
• Highlight Changes Since a Selected Issue

10.8.1 Highlight Reports for Reissue

To highlight issued reports which include data that has been changed in the database, and
therefore may require reissuing (see Report Issues), select the reports to be checked in the
Reports list, and then click Highlight Documents for Reissue on the List Tools - Reports
tab.
The reports 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.

10.8.2 View Previous Issues

To view previous issues, click either Open Issues For Selected or Open Issues For All as
required on the List Tools - Reports tab.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

The Issues window is then displayed.

If Open Issues For Selected was clicked, the window lists all the issues for the report
currently selected in the grid. If Open Issues For All was clicked, the window lists all the
issues for all the reports in the grid.

Note: If the revision associated with an issue has been deleted, the Cancelled checkbox
for the issue will be checked. The issue itself however will not be deleted, and the
issued report may still be opened and viewed.

Command Buttons:

Open Open the selected issues in the Preview window (see below).

Delete Deletes the selected issues. A confirmation message is displayed before

the deletion takes place.

Note: Before an issue of a report can be deleted, all later issues of that report must first
be deleted. A message is displayed if a user attempts to delete an issue of a
report for which later issues exist. For example:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Print Prints the selected issues.

Find Displays the Find window, used to search by any text string located
anywhere within the grid.

Filter Opens the Grid Manager window, used to define the current grid view
filter criteria.

Refresh Updates entire grid with latest database information (useful in multi-user
project environments).

Close Closes the window.

Preview Window
The Preview window is opened by selecting an issue and clicking Open, as described
above. It is used to view, save, print, e-mail and export report issues.

The toolbar buttons are identical to those of the main Report window, with the addition of
buttons for opening and saving reports, and with the exception of the Edit Layout and
Highlight Issue Changes for options. Many of the facilities accessible from the toolbar are
also accessible from the File, View and Background menus.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

10.8.3 Highlight Changes Since a Selected Issue

To highlight differences between the current data in a report and the data in that report at a
selected issue, open the report. In the Report window, click Highlight Issue Changes for.
Then select the issue with which the current data is to be compared from the sub-menu. For
example:

Changes are then highlighted in the colour selected in the Report Preferences window
(refer to Report Preferences).

10.9 Export to and Import from Report Templates

Reports can be exported to template files, which can then be imported into other projects.
Refer to:
• Export Report Templates
• Import from Report Templates

10.9.1 Export Report Templates

To export a report template to a template file (.TPL format), select the report and then click
Export To Template on the List Tools - Reports tab.
The Save As window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Select the location to which the template file is to be saved, enter the file name, and click
Save to export the report.
If the report contains a sub report, the following message is then displayed:

Click Yes to include the sub report in the export. The Save As window is displayed again so
that a location and file name for the sub report can be specified.
The export of the sub report then takes place.

10.9.2 Import from Report Templates

To import a report to the Reports list from a template file (.TPL format), select the report and
then click Import To Template on the List Tools - Reports tab.
The Open window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

Browse for and select the required TPL file, and click Open.
The Report Import Options window is then displayed:

The Report Name field displays the name of the report that the template was exported
from. Change this as required to the name of the report to be added to the Reports list.
If only the report layout is to be imported, but not the underlying query, select the Layout
only option (this is the default option).
If the underlying query is to be imported as well, select the Layout and Datasource option.
Click OK. The template is then imported and a report based on it is added to the Reports
list.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

10.10 Import Reports from Another Project

Reports definitions of a specified report type can be imported from another AVEVA
Instrumentation project.
To import from another AVEVA Instrumentation project, click From Other Project in the
Import section of the List Tools - Reports tab (or the Manage Tab).
The Select an AVEVA Instrumentation Project window is then displayed. Select the
required project and click Select.
The Select Type Report window is then displayed:

Select the type of report to be imported from the selected project and click OK.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

The Report Import window is then displayed. This lists all the reports definitions in the
selected project for the selected report type.

To select a report definition for importing, check its Select checkbox. Check the Select all
checkbox to check all Select checkboxes.
When the required report definitions have been selected, click Import.
A progress window displays the progress of the import. The selected report definitions are
then added to the project and are listed in the Reports grid.
If an imported report has the same name as a report in the current project, it's name will be
suffixed with “Copy of…”.

Note: It is the report definitions that are imported, not the reports themselves. Imported
reports will therefore display data for the current project, as specified by the report
definition, not data from the project they were imported from.

Note: Properties defined in the source project that have values on imported reports are not
imported. In other words, properties in the source project not defined in the target
project will not be added to the list of properties in target project.

10.11 Edit Report Layouts

To edit the layout of a report, open it and click Edit Layout - located at the top right of the
Report window to display the Report Designer window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

The Report Designer enables a user to:

• Layout the selected fields on the report page
• Set font attributes (font name, font size, whether bold or italic, etc.)
• Set colours (both foreground and background)
• Attach pictures/logos etc.
• Set page headers/footers, grouping etc.
• Add sub-reports, such as revision sub-reports.
Note: To add additional fields to the report drag the field name onto the page (from the
Fields List tab tree view) at the middle right of this window. To add a new field that is
not yet in the tree view, save the layout and select the new fields from the Grid fields
list as described in Create a New Report.

For more information about editing report layouts please refer to the Report Designer User
Guide.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Reports

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Claims

11 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 example:

To unlock an item click Claims in the Multi User section of the Manage Tab. The Claims
window is then displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Claims

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A Instrument Sizing Calculations

The following instrument sizing calculations are described in this appendix:

• 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.

A.1 Control Valve Sizing

The ISA75 program carries out valve sizing according to the ANSI/ISA S75.01 - 1995
standard.
It only concerns itself with the valve sizing and potential choking regimes (Sonic flow for
gases or flashing/cavitation for liquids).
Reynolds number calculations are performed for liquids but the graph published by ISA 75
has been replaced by a formula which fits the graph in the standard with reasonable
accuracy.
Continue at:
• Units
• Formulas Used For Liquids
• Formulas Used For Gases (Compressible Fluids)
• Typical Values for FL and XT and Fd
• Why Molecular Weight and Compressibility are Missing

A.1.1 Units
ISA S75.01 has several standard conversion factors for unit conversion. The program
enforces two conventions:
1. The flow units are mass flows.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

2. The units are conventional practical metric units.

flow: kg/h
pressure: kPa
density: kg/m3
Valve/Pipe diameter: mm
Valve size: Cv factors
Viscosity: mPa.s (same as centipoise)

For this purpose ISA 75.01 has provided N factors in tables 1 and 2.
In the program we define the same factors with the same name except in lower case as
global variables, namely:
n2 = 0.00214
n4 = 76000
n5 = 0.00241
n6 = 2.73
Should it be desired to change the units to say, imperial units, then using the factors in
tables 1 and 2 of ISA 75.01 would be a convenient way to do it.
It is strongly recommend that units of flow remain in mass units rather than volumetric units.
Volumetric units, especially when gases are involved, lead to great confusion at times.

A.1.2 Formulas Used For Liquids

Basics

Base Sizing Formula

It is given by equation 2 in section 4.1 of the standard:

w
Cv =
N 6 FP ρ(P1 − P2 )

Where w is the mass flow rate, r is the density, P1 and P2 are the pressures respectively
upstream and downstream. N6 is a unit correction factor and FP is the piping factor (see
Effects of Fittings below).

Reynolds Number Formula

1/ 4
N Fq ⎛ FL2 C 2V ⎞
R E = 14/ 2 d 1 / 2 ⎜⎜ 4
+ 1⎟⎟
νFL C V ⎝ N 2d ⎠ Eq. 11 section 4.4
Where q is the volumetric flow rate, d is the nominal body size, FL is the valve recovery
coefficient and n is the kinematic viscosity. Since our design is based on mass flow rate and
the absolute viscosity is more often used. The formula has been modified to the following
one, equivalent but not published in the standard.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

1/ 4
N 4 Fd w ⎛ FL2 C 2V ⎞
RE = ⎜
1 / 2 1/ 2 ⎜ 4
+1⎟⎟
1000 μFL C V ⎝ N 2 d ⎠

Here we use w (kg/hr) instead of q (m3/hr) and the absolute viscosity, m, in mPa.s
(centipoise). The 1000 factor is the base density of water. N4 is the coefficient
corresponding to q in m3/hr i.e. N4 = 76000. Fd is a valve factor (for all practical purposes if
a valve internal has a single flow path, Fd = 1, if it has multiple flow paths, Fd = sqrt(n). In
general valves have either 1 or 2 paths and Fd is either 1 or 0.7).

Effects of Fittings
The effect of reducers and expanders before and after the valve is described in the standard
under section 4.3. The base piping factor FP is given by the following formula:

1
−
⎛ ΣKC ⎞ 2
2
FP = ⎜⎜ + 1⎟⎟V
4
⎝ N 2d ⎠ Eq. 3 Section 4.3

And ΣK = K 1 + K 2 + K B1 − K B2 Eq. 4 Section 4.3

The factors with subscript 1 are due to the inlet fitting; the factors with subscript 2 are due to
the outlet fitting. The fitting formulas assume the pipe is larger or equal than the valve size.
The formulas are nonsensical when a valve larger than the line is used. Since all corrections
are approximate only, it is satisfactory to use nominal sizes here instead of actual sizes.
2
⎛ d2 ⎞
K 1 = 0.5⎜⎜1 − 2 ⎟⎟
⎝ D1 ⎠ Where D1 is the inlet pipe diameter and d the valve body size.
2
⎛ d2 ⎞
K 2 = ⎜⎜1 − 2 ⎟⎟
⎝ D2 ⎠ Where D2 is the outlet pipe diameter and d the valve body size.
The KB factors are not loss factors but represent the conversion of pressure to kinetic
energy, or vice versa, within the fittings. They are called the Bernouilly factors and are
expressed as:
4
⎛d⎞
KB = 1− ⎜ ⎟
⎝ D ⎠ and when the inlet and outlet pipes are the same size, they cancel
out.

Choking
When P1 and P2 are defined, inside the valve there exists a section where the pressure is at
a minimum. This pressure is called PVC where VC stands for Vena Contracta.
The factor FL is obtained experimentally by the valve manufacturer. It is defined as:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

P1 − P2
FL =
P1 − PVC

If the downstream pressure is lowered sufficiently, at a certain value the vena contracta
pressure reaches the vapour pressure of the liquid and the liquid starts to boil. At this stage
lowering the downstream pressure further does not produce an increase in flow rate, the
vena contracta pressure remaining at the boiling point of the liquid. The valve is said to be
choked.
There are 2 modes of choking depending on whether the downstream pressure is less or
greater than the vapour pressure. If the downstream pressure is less than the vapour
pressure, the flow remains two phase all the way to the valve exit, the valve is said to be
flashing. If the downstream pressure is greater than the vapour pressure of the liquid, the
valve is said to be cavitating. Both flashing and cavitation produce a lot of noise but of the
two, cavitation is far more severe as the vapour bubbles created at the vena contracta
implode nearer the exit and cause a lot of erosion on the metal parts. Valves left cavitating
can literally destroy themselves in minutes.
One thing to notice during choking is that the flow is solely determined by the pressure
difference between inlet and the vena contracta, and it follows that the outlet fittings no
longer have any significance on the flow rate.
The flow formula becomes:

w
Cv =
N 6 FLP ρ(P1 − FF PV )

1/ 2
⎛P ⎞
FF = 0.96 − 0.28⎜⎜ V ⎟⎟
Where ⎝ PC ⎠ Equation G1
and PV is the vapour pressure and PC is the critical pressure.
FLP is a factor which combines the recovery factor and the piping geometry and we use
Equation 16 to calculate it:
( −1 / 2 )
⎛ (K 1 + K B1 )FL2 C 2V ⎞
FLP = FL ⎜⎜ 4
+1⎟⎟
⎝ N 2d ⎠ Eq 16 section 5.3
The fittings() function returns the following values:

K1, K2, KB1, KB2, KALL (same as ΣK ), Ki = (K1 + KB1) and FP

For liquids it also return FF and FLP.

A.1.3 Formulas Used For Gases (Compressible Fluids)

Basic Formula for Gases

We use equation 17 of section 6.1 of the standard:

w = N 6 FP C V Y xP1ρ1

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Where Y is a factor for the expansion of the gas and x is defined as:

x=
(P1 − P2 )
P1
Where FL was a valve characteristic determined by the manufacturer to characterise the
pressure recovery in the valve in liquid flow, the factor XT is used for gases in a similar
fashion. Again this factor is measured by the manufacturer.

CP / Cv
FK =
FK is defined as 1.4 where Cp/Cv is the isentropic exponent of the gas.
The expansion factor Y is given by equation

x
Y =1−
3FK X T but cannot be less than 2/3.
When fittings are used, XT should be replaced by XTP which is defined as:

−1
X ⎛ X T (K 1 + K B1 )C 2V ⎞
X TP = 2T ⎜ + 1⎟⎟
FP ⎜ N 5d 4
⎝ ⎠

Choked Flow
Similarly to liquids, gases flow can also choke. Simply speaking, given an upstream
pressure and a valve size, as the pressure downstream is lowered the flow increases. This
continues until the downstream pressure is such that the speed of the gas at the throat of
the valve (vena contracta) reaches the speed of sound. Lowering the downstream pressure
even more is of no avail as information about what is happening downstream cannot
propagate past the sound barrier. The flow is therefore choked.
The pressure at which choking occurs (for a given upstream pressure) is called the critical
pressure, P2CRIT.

P2CRIT = P1 (1 − FK X TP )
If P2 is less than P2CRIT, then simply use P2CRIT instead of P2 in the formulas.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A.1.4 Typical Values for FL and XT and Fd

Valve FL XT Fd
Type Trim Flow
Direction

Globe Valve Ported Plug Either 0.9 0.75 1.0

Single Port
Contoured Plug Open 0.9 0.72 1.0

Close 0.8 0.55 1.0

Characterised Cage Open 0.9 0.75 1.0

Close 0.85 0.70 1.0

Wing Guided Either 0.9 0.75 1.0

Globe Valve Ported Plug Either 0.9 0.75 0.7

Double Port
Contoured Plug Either 0.9 0.70 0.7

Wing Guided Either 0.85 0.75 0.7

Rotary Eccentric Spherical Plug Open 0.85 0.61 1.0

Close 0.68 0.40 1.0

Angle Globe Contoured Plug Open 0.9 0.72 1.0

Close 0.8 0.65 1.0

Characterised Cage Open 0.85 0.65 1.0

Close 0.8 0.60 1.0

Venturi Close 0.5 0.20 1.0

Ball Valves Segmented Open 0.6 0.25 1.0

Reduced Bore Either 0.55 0.15 1.0

Butterfly Valves 60° aligned Either 0.68 0.38 0.7

Fluted Vane Either 0.70 0.41 0.7

90° Eccentric seat Either 0.60 0.35 0.7

This table is a partial extract of Table D1 in the standard.

A.1.5 Why Molecular Weight and Compressibility are Missing

A large section of the standard deals with molecular weight, Mw, and compressibility, Z. The
reason we do not need them is they are used to convert the upstream pressure, P1, and the
upstream temperature, T1 to density.
The formula for doing so is:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

P1M W
ρ1 =
Z R T1

With the density in kg/m3, the pressure in kPa (absolute) and the temperature in K.
The molecular weight is in kg/kmole.
R is the universal gas constant R = 8.314 kJ/kmole K.
Z can be estimated using the Redlich-Kwong Equation of state (only Pressure, Temperature
and the critical Pressure and critical temperature of the gas are required for estimating Z). If
unknown, assume Z = 1.0.
Another program, zrk, performs the calculation of Z and the conversion of pressure and
temperature to density for any gas when the gas critical properties are known.

A.2 Relief Valve Sizing

The relief valve program is not based on any specific standard or code. However all the
various standards are all based on two fundamental assumptions:
• The flow from the pressure vessel to the throat of the relief valve is isentropic.
• The gas isentropic expansion law can be expressed using the following formula:
P CP
k
= constant
ρ C
, where k is the isentropic exponent (often estimated as V )
So, while this program is not aligned to any specific code, it nevertheless yields near
identical answers when sizing relief valves. What it doesn't provide are the specific
limitations based on specific rules.
Continue at:
• Fundamental Equations
• Application to Relief Valves
• Units

A.2.1 Fundamental Equations

Gas Law
The relation between pressure, temperature, density and molecular weight is expressed as
follows:

P MW
ρ=
Z R T Eq. 2.1.1
Here the variables are:

r is the gas density (kg/m3 in the program).

P is the pressure in absolute units (kPa in the program).
T is the absolute temperature (K in the program).
R is the universal gas constant (R = 8.314 kJ/kmole K).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Z is a compressibility factor to correct for deviation from the ideal gas law.

Speed of Sound in a Gas

Sound is by definition an isentropic process. It occurs too fast for allowing heat transfer
between the gas molecules (hence it is adiabatic), and it is also nearly reversible otherwise
sound would not propagate very far.
It is an elastic property relating pressure and density at constant entropy and by definition it
is:

⎡ ∂P ⎤
a= ⎢ ⎥
⎣ ∂ρ ⎦ S Eq. 2.2.1

P
k
= constant
If we assume that ρ then the formula becomes:

P
a= k
ρ Eq. 2.2.2
This is the formula which is often quoted but one needs to remember that it is only true if the
P
k
= constant
gas follows the ρ law. Also the isentropic exponent is often called the ratio of
CP
k=
specific heats because for most gases at low pressures
C V . This law is not always
true when the pressures get higher, and simply using the ratio of specific heat and applying
it as the isentropic exponent can lead to errors. The k which is required is that which
expresses the gas isentropic compression best.

Bernouilli's Equation for Gases

The equation simply states that between two sections 1 and 2, for steady flow (i.e. the flow
rate remains constant at every point). The change in energy per unit of mass of fluid
depends only on the amount of work, W, and heat, Q, that has entered as the fluid goes
from 1 to 2.

g (Z 2 – Z1 ) +
(v 2
2 )
– v12 ⎛P P ⎞
+ (U 2 – U 1 ) + ⎜⎜ 2 – 1 ⎟⎟ = W + Q
2 ⎝ ρ 2 ρ1 ⎠ Eq. 2.3.1

g is the gravitational acceleration (9.81 m/s2).

Z is the elevation at sections 1 and 2 respectively.
v is the speed at sections 1 and 2 respectively.
U is the gas internal energy at sections 1 and 2 respectively.
P is the pressure at sections 1 and 2 respectively.
r is the density at sections 1 and 2 respectively.
W is the work entering between sections 1 and 2.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Q is the heat entering between sections 1 and 2.

Special Case when Heat and Work are not Involved

In this instance, W and Q are both zero.
In addition if the flow is horizontal, or the change of elevation is small enough to be

insignificant, then Z 2 – Z1 = 0, so equation 2.3.1 becomes

V22 P V2 P
+ U 2 + 2 = 1 + U1 + 1
2 ρ2 2 ρ1 Eq. 2.4.1

U= CV T
The internal energy for an ideal gas is

P
H = U+
And the thermodynamic definition of Enthalpy is ρ
So equation 2.4.1 can also be written in term of Enthalpy:

V22 V2
+ H 2 = 1 + H1
2 2 Eq. 2.4.2
This equation is currently not used much for sizing relief valves but the improvement arising
from the various thermodynamic models show that in the future this equation will be able to
be used directly for solving relief valve sizing problems. This is especially true when the
problem is far away from conventional problems, for instance for compressible fluids close
to critical conditions or when two phase flow is involved, where current international
standards fall far short of offering sensible solutions.

A.2.2 Application to Relief Valves

Assumptions

P R
= T
The gas Equation of State is
ρ M W Eq. 3.1.1

V1 = 0
The state 1 conditions are those in the pressure vessel; in particular this implies as
the vessel is much larger than the nozzle of a relief valve.
The flow from the vessel to the throat of the relief valve is isentropic (i.e. no friction and no
heat exchange).

P
k
= constant
The law ρ applies to the gas to characterise the isentropic expansion.
Eq. 3.1.2

CP
k=
C V Eq. 3.1.3

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

R = M W (C P – C V ) Eq. 3.1.4

U = CV T
Eq. 3.1.5
These are the assumptions made by all relief valve sizing standards.
Combining Eq. 3.1.3, 3.1.4 and 3.1.5 we get:

1 R
U= T
(k – 1) M W Eq. 3.1.6
Subsonic Flow Equations
Since V1 = 0, we can express equation 2.4.1 as follows:

V22 ⎛P P ⎞
= (U1 – U 2 ) + ⎜⎜ 1 – 2 ⎟⎟
2 ⎝ ρ1 ρ2 ⎠ Eq. 3.2.1
From equation 3.1.6 we have:

1 R
U1 – U 2 = (T – T )
(k − 1) M W 1 2 Eq. 3.2.2
From equation 3.1.1 and equation 3.1.2 we derive:

k –1
T2 P2 ρ1 ⎛ P2 ⎞ k
= =⎜ ⎟⎟
T1 P1 ρ 2 ⎜⎝ P1 ⎠ Eq. 3.2.3
And replacing in equation 3.2.2 we finally derive the change in internal energy of the gas
during the isentropic expansion is:

⎛ k −1 ⎞
⎜ ⎞ k ⎟⎟
1 R T1 ⎜ ⎛ P2
U1 – U 2 = 1– ⎜ ⎟⎟
k – 1 M W ⎜ ⎜⎝ P1 ⎠ ⎟
⎜ ⎟
⎝ ⎠ Eq. 3.2.4
Similarly we have:

⎛ k –1 ⎞
⎛ ⎞ ⎜ ⎞ k ⎟⎟
P1 P2 P1 P2 ρ1 R T1 ⎜ ⎛ P2
– = ⎜ 1– . ⎟ ⎟ = 1– ⎜ ⎟⎟
ρ1 ρ 2 ρ1 ⎜⎝ P1 ρ2 ⎠ M W ⎜ ⎜⎝ P1 ⎠ ⎟
⎜ ⎟
⎝ ⎠ Eq. 3.2.5
Hence for the speed at the throat of the nozzle we get:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

⎡ k −1⎤
2k R T1 ⎢ ⎛ P2 ⎞ k ⎥
V2 = . ⎢1 – ⎜⎜ ⎟⎟ ⎥
k − 1 M W ⎢ ⎝ P1 ⎠ ⎥
⎣⎢ ⎦⎥ Eq. 3.2.6
The theoretical mass flow rate through the nozzle is:

1
PM ⎛ P2 ⎞k
ρ2 = 1 W ⎜⎜ ⎟⎟
m = A ρ2 V2 and RT1 ⎝ P1 ⎠
So:

⎡ 2 k +1 ⎤
2k M W ⎢⎛ P2 ⎞ k ⎛ P2 ⎞ k ⎥
m = AP1 ⎢⎜ ⎟⎟ – ⎜⎜ ⎟⎟ ⎥
k − 1 R T1 ⎢⎜⎝ P1 ⎠ ⎝ P1 ⎠ ⎥
⎢⎣ ⎥⎦
Eq. 3.2.7
Where A is the area of the nozzle and m is the mass flow rate.
In practice, the flow is always less than the theoretical flow rate and we introduce Kd, the
coefficient of discharge. Many standards also add a safety factor asking that the flow be
further de-rated by 10% so the sizing formula becomes:

m
A=
⎡ 2 k +1 ⎤
2k M W ⎢⎛ P2 ⎞ k ⎛ P2 ⎞ k ⎥
0.9KdP1 ⎢⎜ ⎟⎟ – ⎜⎜ ⎟⎟ ⎥
k − 1 R T1 ⎢⎜⎝ P1 ⎠ ⎝ P1 ⎠ ⎥
⎣⎢ ⎦⎥ Eq. 3.2.8
This is the formula used by the program.

Sonic Flow
As the pressure downstream is lowered, the velocity through the nozzle increases until it
reaches the speed of sound. When this occurs, the flow becomes choked and lowering the
pressure further on the downstream side does not produce an increase in flow rate. The
pressure at which the flow becomes critical is called the critical pressure, Pcrit.
At this critical pressure, the speed through the nozzle is still given by equation 3.2.6 but it is
also given by equation 2.2.2:

⎡ k −1⎤
2k R T1 ⎢ ⎛ PCRIT ⎞ k ⎥
V2 = . ⎢1 – ⎜ ⎟⎟ ⎥
k − 1 M W ⎢ ⎜⎝ P1 ⎠ ⎥
⎢⎣ ⎥⎦
Eq. 3.3.1
and:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

PCRIT
V2 = k
ρCRIT
Eq. 3.3.2
and:

1 1
⎛P ⎞k M ⎛ PCRIT ⎞k
ρCRIT = ρ1 ⎜⎜ CRIT ⎟⎟ = P1 W ⎜⎜ ⎟⎟
⎝ P1 ⎠ RT1 ⎝ P1 ⎠ Eq. 3.3.3
Eliminating V2 we get the relationship between the critical pressure and the upstream
pressure as a function of k.

k
PCRIT ⎛ 2 ⎞k −1
=⎜ ⎟
P1 ⎝ k +1 ⎠ Eq. 3.3.4
Because most of the time relief valves operate in choked mode (sonic flow), most standards
insert this critical pressure ratio in Equation 3.2.8 Then, to cater for the cases when the flow
is subsonic, they re-introduce formula 3.2.8. In the program we operate in a slightly different
manner. The formula always remains the same (Eq. 3.2.8) but we calculate the critical
pressure, PCRIT based on equation 3.3.4. If P2 is less than PCRIT we use PCRIT in the
formula otherwise we use P2 and we have the advantage of having a single formula
covering both cases.

Note: The various relief valve standards still require the calculation of the Critical Pressure
Ratio.

Real Gases vs. Ideal Gases

Real gases do not quite behave according to equation 3.1.1 and a correction factor, Z, also
called compressibility factor, is introduced:

P R
=Z T
ρ M W Eq. 3.4.1
In practice nothing is changed except that T is replaced by ZT in all equations.

Z is best estimated by using either generalised compressibility charts or a 3rd order

Equation of State generalised formula such as Redlich-Kwong or Peng-Robinson.
Purists will argue that at least two Z values should be used, one at the generating state and
the other at the nozzle conditions, however the nozzle conditions at the critical pressure
ratio also happen to be a maximum mass flow condition. Being a maximum, a first order
deviation in pressure from the critical pressure induces a second order effect on the flow.
We can therefore ignore the effect of a small error on Z at the critical pressure.

A.2.3 Units
Mass flow units are kg/h.
Pressures are in kPa gauge. Atmospheric pressure is assumed to be 101.3 kPa absolute.
Temperatures are in °C, they are changed to Kelvins internally.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Areas are in mm2.

A.3 Flow Element Sizing

The flow orifice/Nozzle/venturi sizing software is based on the ISO standard:
ISO 5167 - Parts 1, 2, 3 and 4 - 2003
More precisely the equations and limits in part 2 are used for orifice plates,
The equations and limits in part 3 are used for nozzles and venturi nozzles,
The equations and limits in part 4 are used for Venturis.
The formulas are all based on Mass Flow Rate. This is one of the safest way of sizing flow
elements. The problem with people is they do not speak precisely enough when they speak
in “volumetric” terms and end up confusing themselves and everyone else. Speaking in
mass terms avoids confusion. (e.g. when told the flow is 1000 m3/h, one is left wondering if
the speaker means flow rate at the operating pressure and temperature, or is it flow rate
normalised to some base conditions and which base conditions are those, the Standard
base (14.7 PSI and 60 °F) or the Normal one (101.325 kPa and 0 °C)? The error is usually
small but not negligible if liquids are involved; it can be enormous in the case of gases).
The general equation from ISO5167 is:

C π
qm = ε d 2 2 ΔP ρ1
1− β4 4
Refer ISO5167 part 1 section 5.1

d
β=
However, since D and D is always known (Pipe ID) my own preference is to re-write
the ISO 5167 equation as:

1 π 2
qm = C ε D 2 ΔP ρ1
1 4
−1
β4

And in particular, when sizing a flow element, I find the expression of b as a function of the
other variables particularly useful:

1
β=
1
⎡
⎢1 +
(
C ε π D2 )
2
⎤4
ΔP ρ1 ⎥
⎢⎣ 8 q 2m ⎥⎦ Equation 1
This is the formula I use in preference to that suggested by ISO5167 for the iteration
procedure when calculating b. After each iteration, C is corrected (and for compressible
fluids e) and recalculate.
Continue at:
• Calculation Problems
• Pressure Loss
• Other Remarks

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A.3.1 Calculation Problems

Three types of problems arise:
• Sizing Problem
• Flow Calculation Problem
• DP Calculation Problem

Sizing Problem
This is the normal design function given a flow rate and a differential pressure; calculate the
b factor of the flow element that will satisfy the conditions.
Because often the designer wants a full scale differential pressure corresponding to a round
figure, it pays to allow a full scale flow rate and full scale DP to specified as well as
specifying a normal flow. In this case the first step is to calculate the normal differential
pressure.
2
⎛ FLOWnormal ⎞
DPnormal = DPmax ⎜⎜ ⎟⎟
⎝ FLOWmax ⎠
If the designer enters a Full scale flow rate and full scale DP without specifying a normal
2
flow rate, then a normal flow rate of 2 the full scale flow rate is applied as a reasonable
estimate of what the expected normal flow will be.
Then using this value for the normal differential pressure and the normal flow, the design
proceeds by iteration until sufficient precision is achieved:
First assume C = 0.6, e= 1.0
Step 1 calculate b using Equation 1
Step 2 using the calculated b, calculate C
Step 3 using b calculate e (in the case of compressible fluid only)
Go back to step 1 and continue looping until convergence has been achieved.
Once b has been calculated, the actual maximum flow at the full scale differential pressure
is back calculated and displayed (this shows the difference between the nominal maximum
flow originally specified and the actual maximum flow). Similarly if a minimum flow had been
nominated, then the DP at the minimum flow is also calculated.
The b calculation is ALWAYS done for normal flow.

Flow Calculation Problem

This situation arises when an orifice is in use (so b is known) and a differential pressure
reading exists and someone needs to know what the flow is.
Normally the data is simply entered in the normal flow column and the calculation is carried
out. If the normal flow conditions are not filled in, the system tries to guess the normal
conditions from the data given.
The calculation proceeds as follows:
First we assume C = 0.6, e = 1.0

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Step 1 we calculate the flow

Step 2 we calculate the Reynolds number
Step 3 we calculate C
Step 4 we calculate e
Return to step 1 and iterate until convergence is achieved.

DP Calculation Problem
This calculation is required if an existing flow element is in service but an increase in
throughput is required. New full scale and normal flows are usually nominated and the
transmitter needs to be re-ranged. b is known.

2
If only the full scale flow rate is given, then the normal flow is assumed as 2 the
maximum flow rate.
The calculation proceeds as follows:
Since flow and b are known, the Reynolds number and C are calculated. We assume
e= 1.0
Step 1 The differential pressure is calculated with pdrop
Step 2 e is calculated (only necessary for compressible fluids)
Return to step 1 and iterate until convergence is achieved.
The calculation is carried out for all the flows nominated.

A.3.2 Pressure Loss

An additional function estimates the permanent pressure losses. ISO5167 is rather vague
for venturis or venturi-nozzles saying the permanent loss is between 5 and 20% of the
measurement differential pressure. For a reasonably conservative estimate use 15%.
For orifice plates and other nozzles, the formula in section 5.4.1 of part 2 (or 5.1.8 in part 3)
of ISO5167-2003 is used. This estimates the permanent pressure loss caused by the flow
element. Since this is often used to estimate the operating cost due to energy loss, the loss
should be calculated for the normal flow rate rather than the full scale.

A.3.3 Other Remarks

ISO5167 defines b as the d/D ratio (bore diameter to pipe ID ratio) at the flowing conditions,
therefore in particular it means at the operating temperature. This is the way b is reported by
the software.
The calculation first calculated D by applying the thermal expansion to the pipe nominal
diameter for the normal operating temperature, then either b is applied or calculated and d,
the diameter of the bore at operating temperature is calculated. Finally the thermal
expansion of the plate is calculated to determine d0, the bore diameter at ambient conditions
(assumed to be 18 °C).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A.4 Thermowell Vibrations

Thermowells have been known to fail due to being excited by periodic forces caused by the
flowing medium which have a frequency close to the resonance frequency of the
thermowell.
Here we seek a formula that gives the natural frequency of the 1st mode of vibration of a
tapered thermowell.
See the figure below for dimensions.

Continue at:
• Tapered Thermowells Natural Frequency
• Analysis of a Cylindrical (Parallel) Thermowell (or Sample Quill)
• Order of Accuracy

A.4.1 Tapered Thermowells Natural Frequency

It is also possible to calculate approximately the natural resonant frequency of a tapered
thermowell based on the Rayleigh method which consists of assuming a deflected shape for
the thermowell which is reasonable (i.e. consistent with the boundary conditions) then
calculating the potential energy at maximum deflection (velocity everywhere equal to 0) and
the maximum kinetic energy (deflection everywhere equal to 0) and equalling the two since
by the principle of conservation of energy, the sum potential + kinetic = constant.
Notation:
k = D2/D1

d = D0/D1.
E = Young’s Modulus (2. 1011 Pa for steel and stainless steel).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

r = Density of the material (7800 kg/m3 for steel).

L, D0, D1, D2 are in millimetres
The stiffness is a function of the inertia of the cross section. Because the cross section
varies along the length, so does the inertia (2nd moment of area). The inertia is nominated
as I(x) where x is the distance measured from the inner face of the flange (or end of the
thread for screwed thermowells).

I (x ) =
(
π D (4x ) − D 04 )
64 Eq. 2.1

where D(x) is the diameter at x.

⎡ x ⎤
D ( x ) = D1 ⎢1 − (1 − k )⎥
⎣ L ⎦ Eq. 2.2
hence we get for I(x):

πD14 ⎡⎛ x ⎞
4
⎤
⎢⎜1 − (1 − k )⎟ − δ ⎥
4
I (x ) =
64 ⎣⎢⎝ L ⎠ ⎦⎥ Eq. 2.3
The simplest deflected shape which we can use is:

⎡x4 x3 x2 ⎤
y ( x,t ) = λ ⎢ 4 − 4 3 + 6 2 ⎥ sin (ωt )
⎣L L L ⎦
Eq. 2.4
as it is consistent with the cantilevered condition at x = 0 & x=L since it is the deflected
shape of a cantilever of uniform section subjected to a uniform load (l is an arbitrary
constant).

∂y ⎡x4 x3 x2 ⎤
= ωλ ⎢ 4 − 4 3 + 6 2 ⎥ cos(ωt )
∂t ⎣L L L ⎦
The instantaneous speed is: Eq. 2.5
the maximum kinetic energy occurs when cos(wt)=1 and is given by:

1 ⎡
L
U k = ∫ ⎢ ρπ
(
D (2x ) − D 02 )⎤⎛ ∂y ⎞ 2

⎥⎜ ⎟ dx
2 0 ⎢⎣ 4 ⎥⎦⎝ ∂t ⎠ MAX Eq.2.6
or:

πρλ 2 ω 2 ⎡ 2 x2 ⎞ ⎤
2
L
⎛ x4 x3
Uk =
8 ∫ (
⎢ D ( x ) − D 02 )
⎜⎜ 4 − 4 3 + 6 2 ⎟⎟ ⎥ dx
0⎢⎣ ⎝L L L ⎠ ⎥
⎦ Eq. 2.7

πω 2 λ 2ρL D12
Uk =
27720
[
5353 k 2 + 2142 k + 513 − 8008δ 2 ]
Eq. 2.8
The internal energy in the thermowell at maximum deflection is:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

1 ⎡ M (x ) ⎤
L 2

2 ∫0 ⎢⎣ E I ( x ) ⎥⎦
Ui = ⎢ ⎥ dx
Eq. 2.9
where M(x) is the bending moment at x.
The bending moment, M(x), is a function of the stiffness and curvature of the deflected
thermowell:

∂2y
M (x ) = E I (x )
∂x 2 Eq. 2.10
Since we assumed the shape, we have:

⎡∂2y⎤ 12 λ ⎛ x 2 x ⎞
⎢ 2⎥ = ⎜
2 ⎜ 2
− 2 + 1⎟⎟
⎣ ∂x ⎦ MAX L ⎝L L ⎠
Eq. 2.11
We get for the internal energy:

144 λ 2 E ⎡ ⎛ x 2 ⎞ ⎤
L 2
x
2 L4 ∫0 ⎢ ⎜⎝ L2
Ui = ⎢I ( x ) ⎜ ⎟
− 2 + 1⎟ ⎥dx
L ⎠ ⎥
⎣ ⎦ Eq. 2.12
Replacing I(x) by its expression in equation 2.3 and integrating we finally obtain:

λ 2 Eππ 14 4
Ui =
560L 3
[
k + 5 k 3 +15 k 2 + 35 K + 70 − 126 δ 4 ]
Eq. 2.13
and finally we get by equating Ui and Uk since according to the principle of conservation of
energy, when the kinetic energy is maximum, the potential (internal) energy is zero and vice-
versa.

299 E D12 ⎡ k 4 + 5 k 3 + 15 k 2 + 35 k + 70 − 126δ 4 ⎤

ω = ⎢ ⎥
2 L4 ρ ⎣ 5353 k 2 + 2142 k + 513 − 8008δ 2 ⎦
Eq. 2.14
The natural frequency is to a close approximation:

ω D E ⎡ k 4 + 5 k 3 +15 k 2 + 35 k + 70 − 126δ 4 ⎤
fn = = 1.1197 21 ⎢ ⎥
2π L ρ ⎣ 5353 k 2 + 2142k + 513 − 8008δ 2 ⎦
Eq. 2.15

A.4.2 Analysis of a Cylindrical (Parallel) Thermowell (or Sample Quill)

It is relatively easy to work out exactly, the fundamental natural resonance of a cantilevered
cylinder with a concentric bore. (i.e. parallel thermowell).
The moment of inertia of the thermowell is everywhere the same and equal to:

I=
(
π D4 − d4 )
64 Eq. 3.1 where D is the outside diameter, and d the bore diameter.
The cross section is:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A=
(
π D2 − d 2 )
4 Eq. 3.2
The general motion of a beam of uniform cross section in free motion is:

∂4y ∂2y
EI + ρA =0
∂x 4 ∂t 2 Eq. 3.3
Where y is the deflection of the beam (as a function of x and t).
Because we are looking at a single harmonic function, y(x,t) can be written as:
y(x,t) = y(x) cos(wt) where w = 2 p fn (fn = natural frequency)
The equation to be solved is now:

d4y ω2
− ρ A y= 0
dx 4 EI Eq. 3.4

ρAω 2
z4 =
If we call
EI
The generalised solution of the y(x) equation is:

y = A1sinh (z x )+ A 2 cosh (z x )+ A 3sin (z x )+ A 4 cos(z x ) Eq. 3.5

Where the A’s are constants which depend only on the boundary conditions.
In the case of the thermowell, we have certain boundary conditions to satisfy:
1. at x = 0 y is always 0 as the thermowell at this point is fixed

this implies A 2 = −A 4 Eq. 3.6

2. at x = 0, the slope is always 0 (dy/dx = 0) as the thermowell is not free to rotate

this implies
A1 = − A 3 Eq. 3.7
2
∂ y
2= 0
3. at x = L, the bending moment is always 0 hence ∂ x ,
this implies, taking into account the relations obtained at 1) and 2):

A 2 = − A1
[sinh (z L ) + sin (z L )]
[cosh(z L ) + cos(z L )] Eq. 3.8
∂3y
3
=0
4. at x = L, the shear force is also always 0 hence ∂x , taking into account all
previous relations we finally get:

A1
[1 + cos(z L )cosh(z L )] = 0
[cos(z L ) + cosh (z L )] Eq. 3.9
For this to be true regardless of A1 is we must have

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

1+ cos(z L )cosh (z L ) = 0 Eq. 3.10

An infinity of values satisfy this equation, but the lowest value is:
zL = 1.875104

3.516015 E I
ω=
L2 ρA
This corresponds to or in frequency:

0.55959 E I
fn =
L2 ρA Eq. 3.11

d
δ=
If we define D we can write I and A as functions of D and d:

πD 4
I=
64
(
1− δ4 )
πD 2
A=
4
(
1 − δ2 )
And the frequency formula becomes:

fn =
0.139898 D E 1+ δ 2 ( )
L2 ρ Eq. 3.12
This formula is exact for parallel thermowells:

In metric units, E is in Pa, L and D in metres, r is in kg/m3, fn is in Hz.

A.4.3 Order of Accuracy

Because the formula for the parallel thermowell is exact we can use it to check the order of
accuracy of the tapered thermowell since by making k equal to 1, the tapered thermowell
becomes a parallel thermowell.
Let's take the following dimensions:
L = 300 mm
D1 = 25 mm
D2 = 25 mm
E = 200000 MPa = Pa (Typical value for steel)
r = 7800 kg/m3 (Typical value for steel)
We choose two bore diameters:
1. Do = 6.5 mm

d = 0.26

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

k = 1.0

Parallel Thermowell Fn: 203.3 Hz

Tapered Thermowell Fn: 204.1 Hz
2. Do = 19 mm

d = 0.76
k = 1.0

Parallel Thermowell Fn: 247.2 Hz

Tapered Thermowell Fn: 248.1 Hz
We see that in both cases the tapered thermowell approximate formula, when applied to a
parallel thermowell, gives a natural frequency only 0.3% higher than the exact value. This
gives us an estimate of the order of accuracy of the formula.

A.5 Gas Compressibility Factor

Refer to:
• Compressibility Factor by Redlich-Kwong Equation of State
• Equation of State
• Redlich-Kwong EoS
• Expression of Z as a Function of Reduced Pressure and Reduced Temperature
• Solving Equation 4.2.4

A.5.1 Compressibility Factor by Redlich-Kwong Equation of State

The Gas Compressibility Factor describes a method of estimating the deviation from ideal of
a gas. The Redlich Kwong EOS is particularly convenient since it involves only two
parameters and its results are reasonably good for a large variety of gases.

A.5.2 Equation of State

Perfect Gases
P R
= T
ρ M W Eq. 2.1.1
Where:
P is the absolute pressure in kPa

r is the density in kg/m3

R is the universal gas constant = 8.314 kJ/kmole.K
Mw is the molecular weight of the gas (kg/kmole)
T is the absolute temperature K

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

Real Gases
Real gases follow the ideal gas law closely. A factor, Z, called compressibility factor, is often
introduced to show the deviation from ideal behaviour. Z = 1.0 means the gas is behaving
like an ideal gas.

P R
=Z T
ρ M W Eq. 2.2.1

A.5.3 Redlich-Kwong EoS

The data I have on the Redlich-Kwong Equation of State comes from Perry’s Chemical
Engineer’s Handbook. 1999
The starting equations are:

R
T
MW aT
P= −
1 1⎛1 ⎞
−b ⎜⎜ + b ⎟⎟
ρ ρ⎝ρ ⎠ Perry’s Eq. 4-220
With for a single component gas:
2
⎛ R ⎞ 2.5
0.42748 ⎜⎜ ⎟⎟ TC
a= ⎝ MW ⎠
PC Perry’s Eq. 4-223
and:

R
0.08664 TC
MW
b=
PC Perry’s Eq. 4-224
Expressing it for Z, Perry’s give:

⎛ ⎞
⎜ ⎟
Z=
1
− ⎜ a ⎟⎛⎜ h ⎞⎟
1− h ⎜ R 1.5 ⎟⎝ 1+ h ⎠
⎜b T ⎟
⎝ MW ⎠ Perry’s Eq. 4-225
with:

bP
h=
R
Z T
M W Perry’s Eq. 4-227
In those equations, Pc is the critical pressure and TC is the critical temperature.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

A.5.4 Expression of Z as a Function of Reduced Pressure and Reduced

Temperature

Reduced Variables
P
PR =
PC Reduced Pressure Eq. 4.1.1

T
TR =
TC Reduced temperature Eq. 4.1.2

Perry's Z Equation with Reduced Variables

Replacing P, T, Pc and Tc by PR and TR everywhere in Perry’s equations 4-225 and 4-227
and eliminating a and b we get

⎛ ⎞
⎜ ⎟
1 ⎛ 0.42748 ⎞⎜ 1 ⎟
Z= − ⎜⎜ ⎟
1.5 ⎟⎜ ⎟
0.08664 ⎛ PR ⎞ ⎝ 0.08664 TR ⎠⎜ 1+ Z ⎛ TR ⎞⎟
1− ⎜ ⎟⎟ ⎜ ⎟⎟
Z ⎜⎝ TR ⎠
⎜ 0.08664 ⎜ P
⎝ ⎝ R
⎟
⎠ ⎠ Eq. 4.2.1
or:

⎡ ⎤ ⎡ ⎛ PR ⎞⎤
⎢ ⎥ ⎢ ⎜ ⎟⎥
Z= ⎢
Z ⎥ − ⎢⎛⎜ 0.42748 ⎞⎟⎜ TR ⎟⎥
⎢ ⎜ ⎟⎜ ⎟
⎢ ⎛P ⎞ ⎥ TR1.5
⎠⎜ Z + 0.08664⎛⎜ PR ⎞ ⎟⎥
⎢ Z − 0.08664⎜⎜ R ⎟⎟ ⎥ ⎢⎝ ⎜T ⎟⎟ ⎥
⎜ ⎟
⎣⎢ ⎝ TR ⎠ ⎦⎥ ⎢⎣ ⎝ ⎝ R ⎠ ⎠⎥⎦ Eq 4.2.2
Or, when placing the right hand side over a common denominator:

⎛ P ⎞ ⎛ PR ⎞⎛ P ⎞
Z⎜⎜ Z + 0.08664 R ⎟⎟ − ⎜⎜ 0.42748 2.5 ⎟⎟⎜⎜ Z − 0.08664 R ⎟⎟
TR TR ⎠⎝ TR
Z= ⎝ ⎠ ⎝
2
⎠
⎛ P ⎞
Z 2 − ⎜⎜ 0.08664 R ⎟⎟
⎝ TR ⎠
Eq. 4.2.3
And passing the denominator to the left hand side:
2
⎛ P ⎞ ⎛ P PR ⎞ 0.08664 × 0.42748PR2
Z − ⎜⎜ 0.08664 R
3
⎟⎟ Z = Z 2 + Z⎜⎜ 0.08664 R − 0.42748 2.5 ⎟+
⎝ TR ⎠ ⎝ TR TR ⎟⎠ TR3.5

Passing all terms to the left hand side we get:

Z 3 − Z 2 + R 1 Z − R 2 = 0 Eq. 4.2.4
with:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
Instrument Sizing Calculations

2
PR ⎛ P ⎞ P
R 1 = 0.42748 2.5 − ⎜⎜ 0.08664 R ⎟⎟ − 0.08664 R
TR ⎝ TR ⎠ TR
Eq 4.2.5
and:

0.08664 × 0.42748 PR2

R2 =
TR3.5 Eq. 4.2.6

A.5.5 Solving Equation 4.2.4

To solve equation 4.2.4 we use a Newton approximation iterative method.

Y = Z 3 − Z 2 + R 1 Z − R 2 Eq. 5.1

dY
= 3 Z2 − 2 Z + R1
dZ Eq 5.2
The iterative method consists of picking a first guess for Z (1.0 is a good start) then we
calculate Y using equation 5.1 and dY/dZ with equation 5.2. We then make a correction to Z
such as:

Y
Cor = −
dY
dZ Eq. 5.3
And the new Z is calculated as previous Z + Cor.
The iterations continue until Cor becomes small enough in absolute value.

Note that a 3rd degree equation can have three real roots. Perry’s states that for T >Tc only
one root exists but for T < Tc at certain pressures, up to 3 positive roots can exist and for the
vapour state the largest should be used.
My experience is that starting from Z = 1.0, for all reasonably realistic pressures/
temperatures the convergence is to the gas phase Z.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

B AVEVA NET Export Configuration Files

Following configuration files will be used by the AVEVA Schematic Gateway to process the
data exported from AVEVA Instrumentation:
• Project Configuration
• Object Mapping
• Classes Mapping
• Presentation Mapping
All these configuration files are of XML format and are best edited in XML editor, but
notepad or any text editor can also be used. It is recommended for the user to have one
configuration file of each type mentioned above per element to be exported to AVEVA NET.
All these configuration files are provided as input to the Gateway. Elements and attributes of
these configuration files are detailed out in subsequent sections below.

B.1 Project Configuration

Refer to:
• High level Structure of the Project Configuration File
• Elements and Attributes

B.1.1 High level Structure of the Project Configuration File

<?xml version="1.0" encoding="utf-8"?>
<ConfigurationSettings>
<TemplateID> … </TemplateID>
<OutputFile>
<Directory> … </Directory>
</OutputFile>
<KeepUnmappedAttributes> … </KeepUnmappedAttributes>
<Mapping>
<ID> … </ID>
<Context> … </Context>
<ClassID> … </ClassID>
<Name> … </Name>
<Association>
<TargetID> … </TargetID>
<TargetRevision> … </TargetRevision>
<TargetClassID> … </TargetClassID>
<TargetContext> … </TargetContext>
<TargetName> … </TargetName>
</Association>
</Mapping>
<InputFiles>

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

<Files>
<Extension> … </Extension>
<ExcelRanges> … </ExcelRanges>
<ExcelAddHotspotting> … </ExcelAddHotspotting>
<TagsNamedRange> … </TagsNamedRange>
</Files>
<RegularExpression>
<Search> … </Search>
</RegularExpression>
</InputFiles>
</ConfigurationSettings>

B.1.2 Elements and Attributes

ConfigurationSettings
This is the root element for all Project Configurations and contains following sub-elements.
There would be only one ConfigurationSettings element allowed in the Project Configuration
XML.

TemplateID
Each EIWM output file should have a template Id that must be unique to that file for the
project. The "TemplateID" is typically based on the output file name. "TemplateID" is an
optional element.
The "TemplateID" can be specified in a number of ways:
• Fixed "TemplateID" specified:
All file(s) produced based on the configuration file will have the Template ID specified.
This should not be used if multiple files are being produced.
e.g <TemplateID>C:\Staging\Instruments_null.XML</TemplateID>
• Root "TemplateID" specified:
The Template ID in the output file will be the full output file name with the string
specified removed from its start.
e.g. <TemplateID Root="true">C:\</TemplateID>
In this example, if the full output file name is "c:\Staging\Instruments_null.xml", then the
output would be "Staging\Instruments_null.xml".
• No "TemplateID" specified.
If no "TemplateID" is specified then the full file name (incl. path) of the output file will be
used for the Template ID.
"TemplateID" supports following Attributes:
Root: As mentioned in the example above, this attribute is used to remove the specified
path from the start of the full output file path.

OutputFile
AVEVA Schematic Gateway will generate an XML output in EIWM format that can be
imported into AVEVA NET using AVEVA NET Import Controller. Although the output for the
entire DataSet can be generated into a single EIWM file, sometimes its desirable to split the
output into multiple EIWM files to facilitate easy import of data into AVEVA NET. This is
because AVEVA NET can handle small EIWM files more effectively as compared to large
EIWM files. "OutputFile" is a mandatory element.
"OutputFile" element supports following attributes:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

File: This attribute allows user to specify the name of the Output File. It's a mandatory
attribute.
e.g. <OutputFile File="Instruments_null.XML"/>
DeleteExisting: "DeleteExisting" can have "true" and "false" as valid values. Setting
"DeleteExisting" to "true" deletes all the contents of the staging area before proceeding with
execution of the export functionality of the Gateway. This is an optional attribute and default
value of this attribute would be "false".
"OutputFile" can have following sub-elements:

Directory
In order to break the output into multiple EIWM files, an element "Directory" can be used.
This is an optional element, but if used, it can occur many times under "OutputFile" element.
e.g.<Directory>AreaNo</Directory>
In above example, a sub-directory for each AreaNo will be created under Staging Area
("AreaNo" would be the exact column name in the DataSet) and each sub-directory would
contain EIWM file/s corresponding to the specific AreaNo.
<Directory>AreaNo</Directory>
<Directory>TagNo</Directory>
Above example will result into sub-directory under Staging Area for each unique AreaNo
and then further sub-directories under each "AreaNo" specific directory per "TagNo" (again
"AreaNo" and "TagNo" should be the exact column names in the DataSet).
"Directory" element supports following attributes:
SearchExpression: This attribute allows user to provide an expression to generate the
name of the directory. This is an optional attribute.
e.g. <Directory SearchExpression="substring(TagNo, 1, 4)"/>
Above example will result into sub-directories with unique strings of first 4 characters of the
available "TagNo"s. ("TagNo" should be the exact column name in the DataSet).

KeepUnmappedAttributes
This element defines how to handle attributes of the entity not defined in Attributes Mapping
configuration. This element can have "true" and "false" as valid values. If it is set to "true",
then all unmapped attributes of the entity will be exported as characteristics. This is an
optional element and its default value will be "false" if not defined explicitly.
e.g. <KeepUnmappedAttributes>true</KeepUnmappedAttributes>

Mapping
The mapping section is where configuration gets down to mapping rows/nodes from the
DataSet to AVEVA NET objects. Each configuration file can have one or more mapping
sections but most of the cases, there would be need of at the most only one mapping
section. In case of multiple mapping sections each mapping section will be applied to each
entity (row or node) in the DataSet in turn.
Object mappings will create object instances for AVEVA NET. The format of the mapping for
the high level object data (identity, class…) will resemble:
<Mapping Type="Object" Condition="" UseIdForFileNames="false">
<ID ApplyBehaviour="concat(ID, TagNo, ' Instrument')"/>

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

<Context Value="PROJECTCONTEXT"/>
<ClassID From="Description"/>
<Name From="Description" Default="N/A" RegExPattern="[A-Z]{3}"
RegExRemovePattern="\s"/>
</Mapping>
Various AVEVA NET Properties that can be mapped here are:
• ID
• Context
• ClassID
• Name
All these properties can be specified under mapping section as separate sub-elements. As
mentioned above, these elements support following attributes:
Value: Hard coded string that will be used as the value of the property in the output.
ApplyBehaviour: Perform some processing on DataSet value(s) to determine the output.
The setting for the ApplyBehaviour can be any XPath 1.0 functions.
From: DataSet column (or node) name from which value should be read.
Default: A default value that will be used if no value is found in the DataSet. If no value is
found in the DataSet for a mapped property then that will not be included in the output file
unless a default for it is defined - if no value to be written, specify default="".
RegExPattern: Specified regular expression pattern will be applied to the property value
and the matched sub-string to the pattern will be the output value.
RegExRemovePattern: A regular expression pattern to identify part of the value to be
removed. E.g. This could be used to remove spaces or dashes from a value.

Note: Out of "From", "Value" or "ApplyBehaviour" which define how the value for the
property should be determined, one and only one of these three should be specified.
In case user specifies more than one attributes out of these three, then preference
will be given in following sequence > Value, ApplyBehaviour, From.

"Mapping" supports following attributes:

Type: The only supported type at the moment is "Object". Specifying Type="Object" will
treat the element as an object in AVEVA NET.
Condition: "Condition" helps to filter items in a DataSet or to treat items with some common
property differently.
e.g. <Mapping Type="Object" Condition="Class='Junction Box' and
Manufacturer!='ACME'">
In this case the mapping will only be applied (and therefore output data generated for) to
those items where the 'Class' column does and 'Manufacturer' column does not match the
values listed. Any number of and/or statements can be combined to provide the desired
logic (use lower case for 'and' and 'or').
UseIdForFileNames: This element has "true" and "false" as valid values. If the user
chooses to generate multiple output files - one per object, then setting this attribute to "true"
will generate the names of these output files by appending the Id at the beginning of the file
name specified in "OutputFile" element.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

Association
An Association is a link between two Objects that can be followed from one Object to
another and there is no limit to the number of Associations an Object may have. This is an
optional element.
Association supports the following sub-elements:
TargetClassID: This element specifies the Class ID of the target object with which the
object has the association.
TargetContext: This element specifies the namespace of the target object.
TargetClassID: This element specifies the Class ID of the target object with which the
object has the association.
TargetContext: This element specifies the namespace of the target object.
TargetName: This element specifies the name assigned to the target object.
All these sub-elements support "From", "Value" and "ApplyBehaviour" attributes, but one at
a time one and only one out of these three should be specified. Usage of these attributes
will be exactly same as mentioned above in "Mapping" section.
"Association" supports following attribute:
Type: This attribute specifies the type of relationship between the object and the target
object. The relationship mentioned here should be supported by AVEVA NET for example:
<Association Type="is classified as">
<TargetID From="TagNo"/>
<TargetRevision Value="1.2"/>
<TargetClassID From="Description"/>
<TargetContext Value="NewNamespace"/>
<TargetName Value="Instrument"/>
</Association>

InputFiles
This element gives us information about how to process the input files of different types (e.g.
xls, xlsx, pdf). "InputFiles" is not mandatory and can be ignored if there are no input files to
be processed.
AVEVA Schematic Gateway accepts "input file location" as well as list of files to be
processed as an input. When no input file names are provided to the Gateway, it will
process all the files present in the Input location.
"InputFiles" support following attribute:
IncludeSubFolders: If IncludeSubFolder is set as "true", Gateway will search the
subfolders of the Input location too. This attribute will carry no meaning if list of files to be
processed is provided to the Gateway.
InputFiles supports following sub-elements:

Files
This Element provides the gateway, information about the different types of file extensions
that are processed by it, for example:
<Files>

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

<Extension>xlsx</Extension>
<ExcelAddHotspotting>true</ExcelAddHotspotting>
<ExcelRanges>true</ExcelRanges>
<TagsNamedRange>VNETTags,TagNo</TagsNamedRange>
</Files>
Files supports following sub-elements:
Extension: This specifies the extension of the files unique to the current "Files" element for
which rest of the elements in the "Files" block are applicable to. Valid values are: xls, xlsx,
pdf.
e.g., <Extension>xls</Extension>
ExcelRanges: This element has "true" and "false" as valid values. If this is set to "true", the
gateway will hotspot the output file with the specified ranges in the excel spreadsheet. This
element works in conjunction with "TagsNamedRange" and only the ranges specified in
"TagsNamedRange" will be hot-spotted.
If this element is "false", then the Gateway will hotspot the values which match the search
patterns mentioned in RegularExpression.
This element will be ignored if "ExcelAddHotspotting" is set to "false". Moreover this element
is applicable only if "Extension specified is either "xls" or "xlsx". For other extensions this
element will be ignored. Default value of this element, if not set, will be "false".
ExcelAddHotspotting: If this is set to "true", then hot-spotting would be performed on the
output MHTML file. This element is optional and is expected to be set only if "extension" is
"xls" or "xlsx". Default value of this element, if not set, will be "false".
TagsNamedRange: If "ExcelRanges" is set to "true", then the gateway will hot-spot the
Ranges mentioned in this element.
e.g., <TagsNamedRange>VNETTags,TagNo</TagsNamedRange>
This element is optional and is expected to be set only if "extension" is "xls" or "xlsx". Default
value of this element, if not set, will be "". Multiple ranges can be specified as a comma
separated string.

RegularExpression
If "ExcelRanges" element is set to "false", the Gateway would choose the Regular
expression search patterns for hot-spotting. This element is optional.
RegularExpression supports following sub-elements:
Search: The regular expressions specified in this element would be matched to the text in
the input file and the cell containing the matching text would be hot-spotted.
e.g., <Search>[A-Z]{3}</Search>
If the above search pattern is provided in the Project Configuration and if the datasheet has
a cell with value "ABCD123", then that cell would be hot-spotted.
RegularExpression can have as many "Search" expressions as want but there has to be at
least one "Search" element under it.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

B.2 Object Mapping

Attributes mapping configuration file helps in mapping attributes of the source entity to its
corresponding characteristics in the output file.
Continue at:
• High Level Structure of the Objects Mapping File
• Elements and Attributes

B.2.1 High Level Structure of the Objects Mapping File

<?xml version="1.0" encoding="utf-8"?>
<Attributes>
<Attribute> … </Attribute>
</Attributes>

B.2.2 Elements and Attributes

Attributes
This is the root element in the Attributes Mapping file. It contains multiple instances of the
sub-element "Attribute". There can be only one instance of the "Attributes" element.
Attribute:
"Attributes" element can contain multiple instances of this element. It specifies the attribute
in the input dataset which is to be mapped into another attribute in the output file. It can also
specify if an attribute should be present in the output file or not.
Following are the attributes supported by this element:
From: The value for the new attribute would be taken from the column specified in this
attribute from the DataSet. It is mandatory to have the attribute mentioned here be available
in the DataSet as a column.
e.g., <Attribute From="TagNo" To="Tag Number" Output="true"/>
In the above example, in the output file there would be a characteristic as follows:
<Characteristic>
<Name>Tag Number</Name>
<Value>00-AE-123ab</Value>
</Characteristic>
Value: Hard coded string that will be used as the value of the characteristic.
ApplyBehaviour: Perform some processing on DataSet value(s) to determine the value of
the characteristic.

Note: Out of "From", "Value" or "ApplyBehaviour" which define how the value for the
attribute should be determined, one and only one of these three should be specified.
In case user specifies more than one attributes out of these three, then preference
will be given in following sequence >Value, ApplyBehaviour, From.

To: This attribute provides the name of the new characteristic. This is mandatory attribute.
Default: A default value that will be used if no value is found in the DataSet.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

RegExPattern: : Specified regular expression pattern will be applied to the attribute's value
and the matched sub-string to the pattern will be the output value for the characteristic.
RegExRemovePattern: A regular expression pattern to identify part of the value to be
removed. E.g. This could be used to remove spaces or dashes from a value.
Output: This attribute can have "true" and "false" as valid values. If it is "true", the output file
would contain the corresponding attribute. If it is "false", the attribute would not be present in
the output file.
If the value of attribute 'Output' is "true", then one of the following attributes must be present:
"Value", "From" or "ApplyBehaviour".

B.3 Classes Mapping

Classes Mapping specifies the ClassID of a particular object in the Source Namespace and
its corresponding ClassID in the Target Namespace, so that while exporting the object can
be mapped to the Target Namespace.
Continue:
• High Level Structure of the Classes Mapping File
• Elements and Attributes

B.3.1 High Level Structure of the Classes Mapping File

<?xml version="1.0" encoding="utf-8"?>
<Classes>
<Class> … </Class>
</Classes>

B.3.2 Elements and Attributes

Classes
This is the root element in the Classes Mapping file. It contains multiple instances of the
sub-element "Class". There can be only one instance of the "Classes" element.

Class:
Every "Classes" element can contain multiple instances of this element. It specifies the
Class mappings between the ClassIDs in the input system and output file.
e.g., <Class From="PUMP" To="INSTRUMENT"/>
Following are the attributes of the element 'Class':
From: The ClassID of the current object which is to be mapped.
To: The ClassID of the object in the Target Namespace.

B.4 Presentation Mapping

Presentation Mapping is used to map the AutoCAD colours used in a source drawing to a
new colour in the graphical output file.
Continue:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

• High Level Structure of the Presentation Mapping File

• Elements and Attributes

B.4.1 High Level Structure of the Presentation Mapping File

<?xml version="1.0" encoding="utf-8"?>
<presentation>
<colours> … </colours>
</presentation>

B.4.2 Elements and Attributes

Presentation
This is the root element in the Presentation Mapping file. It contains a single instance of the
sub-element "Colours". There can be only one instance of the "Presentation" element.

Colours:
The “Colours” element contains multiple instances of the sub-element "Colour". There can
be only one instance of the "Colours" element.

Colour:
Every "Colours" element can contain multiple instances of this element. It specifies the
colour mappings between the colours in the input and output files.
For example:
<colours>
<colour>
<from index="6"/>
<to R="255" G="0" B="255"/>
</colour>
<colour>
<from index="5"/>
<to name="Blue"/>
</colour>
</colours>
From: Must be a valid AutoCAD colour index (0-256).
To: Either a a valid colour name or an RGB value (see below).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

Valid Colour Names and RGB Values

Listed below are the names and RGB values for colours which are valid for colour mapping
in Presentation mapping files:

antiquewhite 250,235,215
aqua 0,255,255
aquamarine 127,255,212
azure 240,255,255
beige 245,245,220
bisque 255,228,196
black 0,0,0
blanchedalmond 255,235,205
blue 0,0,255
blueviolet 138,43,226
brown 165,42,42
burlywood 222,184,135
cadetblue 95,158,160
chartreuse 127,255,0
chocolate 210,105,30
coral 255,127,80
cornflowerblue 100,149,237
cornsilk 255,248,220
crimson 220,20,60
cyan 0,255,255
darkblue 0,0,139
darkcyan 0,139,139
darkgoldenrod 184,134,11
darkgray 169,169,169
darkgreen 0,100,0
darkgrey 169,169,169
darkkhaki 189,183,107
darkmagenta 139,0,139
darkolivegreen 85,107,47
darkorange 255,140,0
darkorchid 153,50,204

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

darkred 139,0,0
darksalmon 233,150,122
darkseagreen 143,188,143
darkslateblue 72,61,139
darkslategray 47,79,79
darkslategrey 47,79,79
darkturquoise 0,206,209
darkviolet 148,0,211
deeppink 255,20,147
deepskyblue 0,191,255
dimgray 105,105,105
dimgrey 105,105,105
dodgerblue 30,144,255
firebrick 178,34,34
floralwhite 255,250,240
forestgreen 34,139,34
fuchsia 255,0,255
gainsboro 220,220,220
ghostwhite 248,248,255
gold 255,215,0
goldenrod 218,165,32
gray 128,128,128
green 0,128,0
greenyellow 173,255,47
grey 128,128,128
honeydew 240,255,240
hotpink 255,105,180
indianred 205,92,92
indigo 75,0,130
ivory 255,255,240
khaki 240,230,140
lavender 230,230,250
lavenderblush 255,240,245
lawngreen 124,252,0

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

lemonchiffon 255,250,205
lightblue 173,216,230
lightcoral 240,128,128
lightcyan 224,255,255
lightgoldenrodyellow 250,250,210
lightgray 211,211,211
lightgreen 144,238,144
lightgrey 211,211,211
lightpink 255,182,193
lightsalmon 255,160,122
lightseagreen 32,178,170
lightskyblue 135,206,250
lightslategray 119,136,153
lightslategrey 119,136,153
lightsteelblue 176,196,222
lightyellow 255,255,224
lime 0,255,0
limegreen 50,205,50
linen 250,240,230
magenta 255,0,255
maroon 128,0,0
mediumaquamarine 102,205,170
mediumblue 0,0,205
mediumorchid 186,85,211
mediumpurple 147,112,219
mediumseagreen 60,179,113
mediumslateblue 123,104,238
mediumspringgreen 0,250,154
mediumturquoise 72,209,204
mediumvioletred 199,21,133
midnightblue 25,25,112
mintcream 245,255,250
mistyrose 255,228,225
moccasin 255,228,181

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

navajowhite 255,222,173
navy 0,0,128
oldlace 253,245,230
olive 128,128,0
olivedrab 107,142,35
orange 255,165,0
orangered 255,69,0
orchid 218,112,214
palegoldenrod 238,232,170
palegreen 152,251,152
paleturquoise 175,238,238
palevioletred 219,112,147
papayawhip 255,239,213
peachpuff 255,218,185
peru 205,133,63
pink 255,192,203
plum 221,160,221
powderblue 176,224,230
purple 128,0,128
red 255,0,0
rosybrown 188,143,143
royalblue 65,105,225
saddlebrown 139,69,19
salmon 250,128,114
sandybrown 244,164,96
seagreen 46,139,87
seashell 255,245,238
sienna 160,82,45
silver 192,192,192
skyblue 135,206,235
slateblue 106,90,205
slategray 112,128,144
slategrey 112,128,144
snow 255,250,250

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide
AVEVA NET Export Configuration Files

springgreen 0,255,127
steelblue 70,130,180
tan 210,180,140
teal 0,128,128
thistle 216,191,216
tomato 255,99,71
turquoise 64,224,208
violet 238,130,238
wheat 245,222,179
white 255,255,255
whitesmoke 245,245,245
yellow 255,255,0
yellowgreen 154,205,50

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

Index

A Common Grid Record Commands . . . . 4:18

Compare Changes between Database Revi-
Advanced Grid Filters . . . . . . . . . . . . . . 4:12 sions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:4
Area Types . . . . . . . . . . . . . . . . . . . . . . . 5:2 Compare/Update Facility . . . . . . . . . . . . 7:7
Area-Based Access Control . . . . . . . . . . 5:5 Copy, Cut and Paste . . . . . . . . . . . . . . 4:16
Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Create a New Report . . . . . . . . . . . . . . 10:4
Audit Manager . . . . . . . . . . . . . . . . . . . . . 9:1 Create and Edit Custom Reports . . . . 10:13
AVEVA Connect . . . . . . . . . . . . . . . . . . . 3:2 Create Revision Sub-Reports . . . . . . 10:11
AVEVA Integration . . . . . . . . . . . . . . . . . 7:7 Creating a New Grid View . . . . . . . . . . 4:24
Grid Views . . . . . . . . . . . . . . . . . . . 4:29 Custom Reports . . . . . . . . . . . . . . . . . 10:13
AVEVA NET Export Configuration Files . B:1
Attributes Mapping File . . . . . . . . . . . B:7
Classes Mapping File . . . . . . . . . . . . B:8
D
Project Configuration File . . . . . . . . . B:1 Data Grids . . . . . . . . . . . . . . . . . . . . . . . 4:1
Database Revisions . . . . . . . . . . . . . . . . 9:2
B Database Upgrade . . . . . . . . . . . . . . . . . 3:4

Benefits of using AVEVA Instrumentation 2:1

Buttons in Cells . . . . . . . . . . . . . . . . . . . 4:15
E
Edit Grid Data . . . . . . . . . . . . . . . . . . . . 4:15
C Edit Report Details . . . . . . . . . . . . . . . 10:12
Edit Report Layouts . . . . . . . . . . . . . . 10:38
Change Reports . . . . . . . . . . . . . . . . . . . 9:1 Excel Style Filters . . . . . . . . . . . . . . . . . 4:10
Claims . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1 Export Reports . . . . . . . . . . . . . . . . . . 10:34
Cleartype Effects Export to Excel . . . . . . . . . . . . . . . . . . . . 7:6
Windows 7 . . . . . . . . . . . . . . . . . . . 3:12 Export to PDF Files . . . . . . . . . . . . . . . . 7:7
Windows 8.1 . . . . . . . . . . . . . . . . . . 3:12 Export to XPS Files . . . . . . . . . . . . . . . . 7:7
Column Filters . . . . . . . . . . . . . . . . . . . . . 4:9
Columns
Change Column Order . . . . . . . . . . . 4:4
F
Column Summaries . . . . . . . . . . . . . 4:4 Find and Replace Text in a Grid . . . . . 4:20
Pin Columns . . . . . . . . . . . . . . . . . . . 4:4 Finding and Replacing Text in a Grid . . 4:20
Resize . . . . . . . . . . . . . . . . . . . . . . . 4:3 Finding Text . . . . . . . . . . . . . . . . . . 4:21
Sort a Grid . . . . . . . . . . . . . . . . . . . . 4:4 Replacing Text . . . . . . . . . . . . . . . . 4:22
Common Grid Commands . . . . . . . . . . 4:18 Foreign Language Support . . . . . . . . . . 2:2

© Copyright 2000 to current year. Index page 1 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

G L
Grid Filters . . . . . . . . . . . . . . . . . . . . . . . 4:9 List Tools . . . . . . . . . . . . . . . . . . . . . . . 3:11
Advanced Grid Filters . . . . . . . . . . . 4:12 Locks . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Column Filters . . . . . . . . . . . . . . . . . 4:9 LogIn . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Excel Style Filters . . . . . . . . . . . . . . 4:10
Removing Filtering . . . . . . . . . . . . . 4:14 M
Grid Manager . . . . . . . . . . . . . . . . . . . . 4:22
Creating a New Grid View . . . . . . . 4:24 Mapping Definitions . . . . . . . . . . . . . . . . 7:4
Grid Window Options . . . . . . . . . . . . . . 4:33 Merge Cells . . . . . . . . . . . . . . . . . . . . . . 4:6
Group Grid Data . . . . . . . . . . . . . . . . . . . 4:7
Grouping Data O
by Multiple Attributes . . . . . . . . . . . . 4:8
Ungrouping Data . . . . . . . . . . . . . . . 4:8 Open a Grid . . . . . . . . . . . . . . . . . . . . . . 4:1
Open an AVEVA Instrumentation Project 3:2
I
P
Import and Export Procedures . . . . . . . . 7:1
Import from Excel . . . . . . . . . . . . . . 7:1, 8:4 Pick Lists . . . . . . . . . . . . . . . . . . . . 4:15, 6:1
Import Reports . . . . . . . . . . . . 10:35, 10:37 Add Values to a Pick List . . . . . . . . . 6:7
Instrument Sizing Calculations . . . . . . . . A:1 Create New Pick List . . . . . . . . . . . . 6:3
Control Valve Sizing . . . . . . . . . . . . . A:1 Delete Pick List . . . . . . . . . . . . . . . . 6:4
Formulas Used For Gases (Compress- Delete Pick List Values . . . . . . . . . . 6:7
ible Fluids) . . . . . . . . . . . . . . . . . A:4 Edit Pick List . . . . . . . . . . . . . . . . . . 6:3
Typical Values for FL and XT and Fd Edit Pick List Values . . . . . . . . . . . . 6:6
A:6 Merge Pick Lists . . . . . . . . . . . . . . . 6:4
Why Molecular Weight and Compress- Plant Areas . . . . . . . . . . . . . . . . . . . . . . . 5:1
ibility are Missing . . . . . . . . . . . . A:6
Flow Element Sizing . . . . . . . . . . . . A:13 Q
DP Calculation Problem . . . . . . A:15
Flow Calculation Problem . . . . A:14 Quick Access Toolbar . . . . . . . . . . . . . 3:11
Pressure Loss . . . . . . . . . . . . . A:15
Sizing Problem . . . . . . . . . . . . . A:14 R
Gas Compressibility Factor . . . . . . A:21
Compressibility Factor by Redlich- Removing Filtering . . . . . . . . . . . . . . . . 4:14
Kwong Equation of State . . . . . A:21 Report Issues . . . . . . . . . . . . . . . . . . . 10:30
Equation of State . . . . . . . . . . . A:21 Highlight Changes Since a Selected Issue
Expression of Z as a Function of Re- 10:34
duced Pressure and Reduced Tempera- Reissue Reports . . . . . . . . . . . . . 10:31
ture . . . . . . . . . . . . . . . . . . . . . . A:23 View Previous Issues . . . . . . . . . . 10:31
Redlich-Kwong EoS . . . . . . . . . A:22 Report Preferences . . . . . . . . . . . . . . 10:17
Relief Valve Sizing . . . . . . . . . . . . . . A:7 Report Revisions . . . . . . . . . . . . . . . . 10:24
Application to Relief Valves . . . . A:9 Create a Revision . . . . . . . . . . . . 10:25
Fundamental Equations . . . . . . . A:7 Edit a Revision . . . . . . . . . . . . . . . 10:26
Units . . . . . . . . . . . . . . . . . . . . . A:12 View and Edit Multiple Document Revisions
Thermowell Vibrations . . . . . . . . . . A:16 10:26
Analysis of a Cylindrical (Parallel) Ther- Reports . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
mowell (or Sample Quill) . . . . . A:18 Right-Click Context Sensitive Menu . . . 4:20
Order of Accuracy . . . . . . . . . . A:20 Rows
Tapered Thermowells Natural Frequen- Pin Rows . . . . . . . . . . . . . . . . . . . . . 4:3
cy . . . . . . . . . . . . . . . . . . . . . . . A:16 Select a Single Row . . . . . . . . . . . . . 4:2
Select Multiple Rows . . . . . . . . . . . . 4:3

© Copyright 2000 to current year. Index page 2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrumentation Common Functionality User Guide

S
Save Database Revisions . . . . . . . . . . . . 9:3
Split a Grid . . . . . . . . . . . . . . . . . . . . . . . 4:6
System Requirements . . . . . . . . . . . . . . . 2:2

U
Undo and Redo . . . . . . . . . . . . . . . . . . . 4:17

V
View and Print Reports . . . . . . . . . . . . 10:18

W
Work Packs . . . . . . . . . . . . . . . . . . . . . . . 8:1

© Copyright 2000 to current year. Index page 3 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.