Вы находитесь на странице: 1из 204

AVEVA Instrumentation Instrument Designer 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. Fluent is a trademark of Microsoft Corporation and the Fluent user interface is licensed from Microsoft Corporation.

Instrument Designer User Guide

Instrument Designer User Guide

Contents

Page

Instrument Designer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2 Benefits of using AVEVA Instrumentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2 Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:3

Feature Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1


AVEVA Instrumentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Other Engineering Applications of AVEVA Instrumentation . . . . . . . . . . . . . . . . . . . . . . . . . 2:3

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


Instrument Designer Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1 Application Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5 Working with the Data Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7 Finding and Replacing Text in a Grid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12 Advanced Grid Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:15 Grid Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:17
Creating a New Grid View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:18

Preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:21
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Revisions Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rev Clouds Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Terminations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:22 3:23 3:24 3:25

12.0

Instrument Designer User Guide

PickList Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:28

Areas

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Area Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2

Drawing List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1


Add a New Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3 Drawing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9 Rename Selected Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:13 Import Drawings into the Drawing List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17 Drawing Title Setup Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:20 Update Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:22 Revision Entry (Single Drawings). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23 Revision Entry (Multiple Drawings) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23 Drawing Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:24
View Previous Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:26

Non-AI Termination Drawing References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:28 Drawing Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:29


Publishing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:29 Publishing Drawings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30

Drawing Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1


Open a Template Drawing with AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3 Assigning DataLinks in AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4 DataLinks Report Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6 Seed Drawings List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:9 Auto Inserting Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:12 DataLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
DataLinks Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13

Hookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Hookup (Installation) Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Access the Hookup Drawing List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Add a New Hookup Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3 Assigning a Hookup Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6 Assigning Tags to a Hookup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6

ii

12.0

Instrument Designer User Guide

Editing Hookup Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7 Rename Selected Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10 Hookups Template Catalogue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10
Adding a New Hookup Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Template Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Import Hookup Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Hookup Items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Hookup DataLinks in AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:11 7:12 7:13 7:16 7:18

Hookup Items Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:19


Adding a New Catalogue Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:21

Hookup Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:23

Engineering Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1


Loop Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Assigning Tags to Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3 Selecting Existing Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:4

Instrument Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:5


Edit Tag Details - Tabs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:7

Loop Check Wiring Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:10 Equipment Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:11

Using Wiring Rules to Create Data . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1


Wiring Rules Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1 Using Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2 Creating Loop Wiring using Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:3 Assigning a Junction Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:5

Import and Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1


Import from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1 Import from another Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:5 Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:7 Export to XPS and PDF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:8 Export Selected Drawing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:8
Export Drawings to a Specified Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:8 Export Drawings to Pre-Defined Folders with File Names in a Pre-Defined Format . . . . . 10:9

Export to AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11


AVEVA NET Export Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11

iii

12.0

Instrument Designer User Guide

Export Reports and Associated Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:14 Export Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:15

Work Packs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1


Import Work Pack. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:3

Change Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1


Audit Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1 Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2
Project Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2 Saving a Database Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:3 Compare Changes between Database Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:4

Report Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1


Create a New Report (for the current Grid) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:8 Report Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:13 Report Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:14
Create a Revision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:14 Edit a Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:15 Viewing and Editing Multiple Document Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:16

Report Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:17


View Previous Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:18 Highlight Changes Since a Selected Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:20

Import Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:21 Edit Report Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:23 View, Edit and Create Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:23 Export to AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:25

AVEVA NET Export Configurations Files . . . . . . . . . . . . . . . . . . . . .A:1


Project Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1
High Level Structure of the Project Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:1 Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:2

Attributes Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:6


High Level Structure of the Attributes Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:6 Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:7

Classes Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:8


High Level Structure of the Classes Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . A:8 Elements and Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A:8

iv

12.0

Instrument Designer User Guide


Introduction

Introduction
The Instrument Designer User Guide is designed to help users learn how to use the Instrument Designer module of AVEVA Instrumentation. The User Guide describes how to create automated Loop and Termination diagrams from cable and wiring data. Instrument Designer manages all tasks typically handled by an Instrument Designer during a project life cycle including CAD drawing generation, drawing list management, updating of revisions and printing of CAD files for loop diagrams, termination diagrams, Hookups etc. Instrument Designer can be used to: Manage all project drawings and drawing revisions (including batch update, batch revision changes and plotting) from a Graphical User Interface Generate loop drawings from templates with updated attributes from the AVEVA Instrumentation database including: Data from Instrument Engineer (Manufacturer, model number., range, P&ID drawing nos., I/O etc) Data from AVEVA Instrumentation Wiring Manager (Cables, terminations, wire numbers etc) Data from the Instrument Designer drawing register (e.g Drawing No, Title, Drawn By, Date etc) and revision history is automatically updated on all drawings

Generate Termination drawings parametrically from the AVEVA Instrumentation database including: Data from AVEVA Instrumentation Wiring Manager (terminal strips & devices, cables and core markings/wire numbers etc). Data from the Designer drawing register (e.g Drawing No, Title, Drawn By, Date etc) and revision history is automatically updated on all drawings

Generate Hookup drawings with Bill of Materials and create bulk Bill of Materials reports for an entire project Access Engineering Data created with other AVEVA Instrumentation applications including: Instrument and Loop data created with the Instrument Engineer application. Auto generate field device wiring including Junction Box termination via AVEVA Instrumentation Using Wiring Rules to Create Data. Access Termination data created with the AVEVA Instrumentation Wiring Manager application. Produce reports: Drawing List Changes to Drawings.

AVEVA Instrumentation Designer utilises Autodesk's AutoCAD application to allow: Industry standard drawing/document exchange (data is never lost in a proprietary database)

1:1

12.0

Instrument Designer User Guide


Introduction

AutoCAD is used to define loop diagram layout. You have total control over drawing standards, symbology and drawing format. AutoCAD attributes are "linked" to the database (Microsoft Access or Microsoft SQL Server) for data transfer to each drawing. That is any information that is changed in the AVEVA Instrumentation database (e.g. a Tag Number, Cable No, wire marking etc) is automatically updated in the appropriate drawing (the next time it is Updated - updating can be done in batch mode). Print/update any number of selected drawings via the Drawing List (Drawing Register).

You can also easily access Loop data entry forms found in Instrument Engineer and Wiring Termination forms found in AVEVA Instrumentation Wiring Manager directly from within Instrument Designer. Licenses for AVEVA Instrumentation Engineer/Wiring Manager are required to access these forms. Important: Instrument Designer uses data created by Instrument Engineer and AVEVA Instrumentation Wiring Manager to generate CAD drawing files automatically from the AVEVA Instrumentation project database. Normally this is the last AVEVA Instrumentation module used on a project as Instrument Engineer is used to create instruments tags and assign tags into 'loops'. AVEVA Instrumentation Wiring Manager is used to create equipment, cables and wiring including terminations. Without this data Instrument Designer cannot create completed drawing files. For more information refer to Feature Overview.

1.1

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

1.2

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's, PDF and XLS's), resulting in major productivity gains. Easier to implement large (or small) scale design changes. Data is checked and validated by the database system. Data is electronically transferred, reducing errors and associated checking time. Relational database means "change once - change everywhere" Information is accurate and reliable (and self-checking).

Your project is less error prone than conventional design methods:

Construction and commissioning time is reduced through improved design accuracy.

1:2

12.0

Instrument Designer User Guide


Introduction

1.3

Guide Structure
Introduction Feature Overview User Interface Areas a brief description of Instrument Designer. handles automated generation of CAD drawings from the multiuser project/plant database. begins by displaying the View tab of Instrument Designer. all objects are based on Plant Areas, once the project is setup the first task is to add the various plant areas to the project database. is the main Designer window for adding/editing and accessing drawings. how Designer generates CAD drawings from the Drawing List. drawings are created by assigning a pre-defined Hookup Template to each project hookup drawing. allows access to the Instrument Engineering data normally created by the Engineer application. to auto generate typical field instrument wiring/cabling. includes facilities to export files of item data and report PDF files for import into AVEVA NET. can be created with selected equipment and time scales for a particular project. has an in-built Audit Manager that enables users to view database changes made during your project in the database audit log. that enables users to create and modify reports.

Drawing List Drawing Generation Hookups Engineering Data Using Wiring Rules to Create Data Import and Export Work Packs Change Reports

Report Manager

1:3

12.0

Instrument Designer User Guide


Introduction

1:4

12.0

Instrument Designer User Guide


Feature Overview

Feature Overview
Instrument Designer handles automated generation of CAD drawings from multi-user project/plant databases. It manages the process of CAD drawing creation, drawing revision update, transferring of data to drawings, parametric creation of termination (wiring) drawings and printing CAD files. Drawing List Management Add/Edit/Update/Delete/Open drawings from the Drawing List (register) manually. Add loop drawings automatically from Instrument Engineer's Loop List. Add termination drawings automatically from Wiring Manager's Equipment List. Manage drawing revisions (update all selected in "batch" mode). Create new revision using next revision number or Update current revisions with new information. Updates all drawing data: Drawing title block from Drawing List (titles, drawing no, plant area etc). Revisions from Revisions history. Engineering Data from any Instrumentation database field.

Link drawing text fields to any user defined database field using AVEVA Instrumentation Datalinks or SQL queries. Create/update and print selected drawings in batch mode. Print selected drawings in batch mode.

Loop Drawing Generation Create multiple drawings based on user templates (fully user definable). Edit drawings and update existing drawings without templates. Updates cable/termination data from Wiring Manager (e.g. Cable, Terminal & Wire Nos etc.). Updates Instrument data from Instrument Engineer (e.g. P&ID No, Manufacturer, Model No., Range, DCS/PLC I/O information etc.). Updates title block information (titles, revisions etc) and stacks revision history.

Termination Drawing Generation Creates drawings based on: Templates (typically termination schedules). Parametrics/Automated drawing (typically termination diagrams) - user defined parameters - fully automated drawing creation.

Updates cable/termination data from Wiring Manager (e.g. Cable, Terminal and Wires No.'s).

2:1

12.0

Instrument Designer User Guide


Feature Overview

Supports cross-patch wiring and links between terminals. Supports automatic continuation over multiple drawings (e.g. Marshalling Racks etc). Supports automatic reference drawing numbers to loop diagrams for field cables & To/ From equipment & drawing numbers for termination drawings. Updates title block information (titles, revisions etc) and stacks revision history.

Hookup/Installation Drawings Assign tags to Hookup Type (Hookup drawings are user definable using AutoCAD). Assign Hookup Items from user definable catalogue (AVEVA Instrumentation currently has over 3000 catalogue items already entered). Auto create Drawings with Bill of Materials and Tag List. Project Bill Of Materials (BOM) reports (by Plant Area and Total Project BOM).

Change Management Report all drawings added, deleted and renamed. Report detail changes in each field (e.g. Drawing No. now ABCD was XYZ). Log changes for future reporting (e.g. 8/7/99 Drawing No. XYZ: Cable No. 1234 was 4567 etc). Audit Manager (SQL Server databases only) enables users to view changes by object type.

Integration The Designer is integrated with other AVEVA Instrumentation applications. Loop Drawings automatically added to Drawing List from Engineer. Tag Numbers, service, range, manufacturer, model no. etc updated from Engineer. Equipment, cables, terminations, wire nos. etc automatically updated from Wiring Manager. Loop Drawing No. is passed to Instrument Engineer's Instrument List (Index). Hookup Drawing number is passed to Instrument Engineer's Instrument List (Index).

Designer can be used on any existing AutoCAD drawings and allows drawings to be updated from the Instrumentation databases (Instrument Engineer, Wiring Manager or user defined) without requiring use of templates. For example, several loop drawings could be initially generated from a standard loop definition (template), then any number can be edited and made non-standard, but the information can still be updated automatically from the original databases. Reports and associated data can be exported to AVEVA NET. User Security Rights When using AVEVA Instrumentation with a SQL Server project database an AVEVA Instrumentation administrator can set security rights for users to enable/disable access to AVEVA Instrumentation functionality including: Access to AVEVA Instrumentation application modules - users can be restricted from using any module (license). Access to AVEVA Instrumentation objects can be restricted to read-only (e.g. a user cannot add/edit a drawings) or no access (i.e. the user cannot view an instrument etc.).

AVEVA Instrumentation objects include project entities such as cables, instruments, drawings, reports etc and catalogues, the importing of data etc.

2:2

12.0

Instrument Designer User Guide


Feature Overview

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

2.1

AVEVA Instrumentation
AVEVA Instrumentation is software for managing Instrumentation design data and documentation. The suite of applications uses an advanced graphical user interface integrated with a relational database (Microsoft Access 2000 or SQL Server). Much of the data is 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, Access report and PDF formats can be generated very quickly. Automated production of design documentation ensures superior design integrity and efficiency. AVEVA Instrumentation can be used to: Manage instrument data (typical instrument Index). 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 format. Manage CAD drawings, allow bulk assignment of revisions, bulk printing etc. Automate production of loop diagrams, junction box & marshalling cabinet termination diagrams (data from Instrument Index and data sheets can be shared with drawings).

Applications of the AVEVA Instrumentation Suite are: Instrument Designer. Instrument Engineer. Instrument Wiring Manager. Instrument Process Engineer. Instrument Security Manager.

2.1.1

Other Engineering Applications of AVEVA Instrumentation


Intelli-Link The applications family enables P&ID drawings drawn in AutoCAD (or AutoCAD LT) to be scanned to check instrument data contained in drawings against data in the AVEVA Instrumentation Instrument Index. Any differences are reported and can (optionally) be imported/changed in the index. Intelli-Link should work with most drawing symbols and is user configurable. Intelli-Link can import tags directly from P&IDs into AVEVA Instrumentation. Intelli-Link does not require AutoCAD for auto tag checking/scanning. However Intelli-Link can use AutoCAD to create connectivity, including line lists (with source/destination) and update AVEVA Instrumentation 'Plant Connection' data (i.e. line number/equipment number each instrument is connected to) from most existing AutoCAD P&ID drawings. The user will not therefore need to redraw P&IDs in order to produce intelligent drawings.

2:3

12.0

Instrument Designer User Guide


Feature Overview

2:4

12.0

Instrument Designer User Guide


User Interface

User Interface
Important: Instrument Designer uses data created by Instrument Engineer and Instrument Wiring Manager to generate CAD drawing files automatically from the AVEVA Instrumentation project database. Normally this is the last AVEVA Instrumentation module used on a project as Instrument Engineer is used to create instruments tags and assign tags into 'loops' and Instrument Wiring Manager is used to create equipment, cables and wiring including terminations. Without this data Instrument Designer cannot create completed drawing files. When Instrument Designer starts up the AVEVA Instrumentation Designer window is displayed showing the View tab.

3.1

Instrument Designer Tabs


Instrumentation Designer displays two tabs when the application is first started, View and Reports. When the user selects any option except Template List from the View tab a third Tab is displayed named Tools.

3:1

12.0

Instrument Designer User Guide


User Interface

The View tab consists of two panes, Lists and Catalogues. The options on the Lists pane are: Drawing List Template List Displays the Drawing List grid view. Displays the Template window showing all project Template files (enables opening selected template in AutoCAD). Refer to Open a Template Drawing with AutoCAD. Displays the Seed List grid view. Refer to Seed Drawings List. Displays the Hookup Drawings List grid view showing only hookup drawings and hookup specific commands. Refer to Hookup (Installation) Drawings.

Seed List Hookup Drawing List

The options on the Catalogues pane are: Hookup Catalogue Hookup Items Catalogue Displays the Hookup Catalogue grid view. Refer to Hookups Template Catalogue. Displays the Hookup Items Catalogue grid view.

When an option, except Template List, is selected from the Lists and Catalogues panes, a third pane named Window is displayed. The available options on the Window pane are: New Horizontal Tab If you wish to view more than one 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 in 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 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 was 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.

3:2

12.0

Instrument Designer User Guide


User Interface

Tabbed Mdi

Tabbed Mdi (Multiple document interface) 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 Tab

If the grid view has been split into two parts using either the New Horizontal Tab or New Vertical Tab, 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, 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.

The Tools tab consists of five panes, Grid, Import & Export, Misc, Clear Locks and View Audit log. The options on the Grid pane are: Grid Manager Select a Grid View Loads the Grid Manager which is used to set up user defined layouts (Views) for the Drawing List grid. Displays a list of grid views previously defined for the current Grid to allow user selection. Refer to Grid Manager for further information. Automatically sets all the column sizes in the current grid view. Selects all rows in the currently displayed grid view. Note: Any rows filtered out are not selected. Edit Selected Rows Pivots selected rows into a vertical format (columns) for 'side by side' editing.

Auto Size Columns Select All Rows

3:3

12.0

Instrument Designer User Guide


User Interface

The options on the Import & Export pane are: Imports Provides access to Import commands menu Exports Import from Excel. Refer to Import from Excel Import from other Project. Refer to Import from another Project

Provides access to Export commands menu Export to Excel. Refer to Export to Excel Export to Excel (With ID). Refer to Export to Excel Export to PDF. Refer to Export to XPS and PDF Files Export to XPS. Refer to Export to XPS and PDF Files Export Selected Drawings. Refer to Export Selected Drawing Files Copy/Archive to a Folder Copy to User Defined Names

The options on the Misc pane are: Check for New Loops Checks the Drawing List against the Wiring Manager for changes in equipment (i.e. recently added, deleted or renamed Junction Boxes, Marshalling Cabinets etc) and updates the drawing list with any such changes. Refer to Import Drawings into the Drawing List. Checks the Drawing List against the Wiring Manager for changes in equipment (i.e. recently added, deleted or renamed Junction Boxes, Marshalling Cabinets etc) and updates the drawing list with any such changes. Refer to Import Drawings into the Drawing List. Enables editing of external Drawing Number references. Refer to Non-AI Termination Drawing References. Allows the user to Rename Selected Drawings in batches.

Check for New Terminations

Termination Ref Drawing Nos (non-AI) Rename selected Drawings

The Clear Locks and View Audit Log panes both have a single option: Clear Locks View Audit Log Clears any multi-user locks placed on grid records Displays the database Audit Log showing all changes to the data. Note: Only available if using SQL Server databases.

3:4

12.0

Instrument Designer User Guide


User Interface

The Reports tab consists of three panes, Main, Drawings and Hook-ups. The options on the Main pane are: Report Manager Displays the AVEVA Instrumentation Report Manager which enables user defined reports to be created/printed. Refer to Report Manager for more information. Displays the AVEVA Instrumentation Report Manager window from which Revisions Subreports can be viewed, edited and printed. Displays a Print Preview window displaying a screen capture of the current Grid. This displays a window called "Report Viewer" which is a component of the Report Manager.

Custom Reports

Print Grid Print Grid View

The options on the Drawings pane are: DataLinks for Selected Drawing If a single Drawing is selected, this command displays the DataLinks Report Window which displays all the Datalinks available for the drawing, including values returned by each DataLink based on current project data. Displays the Templates Used in Projects window, which shows a Print Preview of all Templates used by Designer, and the number of times they have been used in the project.

Templates Used

The options on the Hook-ups pane are: BOM/Material Take-off Tags Assigned Tags not yet Assigned Refer to Hookup Reports. Displays the Hookup Bill of Materials window. Displays the Tags Assigned to Hookup window. Displays the Tags not yet Assigned to a Hookup window.

3.2

Application Menus
To access the Application Menu options the user must click the button displayed in the top left of the AVEVA Instrumentation Designer window.

3:5

12.0

Instrument Designer User Guide


User Interface

When clicked the following options are available to the user.

Open Project

Displays the Select an AVEVA Instrumentation Project window allowing another Project database to be selected and closing the current project database. Displays the Project Data window allowing editing/viewing of some project information and folders/file locations. Displays the Project Revisions window which allows the current project database to be saved as a new Revision and generated reports showing the differences between any previously saved Database Revision and the current (working) database. Refer to Database Revision Change Reports topic. 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 Work Packs. The Setup option provides access to the Setup Sub Menu. Displays the Preferences window which allows editing/ viewing of program user preferences. Refer to Preferences.

Edit Project Project Revisions

Work Packs

Setup Preferences

3:6

12.0

Instrument Designer User Guide


User Interface

Setup Sub Menu The options on the Setup menu are: Add/Edit Plant Areas Add/Edit Plant Area Types Edit Pick Lists Displays the Areas window enabling new Areas to be added or details changed. Refer to Areas. Allows the user to create different Area Types to be used within the project and set different criteria for each Area Types. Refer to Area Type. Displays the Pick List (All) window in which users can add and edit PickLists and add new items to PickLists. Refer to PickList Management. Displays the Loop Import Drawing Titles Settings window. Refer to To Define Loop Diagram Drawing Titles. Displays the Termination Import Drawing Titles Settings window. Refer to To Define Termination Diagram Drawing Titles. Displays the File Export Settings window allowing users to define rules to allow datasheet Excel files to be automatically renamed when copied out of AVEVA Instrumentation into user defined folders. Refer to Export Drawings to Pre-Defined Folders with File Names in a Pre-Defined Format Allows a choice where the file is published and an executable format for each published item. Refer to Drawing Publishing. Displays the AVEVA NET Export Configuration window. Refer to Import and Export.

Loop Titles (Import format) Termination Titles (Import format) Set Export File Name/ Folders

Drawings Publishing Configuration AVEVA NET Export

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 starts in the last selected language. Refer to Foreign Language Support in the Installation User Guide for more information. 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 it's own colour scheme.

3.3

Working with the Data Grid


The following section describes the generic functionality of the Data Grid used in all AVEVA Instrumentation applications:

3:7

12.0

Instrument Designer User Guide


User Interface

Right-Click Context Menu A context menu will pop-up when a user right-clicks on a record. The menu provides quick access to most common grid commands.

Rows (Records)
Selecting a Single Row 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.

Selecting Multiple Rows 1. Hold the control key (Ctrl) and select the individual rows by clicking immediately to the left of the first column. Holding the Ctrl key while selecting a row adds the row to the selected rows. To remove a selected row from the list, click on the row again. 2. Hold 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. 3. Pressing Ctrl-A on the keyboard or selecting Select All Rows on the Tools tab selects all rows in the current grid, excluding any rows filtered out. Pin Rows By clicking on the Pin icon on the left side of a row the user can pin the selected row to the top of the grid. When the row is pinned it remains at the top of the grid even when the grid is scrolled, so that it is always in view.

When a row is pinned, its pin icon changes orientation, so that it is point downwards. Columns (Fields) Resizing Click and hold on the divider line between columns and drag the column to make it wider or narrower. Double clicking on the divider line will size the column to fit the largest string of text within that column.

3:8

12.0

Instrument Designer User Guide


User Interface

Change Column Order Click and hold on the column header and drag the column either left or right into a new position. Two arrows are displayed to assist the user in positioning the column. Lock Columns The 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. Select the vertical line to the left of the left horizontal scroll arrow and drag to the right to create the two sections.

Filtering the Data Grid The user can filter the Data Grid to show only certain records. For example, only items of a particular type. AVEVA Instrumentation supports instant 'on the fly' filtering which is done by selecting the small icon to the right of a column (field) caption, and then by selecting a value from the drop-down list.

3:9

12.0

Instrument Designer User Guide


User Interface

Further filtering is available by selecting the small icon to the left of a column (field) caption, selecting from the drop down list and entering a value into the highlighted field. The grid view will automatically refresh to reflect the selected criteria.

AVEVA Instrumentation supports complex filters. Refer to Advanced Grid Filters for more information. Sorting the Data Grid The user can sort the Data Grid on any combination of fields by clicking on column (field) name. To sort by multiple fields hold the <Shift> key while making selections. The grid will be sorted in the order you select each column. Grid Manager The Grid Manager application enables users to select their own sub-set of columns/fields for the current grid including presetting column order and size, caption, predefined sort order and predefined filters. Refer to the Grid Manager for more information. Grouping 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 Drawing Number. A grouping bar is displayed above the column headings:

3:10

12.0

Instrument Designer User Guide


User Interface

To group data, drag and drop the column heading of the attribute in question into the space above the column headings.

The form 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 bar.

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.

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

3:11

12.0

Instrument Designer User Guide


User Interface

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

If the second heading is dropped to the left of the first heading, records will be grouped the other way round. Ungrouping Data To "ungroup" data, drag and drop the column heading or heading from the grouping bar back to the column bar.

3.4

Finding and Replacing Text in a Grid


Any text string within a grid can be found, highlighted and optionally replaced. To find text within a grid click the Find command button or right-click on the grid and select the Find option from the menu that is then displayed. The Find window is then displayed.

3:12

12.0

Instrument Designer User Guide


User Interface

Finding Text By default, the window opens in Find mode. Switch between Find and Replace modes by clicking the Find and Replace buttons in the Mode section of the window. 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. From the Look In 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 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 From the Search drop down list, select the direction in which the search will take place: All (i.e. up and down - default), Up, or Down. 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. 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 Cancel to exit the window. Replacing Text Set the window to Replace mode by clicking the Replace button.

3:13

12.0

Instrument Designer User Guide


User Interface

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 Cancel to exit the window. Finding a Tag A specific tag, or other identifier for a record (e.g. catalogue number) can be searched for in a grid. Click the down arrow next the Find command button and select Find Tag from the submenu that is then displayed, or right-click on the grid and select the Find > Find Tag option from the menu. The following window is then displayed:

Enter the tag/identifier in the Find What field, or select it from the drop down list. 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.

3:14

12.0

Instrument Designer User Guide


User Interface

If no matches are found, a message is displayed to inform the user of this. Click Cancel to exit the window.

3.5

Advanced Grid Filters


To add or change an advanced (complex) Filter to your current grid view, from the Grid Toolbar menu, click Filter, to display the Filter window.

Add a New Criteria Select the Field by entering or selecting a value from the list of fields in the Field option. Select a Filter Criteria from the list of criteria in the Criteria option. Enter a value in the Value option, or select from the list of values in the 'Value' option. Add Additional Criteria Select Join + Filter from the toolbar. You can change the default 'AND' logical join to 'OR' by clicking on the blue 'AND' text that appears between filter records. Enter the Field, Criteria and Value information of the 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. To apply the Filter, click Apply.

3:15

12.0

Instrument Designer User Guide


User Interface

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 you. More Information about Filter Criteria Filter Criteria Exact Match Begins With Partial Match Ends With Partial Match Contains Partial Match In List Greater Than Or Equal To Less Than Less Than Or Equal To Greater Than Not Exact Match Not Begins With Partial_Match Not Ends With Partial_Match Not Contains Partial_Match Is Empty Not Empty Not Null Description Field = Value Field like XX* Field like *XX Field *XX* like Example Value 1234 XX XX XX A, B, C 1234 1234 1234 1234 1234 T T T = Comments Shows all records where Field = 1234 Shows all records where Field begins with two characters XX Shows all records where Field ends with two characters XX Shows all records where Field contains two characters XX Shows all records where Field exact matches any values in list Shows all records where Field 1234 Shows all records where Field < 1234 Shows all records where Field 1234 Shows all records where Field > 1234 Shows all records where Field does not = 1234 Shows all records not beginning with T Shows all records not ending with T Shows all records not containing T Shows all records where Field is empty Shows all records where Field is not empty (no characters) Shows all records where Field is not Null

Field = A or B or C Field Value Field < Value Field Value Field > Value Not Field = Field like T Field like T Field like T Is Field (nothing)

Not Field = (nothing) Not Field = Null

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

3:16

12.0

Instrument Designer User Guide


User Interface

Command Buttons Apply Cancel Exits the Filter window and applies the filter to the current grid. Exits the Filter window without changing any filters in the current grid.

Toolbar Commands + Filter - Filter Change Join +( -( +) -) -() Test Filter Up Down Adds a new Filter row to the Filter definition Removes the selected Filter row from the filter definition 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 Tests the Filter Moves a Filter row up Moves a Filter row down Clears all filters in the current grid

Clear Filters

3.6

Grid Manager
The Grid Manager allows users to define their own sets of data fields (columns), default column orders, default sorting and predefined data filters for most AVEVA Instrumentation data grids available in AVEVA Instrumentation application modules. These sets of fields are called 'Views' and typically contain a subset of all available fields. Note: If the user is working in a SQL 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. Users working in an Access project will have no restrictions. Grid Manager is available for the following data grids in Instrument Designer: Data Grid Drawing List Hookup Drawing List Hookup Templates Catalogue Hookup Items Catalogue Description Project Drawing List or Index Project Hookup Drawing List or Index Project Hookup Templates Catalogue Hookup Items (or Parts) Catalogue

3:17

12.0

Instrument Designer User Guide


User Interface

The feature enables each user to restrict the grid to display only those fields that are required for their current task. For example, in the Engineer Instrument List data grid the user can select from any of the available database fields to define a customised set and name that View. If the user was to select fields related to Calibration data, they may select fields TagNo, Service, P&ID, Range, CalibratedRange, Alarms etc and name this view 'Calibration'. Users can easily change between Views by selecting from the list of Views created in their 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. Note: All examples in this document refer to Designer's Drawing List. However, all functionality described can be applied to any Data Grid listed above. Changing a View Click Select a Grid View on the Tools 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:

To change 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 Views fields, sort order and data filters.

3.6.1

Creating a New Grid View


To create a new user defined View using Grid Manager, from the Tools tab, select Grid Manager to display the Grid Views window.

3:18

12.0

Instrument Designer User Guide


User Interface

Users can add a new View by clicking New, or an existing View can be copied and then modified. 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 Grid Manager window with the View tab active.

The Grid Name is the name of the current data grid and is non-editable (this View is based on the Drawing List data grid). Enter a View Name and optional Description.

3:19

12.0

Instrument Designer User Guide


User Interface

Views can be marked Public which allows any other users to use this View or set to Private which restricts access to only the user that creates this 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:

To select/de-select fields click each fields checkbox in the Select column. The user can add as many fields as they require. The user can rename the titles in the Caption column fields by clicking in the field and changing the text. The new title will then appear in the Grid View. When all the fields have been selected, click Save to save the fields to the new View. Note: You can edit any existing View by selecting the View in the Grid View window and clicking Edit to open the Grid Manager for the selected view. Note: You cannot edit any existing View named 'AVEVADefault'. This is a system protected View. You can however, copy the AVEVADefault view and modify the copied version. 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 preset. To define the Layout, click Layout to display the selected fields.

3:20

12.0

Instrument Designer User Guide


User Interface

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

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 desired 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. Sorting Use the Sorting tab to define a default list and display a View Fields and Sort By option. A checkbox can be ticked to show only what has been used, or double click to add or remove fields. Filtering Use the Filtering tab to force the View to be filtered. For example only show only loop diagrams (e.g. DrawingType = 'Loop Diagram').

3.7

Preferences
The Preferences window is used to view and edit preferences for drawings generated by Designer. To open the Preferences window, select Preferences from the Application Menu. Default preferences for a metric project are displayed in the example images below.

3:21

12.0

Instrument Designer User Guide


User Interface

3.7.1

General Tab

From the AutoCAD Drawing Units list, select Metric (mm) or Imperial (inch). Enter the default snap value in the Default Snap value field. Note: The Log Changes checkbox is not currently used. In changes to drawings are to be automatically highlighted by clouds, check Cloud Changes. The appearance and other preferences for clouds are specified on the Rev Clouds tab (see below). Enter the drawing layer to be used for drawing borders in the Drawing Border layer field. If loop sheet numbers are to be ignored on termination diagrams, check Ignore Loop Sheet Nos on Termination Diagrams. Enter the number of characters to be used for sheet numbers in filenames in the Length of Sheet No in Filename field.

3:22

12.0

Instrument Designer User Guide


User Interface

3.7.2

Revisions Tab

Enter the maximum numbers of loop, termination and hookup revisions that are to be listed on drawings in the fields provided. In the Name Captions area of the tab, specify which details are to be displayed for each drawing revision (e.g. By, Checked, Approved etc) by checking the appropriate checkbox. If the caption for a revision detail is to be other than the default caption, enter the required caption in the field provided. For example, if "Reviewed" is to be used instead of "Checked", enter "Reviewed" in the Caption field for the Checked caption.

3:23

12.0

Instrument Designer User Guide


User Interface

3.7.3

Rev Clouds Tab

Changes to drawings are automatically highlighted using revision clouds if the Cloud Changes checkbox on the General tab (see above) is checked. Enter the drawing layer to be used for revision clouds in the Drawing Border layer field. Select the colour of clouds from the Color for Clouds list. If clouds are always to be plotted, check Always Plot Clouds. If clouds are always to be shown, check Always Show Clouds. Enter the width, ratio and offset of the cloud bulges in the Cloud Parameter fields.

3:24

12.0

Instrument Designer User Guide


User Interface

3.7.4

Terminations Tab

In the fields provided, enter: The heights of terminal strip marking text, terminal marking text and core/wire number text. The widths of devices, device terminals, cables numbers, OAS screens and group screens. The lengths of cables and the minimum lengths of cores and wires.

If ferrule numbers are to be placed "inside" wires, check Draw Ferrule Nos 'Inside' Wire. If this is not checked then ferrule numbers are drawn above the above the wire. The following example illustrates a termination drawings with the above parameters applied:

3:25

12.0

Instrument Designer User Guide


User Interface

Note: The Cable No Width value is to break the cable line. It does not define the actual block width. To change the Cable No block width the block, the Cable No Offset must be redefined (see below). Parameters not Illustrated in the Example above: In the Cable Spacing field enter the horizontal distance between cables when more than one cable is drawn to the same terminal strip when cables are being drawn vertically In the Cable No Offset field, enter the vertical distance from the centre of the Cable No block to the cable. The default zero (0) places the Cable No within the cable. If core markings are to be placed outside of wire numbers, check Draw Core Marking on 'Outside'. If checked, core markings are drawn to the right side of wire numbers for wires drawn from the right side of a terminal, and to the left for wires drawn from the left side.

Wire Destination References Checking either the Use DwgNo. References for Wires or the Use Sheet References for Wires checkboxes activates the Prefix and Suffix text boxes which allow the user to enter their own prefix or suffix.

3:26

12.0

Instrument Designer User Guide


User Interface

Checking the Use DwgNo. References for Wires checkbox also activates the Drawing No. text box. The drop-down list has the following two options: Use Dwg No. Use Client Dwg No Default option which uses the drawing number shown in the DwgNo column on the Drawing List grid view. Users that want to use their own drawing number instead of the AVEVA Instrumentation number can select this option which uses the drawing number shown in the ClientDwgNo column on the Drawing List grid view.

Checking the Use Sheet References for Wires checkbox actives the Sheet No. Prefix text box allowing user to change the word used to prefix the Sheet No., for example Sheet, SHEET or SHT.

The user can check both the Use DwgNo. References for Wires and the Use Sheet References for Wires checkboxes enabling the user to add a Drawing No. and a Sheet No. Prefix.

Text Styles/Fonts Definition AVEVA Instrumentation draws all Wire/Ferrule Nos and reference text in the Seed File Drawing's current text style. By setting the current text style in the Seed Drawing File(s) the final text style (font) can be user defined.

3:27

12.0

Instrument Designer User Guide


User Interface

Line Weights/Line Colours Definition AVEVA Instrumentation uses 3 predefined layers to draw the graphics. You may change the layer colours to change the line weights to your client's standards if required in the Seed Drawing File(s) used to generate termination diagrams. Layers used are: L2 L3 L5 Default colour is White. This is the Layer associated with a 0.25mm pen width and 2.5mm text height. Default colour is Yellow. This is the Layer associated with a 0.35mm pen width and 3.5mm text height. Default colour is Red. This is the Layer associated with a 0.5mm pen width and 5mm text height.

Cable Number Block Definition AVEVA Instrumentation uses a Cable Number block named 'CableNo' which is inserted into the drawing for each cable number. The Cable Number block can be redefined to change its appearance (for example, change text height, use rounded ends or make longer etc). The block should be defined with a single attribute and redefined within each Seed Drawing File used by AVEVA Instrumentation for your project. If AVEVA Instrumentation does not find a block named 'CableNo' it is inserted from a file named: AVEVA InstrumentationTermDefaults (or AVEVA InstrumentationTermDefaultsImperial if using non-metric settings) located in the 'DwgExamples\Seeds' folder in the AVEVA Instrumentation program files folder. Opening AVEVA InstrumentationTermDefaults (or AVEVA InstrumentationTermDefaultsImperial) and redefining the Block 'CableNo' will affect all termination drawings where the Seed file does not contain any 'CableNo' block reference. Device and I/O Module Description Text In the Device and I/O Module Catalogues in Wiring Manager, the 'Description on Drawing' textbox can be used to change the default drawing description to the value entered in that textbox. Using the <Enter> key will add a line-break in the drawing to create multiple lines of text. Up to 3 lines will be created for the description in both AutoCAD termination diagrams created in Designer and Termination PDF reports created in Wiring Manager. If the Catalogue Definition 'Description on Drawing' textbox is left empty the default description will be used which is a concatenation of the Manufacturer and Model No., separated by a space. Click Save to exit the Preferences window and save changes made to preferences. Click Cancel to exit the window without saving changes.

3.8

PickList Management
Designer's PickList Management window allows users to define a new PickList, add, edit and delete values in existing PickLists, and delete PickLists. Select Setup > Edit Pick Lists from the application menu to display the Pick List window.

3:28

12.0

Instrument Designer User Guide


User Interface

The Pick List (All) window initially displays the contents of every picklist in the Value column. The name of the pick list to which each value belongs is displayed in the PickList Name column. Values are initially grouped by pick list, which are listed in alphabetical order. To set the window to only display the contents of a single pick list, select the name of the pick list from the drop-down list at the top of the window. The Pick List (All) window then changes to displays only the values of the selected pick list. To display all pick lists again, select All from the drop-down list. Edit Pick List Values Click in the cell that contains the value and type in the new value. 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. 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: Changes to pick lists are not committed to the project database until a save has taken place.

3:29

12.0

Instrument Designer User Guide


User Interface

Create New Pick List To create a new pick list, enter the name of the new pick list in the drop-down list at the top of the window and click Add New Picklist. A blank field is displayed in which the first value of the new list should be entered. Note: Unless at least one value is added to the new pick list, it will not be committed to the database when a save takes place. Empty pick lists are automatically deleted. Delete Pick List To delete a pick list, delete all values from the pick. When a save takes place, the empty pick list is deleted. Save and Exit the Window To exit the window and save all changes to new and existing pick lists, click Save. To exit the window without saving, click Cancel. If there are any unsaved changes, a message is displayed prompting the user to save these changes. Click Yes to save the changes and exit the window. Click No to exit the window without saving.

3:30

12.0

Instrument Designer User Guide


Areas

Areas
All objects in AVEVA Instrumentation are based on Areas. 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. To add a new Plant Area to the project, select Setup > Add/Edit Plant Areas from the application menu 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.

The user can now assign a number for the area by entering a value in the Area No field. The Area number must be unique to the project. If the Area number already exists a warning message will be displayed.

4:1

12.0

Instrument Designer User Guide


Areas

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 Type 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 Type for further information. The Description and Short Description are optional. Note: 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 dropdown list of the Plant Areas is displayed.

4.1

Area Type
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.

4:2

12.0

Instrument Designer User Guide


Areas

To add or edit an Area Type, select Setup > Add/Edit Plant Area Types from the application menu 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 and select which criteria to associate to the Area Type by checking one or more of the four checkboxes. 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 Can be Root Allows the Area to contain Sub-Areas. 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. Specifies that the area must be a Root (top level) area and cannot be a Sub Area.

Must be Root

4:3

12.0

Instrument Designer User Guide


Areas

Click Save to create the new Area Type. A message will be displayed confirming the Area Type was created successfully.

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. A message will be displayed confirming the Area Type was edited successfully.

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.

4:4

12.0

Instrument Designer User Guide


Areas

To delete an Area Type, select 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 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.

4:5

12.0

Instrument Designer User Guide


Areas

4:6

12.0

Instrument Designer User Guide


Drawing List

Drawing List
The Drawing List is the Instrument Designer window for adding/editing and accessing drawings. By default all drawings for the project are shown in the grid however the user can filter the data by using the column 'on-the-fly' filters, the advanced filter window or by creating new grid views containing user-defined sets of columns using the Grid Manager. To access the Drawing List, click Drawing List from the View tab.

Note: Refer to Working with the Data Grid for information on the grid control including how to select a record (a Drawing). Generally whenever you see a grid in AVEVA Instrumentation the user can edit data directly within a cell (a field). However, some cells may be protected to ensure data integrity. If you cannot edit a specific cell within the grid you should use the 'Edit' command to access an edit window box. The grid provides details on each project drawing, including Drawing Number, Loop No (if a Loop Diagram), Title, Current Revision, Equipment No (if a Termination Diagram) and dates/ times for Last Updated, Last Printed etc. Mandatory Data To produce a drawing you must enter a Drawing Number. Designer uses this field and the Sheet field to create a file name. For example: Drawing No: 123456 and Sheet No: 1 are combined to create a file name: 123456-1.dwg. Special Instrument List Grid Features Some cells within the grid will show a small button in the right side of the cell when the mouse cursor hovers over it indicating that you can access additional information related to the cell's instrument and cell name. These cells are:

5:1

12.0

Instrument Designer User Guide


Drawing List

Loop No: Selecting the 'Loop No' cell button will allow viewing/editing of the Loop data by displaying the Options window as described in Loop Data. Equipment No: Selecting the 'Equipment No' cell button will allow viewing/editing of the associated Equipment and terminations using Wiring Manager facilities. See Equipment Data. Auto Generation of Drawings AVEVA Instrumentation uses special 'DataLinks' to map database data to AutoCAD drawing attributes. DataLinks are automatically updated by Designer when a drawing is opened or updated from the Drawing List toolbar. For information on using Designer's DataLinks to update: Drawing Title Block (Drawing Border) - including revisions history, Loop Diagram technical data (tag, cable, wire numbers, terminal markings etc) or to generate Termination Diagrams refer to Drawing Generation. Drawing List Command Buttons New Edit Displays the Drawing Information window. Refer to Add a New Drawing for more information. Displays the Drawing Information window for editing existing drawing data. Note: You can also double-click on any drawing record to display the Edit window. This allows editing of Title block and Revision information. Use Open to view the actual CAD drawing. Delete Undo Allows deletion of selected drawing(s). Displays the Delete Options confirmation window box for you to confirm deletion. Undoes the last change made to the last row edit. Any subsequent undo will roll back 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 Open Reverses the last undo (see above) made to text in the grid. Open the selected drawing for reviewing/printing etc in AutoCAD (Editing title block and revision information should be done from the Edit button above). Updates selected drawing(s) - forces DataLinks in each CAD drawing to be updated with current project data from the AVEVA Instrumentation database. Refer to Update Drawings for details.

Update

Note: If the drawing file does not exist the file is created by copying a) the template file (if drawing uses a template drawing) or b) the seed file (if drawing uses a seed drawing). Refer to the Drawing Generation for more information. Issue Issues and updates selected drawing(s). Sub-menu options are: Open Issues For Selected Open Issues For All Displays the Issues window listing all the current issues for the selected drawing. Refer to View Previous Issues for further information. Displays the Issues window. Refer to View Previous Issues for further information.

5:2

12.0

Instrument Designer User Guide


Drawing List

Revisions

Displays a list of all drawings with revisions (and their revisions). Sub-menu options are: Add Revisions Edit Revisions Used to create a new revision. Used to edit the current revision.

For details, refer to Revision Entry (Multiple Drawings). Print Publish Find Filter Refresh Print selected drawing(s) - if the drawing file exists. Publishes selected drawings to a folder. Refer to Drawing Publishing. Displays the Find window allowing a "Find' any Text string (anywhere within the grid). Displays the Filter window. Refer to Advanced Grid Filters for more information. Update entire grid with latest database information (useful in multi-user project environments).

5.1

Add a New Drawing


This topic describes how to manually add drawings to the Instrument Designer's Drawing List. Important: Drawings can also be added to the drawing list automatically by: 1. Checking the Engineer's Loop List for new loops Any new loops that have been marked as 'Drawing Required' will be imported into the Drawing List as a Loop Diagram. To import any Instrument Loops from Engineer use the 'Check for New Loops' command on the Tools tab. 2. Checking the Wiring Manager's Equipment List for new equipment Any equipment added that has been marked as Termination Dwg Required' will be imported into the Drawing List as a Termination Diagram. To import any Equipment from Wiring Manager use the 'Check for New Terminations' command on the Tools tab. Note: These two methods are the preferred way to populate the Drawing List as they automatically create the new Drawing List entry, assign the Drawing Type and populate the drawing titles based on your engineering data. The drawing title formats used can be user defined in the Drawing Title setup preferences window described later in this document. For more information refer to Import Drawings into the Drawing List topic. To Manually add a new Drawing to your Project From the Drawing List, click New, to display the Drawing Information window:

5:3

12.0

Instrument Designer User Guide


Drawing List

Note: Existing drawing entries can be copied to create a new drawing record in the Drawing List by selecting an existing record then using the Copy Selected command in the drop down menu next to New in the toolbar menu. Note: All of the data entry fields in this Drawing Information window can automatically update each drawing by using DataLinks to link the database data to drawing attributes. Drawing Information Overview The only text box that requires data is Drawing No. This field is used to create the drawing filename. The filename is always DrawingNo + '-' + SheetNo (e.g XXXXX-1). However, every drawing must have either a Template or a Seed file associated with the drawing. The Template drop-down list shows a list of all templates drawings created for the current project (all drawings in the Project Template directory). The Seed field shows a list of all Seed drawings created for the current project (all drawings in the Project Seed directory). Loop No should be entered if the drawing will represent a Loop. This loop number is used by Designer to locate all relevant engineering data for the loop (and its associated instruments) from the AVEVA Instrumentation project database. An equipment number should be entered if the drawing will represent an equipment Termination Diagram. This equipment number is used by Designer to locate all relevant

5:4

12.0

Instrument Designer User Guide


Drawing List

Wiring/Cable data for the loop (and its associated instruments) from the AVEVA Instrumentation project wiring database. To enter an equipment number, click n the command button next to 'Equipment No' text.The Options window is then displayed:

Click Change Equipment to display the Select Equipment window:

Select the required equipment from the list and click Select. Refer to Wiring Manager documentation for more details of the Select Equipment window. Create a Loop Diagram If the drawing is a Loop Diagram, you must assign the Engineering Loop Number by clicking on the small command button next to the Loop No text box (which is shown when the

5:5

12.0

Instrument Designer User Guide


Drawing List

'Drawing Type' combo box is set to 'Loop Diagram'). This will open the Assign Drawing to Loop window which provides a list of Loops defined in the Instrument Engineer application. These fields are mandatory: A valid Loop Number from the Engineer Loop List must be entered in the 'Loop No' text box (as described above) A drawing number must be entered in the 'Drawing' No text box A valid Template drawing must be entered in the 'Template' text box

It is possible to create a multiple drawing sheet loop diagram by creating multiple records in the Drawing List (each with a different sheet number). Users can assign a different Template to each drawing if required. Create a Termination Diagram If the drawing is a Termination Diagram, you may assign the Equipment Number by clicking on the small command button next to the Equipment No text box (which is shown when the 'Drawing Type' field list is set to 'Termination Diagram'). These fields are mandatory: A valid Equipment Number from the Wiring Manager Equipment List must be entered in the 'Equipment No' text box (as described above) A drawing number must be entered in the 'Drawing' No text box A valid Seed drawing must be entered in the 'Seed' text box

Drawing Author Information This tab is used to record the identities of the drawing author, designer, checker and approver, and when these activities were completed.

The tab is also used to specify the design status and enter and alternate document number and work pack number if required. Drawing Title This tab is used to enter the drawing title, as it will appear on the drawing itself, plus remarks on the drawing.

5:6

12.0

Instrument Designer User Guide


Drawing List

Revision History The Revision History list (in the 'Revisions' tab) shows all revisions for the current drawing:

Revisions Tab Command Buttons Add Allows a new revision to be added to the current datasheet by displaying the Revision Entry window. Refer to Revision Entry (Single Drawings) for more information. Allows editing the currently selected revision by displaying the Revision Entry window. Refer to Revision Entry (Single Drawings) for more information.

Edit

Note: Double-clicking on any existing Revision will also bring up the Revision Entry window. Delete Allows deletion of the currently selected revision.

Note: Pressing the <Delete> key on any existing Revision will also delete the currently selected revision. AVEVA Instrumentation also allows addition of revisions to multiple drawings in one command. For information on this feature refer to Revision Entry (Multiple Drawings).

5:7

12.0

Instrument Designer User Guide


Drawing List

Note: Adding a new Revision changes the Current Revision of the drawing in the Drawing List to the new Revision Number. Drawing Notes The user can add notes to the drawing by clicking the Notes tab.

Reference Drawings This tab enables a user to add manual drawing references for the current drawing:

User Fields This tab is used to enter any additional project or user-specific information on the drawing in the six fields provided.

5:8

12.0

Instrument Designer User Guide


Drawing List

5.2

Drawing Information
To edit or view existing Drawing Information in the project, from the Drawing List, click Edit, or double-click on the drawing record in the Drawing List to display the Drawing Information window.

5:9

12.0

Instrument Designer User Guide


Drawing List

Note: All of the data entry fields in the Drawing Information window can be automatically updated for each drawing by using DataLinks to link the database data to drawing attributes. Note: The Last Edit field displays the date and time when the drawing data was last edited. The user name of the individual that performed the edit is displayed in a tool-tip when the mouse cursor is hovered over the field. Click the button in the field to display the Audit Manager, which will display a list of all the changes to the drawing data. This functionality is only available for SQL database projects. For Access database projects, the Last Updated: text displays the date and time of the last edit.

Things to Know about this Drawing Information Window


To Create a Loop Diagram A valid Loop Number from the Engineer Loop List must be entered in the 'Loop No' text box A valid Template drawing must be entered in the 'Template' text box

If the drawing is a Loop Diagram, you may edit the Engineering Loop data by clicking on the small command button next to the Loop No text box (if the drawing represents a loop diagram. This will bring up the Loop Data Edit window enabling full editing of both loop definition and instrument definitions. These windows come from the Instrument Engineer application, only if it is installed. To Create a Termination Diagram A valid Equipment Number from the Wiring Manager Equipment List must be entered in the 'Equipment No' text box A valid Seed drawing must be entered in the 'Seed' text box

If the drawing is a Termination Diagram, you may edit the equipment's Termination by clicking on the small command button next to the Equipment No text box (if the drawing represents a Termination diagram). This displays the Equipment Data window. This functionality comes from the Wiring Manager application (and only available if Wiring Manager is installed). Note: Double-click on any date field to bring up the Date Selection window (or press the Enter key when the date field has focus). Revision History The Revision History list (in the 'Revisions' tab) shows all revisions for the current drawing:

5:10

12.0

Instrument Designer User Guide


Drawing List

Revisions Tab Command Buttons: Add Allows a new revision to be added to the current datasheet by displaying the Revision Entry window. Refer to Revision Entry (Single Drawings) for more information. Allows editing the currently selected revision by displaying the Revision Entry window. Refer to Revision Entry (Single Drawings) for more information.

Edit

Note: Double-clicking on any existing Revision will also bring up the revision entry window. Delete Allows deletion of the currently selected revision.

Note: Pressing the <Delete> key on any existing Revision will also delete the currently selected revision. AVEVA Instrumentation also allows addition of revisions to multiple drawings in one command. For information on this feature refer to Revision Entry (Multiple Drawings) topic. Note: Adding a new Revision changes the Current Revision of the drawing in the Drawing List to the new Revision Number. Drawing Notes Drawing Notes (in the 'Notes' tab) shows all notes for the current drawing:

5:11

12.0

Instrument Designer User Guide


Drawing List

Reference Drawings This tab enables a user to add manual drawing references for the current drawing:

User Fields This tab is used to enter any additional project or user-specific information on the drawing in the six fields provided.

5:12

12.0

Instrument Designer User Guide


Drawing List

5.3

Rename Selected Drawings


The Rename Selected Drawings facility allows the user to rename drawings in batches. It is active under the Tools tab when working in the Drawing List and Hookup Drawing List grid views. The user must select the items to be renamed in the grid view and then click Rename Selected Drawings on the Tools tab to display the Batch Drawing Rename window.

The user must enter a value into the Number field. The value can be numeric, alpha or a combination of the two. If the user enters any alpha characters the Increment checkbox next to the Number field cannot be used. Entering numeric values only, allows the user to check the Increment box which will cause the Drawing Numbers of the selected items to be incremented by one. The user must choose between using the existing sheet numbers by checking Use Current Sheet Number box or to enter a new value in the Sheet No field. Using the Sheet No field allows the user to check the Increment box to increment the sheet numbers by one. If neither option is used a message is displayed requesting the user make a choice.

The Prefix and Suffix fields can optionally be used to add prefixes and suffixes to drawing numbers. They can be numeric, alpha or a combination of the two. If the user enters any alpha characters in the Suffix field the Increment checkbox cannot be used. This checkbox can be used to set the suffix to be incremented instead of the drawing number. If the drawing number is set to be incremented, the suffix cannot be set to be increment, and vice versa.

5:13

12.0

Instrument Designer User Guide


Drawing List

When values are entered, a preview of the new drawing number is displayed under the Suffix field.

When the required fields have been completed the user must click Ok to accept the values and display the Select Drawings for Renaming window or click Cancel to close the Batch Drawing Rename window and return to the grid view. If the new number already exists the Duplicate Drawing Numbers window is displayed warning the user that the number cannot be used.

5:14

12.0

Instrument Designer User Guide


Drawing List

Export to Excel opens a window allowing the user to name the Excel file and save the file to a chosen location. Print opens a Print Preview window allowing the user print the log. Clicking Close, closes the Duplicate Drawing Numbers window and returns the user back to the grid view without renaming the file. The Select Drawings for Renaming window lists all the drawings selected in the grid view and displays the Old Drawing No, Old Sheet No, New Drawing No and the New Sheet No.

5:15

12.0

Instrument Designer User Guide


Drawing List

The user can select individual drawings to be renamed by clicking the appropriate checkboxes. To select all the drawings the user can click Select All to check all the boxes. Clicking Cancel closes the Select Drawings for Renaming window and returns the user back to the Batch Drawing Rename window. After selecting the required drawings, clicking Rename Drawings displays the Renamed Drawing Log window which displays the status of the renamed drawings.

5:16

12.0

Instrument Designer User Guide


Drawing List

Export to Excel opens a window allowing the user to name the Excel file and save the file to a chosen location. Print opens a Print Preview window allowing the user print the log. Clicking Close, closes the Renamed Drawings Log window and returns the user back to the grid view which refreshes to display the new drawing names.

5.4

Import Drawings into the Drawing List


Instrument Designer allows the importing of loop diagram and termination diagram drawing records from other AVEVA Instrumentation applications and from Excel: Drawing Type Loop Diagrams Application Engineer From When the 'Drawing Required' option is selected in the Loop List (or Loop Detail window) When the 'Dwg Required' option is selected in the Equipment List (or Equipment Detail window)

Termination Diagrams

Wiring Manager

Loop Diagram Import


To check Engineer's Loop List for loop drawings: From the Drawing List, activate the Tools menu, click Check for New Loops command. The Drawing Check Options window is then displayed:

Select the required option or options: If the Check For New Loop Drawings option is selected, new Loop Diagrams will be added to the Drawing List for each new loop found in Engineer. If the Check and Update Existing Loop Drawings option is selected, details of loops that already have diagrams in the Drawing List are checked, and the details in the Drawing List are updated if changes are detected. If the Check for Deleted Loops option is checked, Loop Diagrams for any loops that have been deleted from Engineer will be removed from the Drawing List.

Click Check.

5:17

12.0

Instrument Designer User Guide


Drawing List

The Engineer Loop List is then checked for new, updated and/or deleted loops depending on the option(s) specified. A Progress window displays the progress of the check:

When the procedure is completed, the number of added, changed and/or deleted Loop Diagrams is displayed:

The following table shows where the data from the Loop List goes in the Drawing list: Drawing List Column Drawing No Loop No Type Title 1 Title 2 Title 3 Loop List Column Loop No Loop No (the words 'Loop Diagram') As user defined in Drawing Title Setup Preferences As user defined in Drawing Title Setup Preferences As user defined in Drawing Title Setup Preferences

These Drawing List columns are completed for new Loop Diagrams in the list when the Check For New Loop Drawings option is selected, and updated (when there are any changes) when the Check and Update Existing Loop Drawings option is selected.

Termination Diagram Import


To check Wiring Manager's Equipment List for termination drawings: From the Drawing List, activate the Tools menu, click Check for New Terminations command. The Drawing Check Options window is then displayed:

5:18

12.0

Instrument Designer User Guide


Drawing List

Select the required option or options: If the Check For New Termination Drawings option is selected, new Termination Diagrams will be added to the Drawing List for each new equipment found in Wiring Manager. If the Check and Update Existing Termination Drawings option is selected, details of equipment that already have drawings in the Drawing List are checked, and the details in the Drawing List are updated if changes are detected. If the Check for Deleted Equipment option is checked, Termination Diagrams for any equipment that has been deleted from Wiring Manager will be removed from the Drawing List.

Click Check. The Wiring Manager Equipment List is then checked for new, updated and/or deleted equipment depending on the option(s) specified. A Progress window displays the progress of the check:

When the procedure is completed, the number of added, changed and/or deleted Termination Diagrams is displayed:

5:19

12.0

Instrument Designer User Guide


Drawing List

The following table shows where the data from the Equipment List goes in the Drawing list: Drawing List Column Drawing Number Equipment No Type Title 1 Title 2 Title 3 Equipment List Column Equipment No Equipment No (the words 'Termination Diagram') As user defined in Drawing Title Setup Preferences As user defined in Drawing Title Setup Preferences As user defined in Drawing Title Setup Preferences

These Drawing List columns are completed for new Termination Diagrams in the list when the Check For New Termination Drawings option is selected, and updated (when there are any changes) when the Check and Update Existing Termination Drawings option is selected. Importing from Excel Drawings can also be imported from an Excel spreadsheet. Refer to Import from Excel.

5.5

Drawing Title Setup Preferences


Designer allows importing of loop diagram and termination diagram drawing records from other AVEVA Instrumentation applications as described in Import Drawings into the Drawing List topic. AVEVA Instrumentation enables users to define how the drawing titles will be created based on values assigned to the loop or equipment engineering data. To Define Loop Diagram Drawing Titles From the Application menu, click Setup, click Loop Titles (Import format) command, this displays the following window:

The window contains three text boxes that defines each of the Drawing List's title data fields. Each title can contain a mixture of text and DataLinks. On importing a new loop diagram from Engineer's Loop List, AVEVA Instrumentation will replace the DataLinks with the value

5:20

12.0

Instrument Designer User Guide


Drawing List

for the database field within the DataLink. For example: Title 1 above is defined as: AREA {AreaNo}. On 'Check for New Loops' if AVEVA Instrumentation found a new loop in area 21 then Title 1 would be: AREA 21. To edit each import Title, open the field on the right of Title text box for the desired title field. To select a DataLink, check the appropriate checkbox in the field for the DataLink(s) required. AVEVA Instrumentation will add the selected DataLink to the Title text box. The 'Title' text box can be edited manually, text added or deleted as required. Use Save to save the Title format. Each Title format can be set by again clicking on each command button as described above. To Define Termination Diagram Drawing Titles From the Application menu, click Setup, click Termination Titles (Import format) command, this displays the following window:

The window contains three text boxes that defines each of the Drawing List's title data fields. Each title can contain a mixture of text and DataLinks. On importing a new termination diagram from Wiring Manager's Equipment List AVEVA Instrumentation will replace the DataLinks with the value for the database field within the DataLink. For example: Title 1 above is defined as: AREA {AreaNo}. On 'Check for New Terminations' if AVEVA Instrumentation found a new equipment in area 21 then Title 1 would be: AREA 21. To edit each import Title, open the field button on right of Title text box for the desired title field, this displays the list of available DataLinks for a Termination diagram. To select a DataLink, check the checkbox for the DataLink(s) required. AVEVA Instrumentation will add the selected DataLink to the Title text box. The 'Title' text box can be edited manually, text added or deleted as required. Use Save to save the Title format. Each Title format can be set by again clicking on each command button as described above.

5:21

12.0

Instrument Designer User Guide


Drawing List

5.6

Update Drawings
To updates selected drawing and force DataLinks in each CAD drawing to be updated with current project data from the AVEVA Instrumentation database, select the drawing(s) in the Drawing List and click Upgrade. Each selected drawings in then opened in AutoCAD. The Update Options window is displayed:

The dialog is used to specify whether or not the drawings are to exported when they are saved, whether or not changes in the drawing are to be highlighted with revision clouds, and whether or not the drawings are to be plotted when they are saved. If the export option is selected, the drawings are exported to a pre-defined folder or folders with file names in a pre-defined, user-defined format. The folder(s) and the file name format are specified using facilities accessed from the Application > Setup menu. Refer to Export Drawings to Pre-Defined Folders with File Names in a Pre-Defined Format for details.

5:22

12.0

Instrument Designer User Guide


Drawing List

5.7

Revision Entry (Single Drawings)


Revisions for an individual drawing can be added/edited using the Revision Entry window accessed from the Drawing Information:

Note: Double-click on the Date text box to bring up a date selection form (you can also press the Enter key when the Date text box has focus). Note: The Description field contains a list of all previously created revision descriptions. You can add a new description by entering any desired description. Any new descriptions will be available in future Revision Entry. Command Buttons Create New Creates a new Revision with data entered in the Revision Details fields.

Note: When creating a new revision leaving the Revision No text box blank will cause Designer 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. Edit Current Cancel Changes the current revision record to data entered in the window fields above. Exits without saving changes or adding a revision.

Designer also supports adding/editing revisions with multiple datasheets. This is done from the Drawing List. Refer to Revision Entry (Multiple Drawings) topic.

5.8

Revision Entry (Multiple Drawings)


Revisions for multiple drawings can be added/edited using the Revision Entry window accessed from the Drawing List window: From the Revisions toolbar pull-down command, select: either, Add Revision command option, or Edit Revisions command option.

5:23

12.0

Instrument Designer User Guide


Drawing List

When revision entries are added or edited from this command the Revision Entry window entries (below) are assigned to ALL selected drawings, enabling assignment or modification to multiple drawings in a single command.

Note: Double-click on the Date text box to bring up a date selection form (you can also press the Enter key when the Date text box has focus). Note: The Description field contains a list of all previously created revision descriptions. You can add a new description by entering any desired description. Any new descriptions will be available in future Revision Entry. Revisions The Revisions window is displayed. This lists all drawings. To view the revisions for a single drawing, click on the + icon next to its listing. To view revisions for all drawings, click Show All Revs. To edit and existing revisions press Edit. The Multi-Field Edit (Bulk Edit) window is displayed. To edit a revision field, check the appropriate checkbox and enter the new value. Click Save. To add a new revision, click New. The Revision Entry window (described in Drawing Title Setup Preferences and Revision Entry (Single Drawings)) is then displayed, enter the required details and click Save.

5.9

Drawing Issues
To issue a drawing or drawings, select them in the Drawing List grid and click Issue. If there are reasons why selected drawings cannot be issued, they are listed in the Error Summary window.

5:24

12.0

Instrument Designer User Guide


Drawing List

Click Cancel to stop the procedure. Click Continue to continue with the issue of any other selected drawings. The first of the selected drawings for which errors were not detected is then issued as described next. A progress dialog for the issue is displayed:

If the drawing 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.

5:25

12.0

Instrument Designer User Guide


Drawing List

Click Cancel to cancel the issue or OK to create a new revision. Refer to Revision Entry (Single Drawings) for further information on creating a new revision. Once the revision has been created, the issue procedure automatically resumes. The issued drawing is then opened in AutoCAD, and the Update Options dialog is displayed. Refer to Update Drawings for details. If multiple drawings have been selected for issue, each is issued one at a time, as described above.

5.9.1

View Previous Issues


To see previous issues click either Open Issues For Selected or Open Issues For All accessible from the drop-down menu displayed by clicking the button next to the Issue button.

The Issues dialog is then displayed.

5:26

12.0

Instrument Designer User Guide


Drawing List

If Open Issues For Selected was clicked the dialog lists all the issues for the drawing currently selected in the grid. If Open Issues For All was clicked the dialog lists all the issues for all the drawings 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 drawing may still be opened and viewed. Command Buttons: Open Delete Open the selected issues in AutoCAD. Deletes the selected issues. A confirmation message is displayed before the deletion takes place.

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

5:27

12.0

Instrument Designer User Guide


Drawing List

Print Find Filter Refresh Close

Prints the selected issues. Displays the Find window to search by any text string located anywhere within the grid. Opens the Advanced Grid Filters window used to define the current grid view filter criteria. Updates entire grid with latest database information (useful in multi-user project environments). Closes the window.

5.10

Non-AI Termination Drawing References


To view, add and edit list of non-AVEVA Instrumentation Termination Drawing numbers for equipment, from the Tools tab, click Termination Ref Drawing Nos (non-AI). The Termination Drawing References window is then displayed:

To add a new drawing reference, click New. A new row is then added to the window. Enter the equipment number and the drawing number in the fields provided. To edit a drawing reference, type new values into the references fields as required. To delete a drawing reference, click on it, then click Delete. A message is then displayed requesting that the deletion be confirmed. Click Yes to proceed with the deletion. Only one drawing reference can be deleted at a time.

5:28

12.0

Instrument Designer User Guide


Drawing List

To save changes made to the list of drawing references and to exit the window, click Save. To exit the window without saving, click Cancel.

5.11

Drawing Publishing
Drawings in the Drawing List (and also the Hookup Drawing List) can be published, i.e. their AutoCAD files saved to a pre-defined location. PDF versions of the published drawings may also be produced. The folder that drawings are published to, whether or not PDF versions of the published files are to be produced, and other options are specified using the Publishing Configuration window.

5.11.1

Publishing Configuration
Before drawings can be published, a number of configuration options must be specified. Select Setup > Drawings Publishing Configuration from the application menu. The Publishing Configuration window is then displayed:

In the Publishing folder field, enter the folder into which drawings are to be published, or click and browse for it. If PDF versions of published files are to be generated using AutoCAD, in addition to the published DWG files, check Publish as PDF.

5:29

12.0

Instrument Designer User Guide


Drawing List

If PDF versions of published files are to be generated using a PDF generator other than AutoCAD, in the Executable to handle publishing field, enter the name and location of the executable file that will handle the publishing, or click and browse for it. If Publish as PDF is checked, this setting will be ignored. For each published drawing, an XML file containing selected drawing data is also produced in the publishing folder. To select the drawing data that the XML file will include, click Add. A blank row is added to the area below this button. From the drop down list in this row, select the required drawing data. Repeat for each type of drawing data required. To delete a row, select it and click Delete. A message will be displayed requesting that the deletion be confirmed. Click Yes. If no fields are selected, the XML files are not generated. To save configuration changes and exit the window, click Save. To exit the window without saving any changes, click Cancel.

5.11.2

Publishing Drawings
To publish drawings, select them in the grid and click Publish. Multiple drawings can be selected and published. The drawings will then be published to the publishing folder along with (optionally) the PDF and XML data files. The Print Options window is then displayed.

Specify the required print options and click Print. The PDF files are then generated. If PDF versions of the drawings are to be generated using another PDF generator, this is used to generate the PDFs instead.

5:30

12.0

Instrument Designer User Guide


Drawing List

Any errors that occur during the publishing process are reported in the Error Summary window.

Click Continue to carry on with the procedure or Cancel to stop it.

5:31

12.0

Instrument Designer User Guide


Drawing List

5:32

12.0

Instrument Designer User Guide


Drawing Generation

Drawing Generation
The following section describes how Designer generates CAD drawings from the Drawing List. However, before any CAD drawing can be created a drawing record must exist in the Drawing List for each drawing you wish to create as a CAD file. This topic assumes drawing records already exist. Note: To add a drawing record to the drawing List use either the Add a New Drawing command button or import drawings from the Engineer's instrument list (loop diagrams) or Wiring Manager's equipment list (termination diagrams) using the Import Drawings into the Drawing List commands. Updating CAD Text/Attributes Designer uses DataLinks to establish a link between a value in the AVEVA Instrumentation project database and a drawing block attribute so that when a drawing is generated by Designer the CAD attribute is automatically updated with the data from the database. DataLinks can be linked to data such as project name or number or client name from Project Data, or drawing number or title from the Drawing List, Loop No, Tag No, Cable No or other engineering data from Engineer or Wiring Manager data. Once the DataLinks are added to a drawing they ensure that the engineering data in drawings is the same as that currently in the project database. Refer to the DataLinks Reference for more information. Loop Diagrams and Hookup Drawings Template files are used as templates for both loop diagrams and Hookup (installation) drawings. Templates are copied to create the drawing file and are not modified graphically, except for text values (AutoCAD attribute values) that have DataLinks assigned. When a drawing based on a Template is updated every DataLink is evaluated and translated into a value based on the current drawing's data and is placed into its corresponding drawing attribute. DataLinks are easily placed into templates file blocks, refer to Assigning DataLinks in AutoCAD. To create a loop diagram the Loop No field for the drawing must contain a valid project loop number from the Engineer Loop List. To create a Hookup drawing the drawing must be assigned to a Hookup template via the Add a New Hookup Drawing window. Loop and Hookup Drawing Creation There are two Designer Drawing List commands that can create a CAD drawing 'Open' and 'Update':

6:1

12.0

Instrument Designer User Guide


Drawing Generation

Command Open Update

Functionality

Remarks

Opens drawing file, no data Only applicable to one drawing at a time is updated Opens drawing file and Can be used on any number of selected updates data via AVEVA drawings Instrumentation DataLinks

Think of these commands as: Open - View the current drawing in CAD. Update - update the drawing with database information (Datalinks -if any), then view the updated drawing in CAD.

When either of these commands is used Designer does the following: If Drawing file Exists Opens the drawing file in CAD If Updating, then DataLinks are updated (design data is copied from the database) If Drawing file does NOT Exist If drawing has a Template then the Template file is copied to create the Drawing file. Opens the drawing file in CAD If Updating, then DataLinks are updated (design data is copied from the database into the drawing block attributes). Important: The template is only copied if the drawing file does not exist. Therefore, any changes you make in a drawing once created from a template will remain in the drawing and those changes will NOT be overwritten. This gives the flexibility to start a drawing based on a template, then modify that drawing as required, in affect making the drawing a template for itself.

Termination Diagrams Seed Files are used as a base to start automated drawing activity and are used to create termination drawings. Typically a Seed File contains the drawing title block, (and company logos) revision blocks etc with attributes and DataLinks attached). When a drawing based on a Seed File is updated, every DataLink is evaluated and any change is placed into its associated drawing attribute (e.g. Title Block and revision data is updated in the drawing). If the drawing being updated is a Termination Diagram (actually if it has an Equipment No value, in the Drawing List), then the existing drawing file (if any) is deleted and created again by copying the seed file, then terminations are parametrically (automatically) drawn based on the Wiring Manager's termination data for that equipment number and the Seed drawings parameter data. Seed File parameters include drawing sheet size (physical dimensions), the maximum number of terminal strips per drawing, maximum number of terminals per terminal strip/Din Rail, spacing between terminal strips etc. Refer to Seed Drawings List for more information.

6:2

12.0

Instrument Designer User Guide


Drawing Generation

In addition to the Seed File parameters, which are defined per Seed File, AVEVA Instrumentation provides user Project definable preference settings that control drawing parameters such as terminal height/width, cable core/wire length, text heights etc. These Project preferences are set in Designer's Auto Inserting Blocks window. To create a termination diagram the Equipment No field must contain a valid project equipment number from the Wiring Manager's Equipment List (or Equipment View) and there must be internal terminals/devices with cable/wire connections. Termination Drawing Creation There are two Designer Drawing List commands that can create a CAD drawing Open and Update: Command Open Update Functionality Remarks

Opens drawing file, no data is Only applicable to one drawing at a time updated Recreates drawing file and Can be used on any number of selected updates data via AVEVA drawings Instrumentation DataLinks

Think of these commands as: Open - View the current drawing in CAD. Update - Recreate the drawing with database information (if any), then view the updated drawing in CAD.

When Update is used Designer does the following: If Drawing file exists or If Drawing file does NOT exist: The Seed file is copied to create the Drawing file. Opens the drawing file in CAD then DataLinks are updated (design data is copied from the database into the drawing block attributes). Terminations are parametrically (automatically) drawn based on the equipment layout/ terminations designed in the project database.

6.1

Open a Template Drawing with AutoCAD


To open a template file in AutoCAD the user can start AutoCAD and then use the file open command and navigate to the project template folder. Use the Project menu > Edit menu option (from the Drawing List window) to view the template folder name. Alternatively you see all the current template files for your project and open them in AutoCAD from within Designer: Activate the View tab, select Template List option. This displays the Template List window below:

6:3

12.0

Instrument Designer User Guide


Drawing Generation

This window contains a list of all drawing files in the project template folder. 'Times Used' shows the number of drawings in the Drawing list that use each template. Note: If you have created templates in another folder copy them to the project Template folder and they will appear in this list the next time the Templates list is opened. Note: To find out what the project template folder is use the Project menu's Edit option. This displays a window that contains all your project settings including the names of folders being used by AVEVA Instrumentation. To Open a Template in AutoCAD: Select the template file name, click Open File AutoCAD then starts (if not already running) and the file is opened. Note: This window allows you to open templates drawings only. To create a new Template you should copy the templates you create into your project's Template folder or use AutoCAD's Save As command to save to that folder.

6.2

Assigning DataLinks in AutoCAD


To assign or modify DataLinks to an AutoCAD template or seed drawing file the file first needs to be opened using AutoCAD. Refer to Open a Template Drawing with AutoCAD to learn how to open a Template drawing file. Refer to Seed Drawings List to learn how to open a Seed drawing file. Use the Designer AutoCAD Menu To assign new DataLinks (or modify DataLinks already assigned) you need to ensure the Designer AutoCAD menu is loaded into AutoCAD. This toolbar menu should be automatically loaded when an AutoCAD drawing is opened from Designer.

6:4

12.0

Instrument Designer User Guide


Drawing Generation

Note: If the 'iDesigner' menu is not auto loaded you will need to load the following menu manually (using the AutoCAD 'menu' command): AutoCAD Version AutoCAD 2000, 2000i, 2002 AutoCAD 2004 AutoCAD 2005, 2006, 2007, 2008 Designer AutoCAD Menu Designer.mns Designer2004.mns Designer2005.mns

These menu files are located in the AVEVA Instrumentation program installation folder (typically: 'c:\program files\AVEVA Instrumentation\AVEVA Instrumentation'). To Assign/Edit DataLinks Once the AutoCAD iDesigner menu is loaded select: iDesigner from the pull-down menus > Edit DataLinks This displays a window showing all attributes in the selected AutoCAD block. AutoCAD will prompt you to Select Objects, select a block with attributes, then press enter. AutoCAD will bring up the DataLinks Edit window as below:

This window shows all attributes defined in the block selected. The text boxes all contain DataLinks. Note: To view available Keyword DataLinks for any drawing in the Designer's Drawing List bring up the DataLinks Report Window. This window enables 'copy and paste facilities' of DataLinks from the report window into the AutoCAD 'Edit DataLinks' window above. To assign a DataLink you can either type in a valid DataLink or you can copy from the DataLinks window report created for a drawing that will use this template or seed. DataLinks can be copied from the DataLinks Report window (using Windows copy and paste - Ctrl-C / Ctrl-V etc) or dragged and dropped (hold the Ctrl key and drag the report DataLink to a text box above). Refer to DataLinks Reference for more information on DataLinks.

6:5

12.0

Instrument Designer User Guide


Drawing Generation

Copying Blocks with DataLinks in AutoCAD Since DataLinks are defined as Extended Entity Data within AutoCAD their behaviour is same as Xdata. That is, if you copy a block with DataLinks attached the DataLinks are copied too. This can drastically reduce your data entry when setting up DataLinks. For example, you can attach your required DataLinks to a block that may represent a Field Device. Then copy that block to as many drawings as you wish, saving you the effort of reentering the DataLinks each time. Another example is the Title block used in all drawings. Set up the first drawing with all DataLinks, once it has been tested then copy that Title Block (which may contain multiple AutoCAD blocks) to your other drawings. Auto-Erasing Blocks with DataLinks in AutoCAD Designer provides an 'Auto-Erase' (or auto-delete) function where a block will be automatically erased from a drawing if a specific DataLink returns nothing. If you prefix your DataLink attribute with <DEL> and AVEVA Instrumentation detects that the following DataLink has no value then Designer will erase the block containing the <DEL> Datalink. For example you may wish to erase a block if there is no tag number for {TAG10}. So entering: <DEL>{TAG10} in for an attribute in a block will tell AVEVA Instrumentation to erase the block if {TAG10} evaluates to nothing (i.e. there is no TAG10 for this drawing).

6.3

DataLinks Report Window


To View DataLinks for any Drawing in your Project First, select a Drawing from the Drawing List, then click Reports, followed by DataLinks for selected drawing. Or, right-click on a Drawing in the Drawing List click, Show DataLinks from the context menu. The DataLinks window is then opened which shows all DataLinks generated for the selected drawing. DataLinks are grouped into logical groups. Note: DataLinks are created based on the current drawing type (i.e Loop, Termination or Hook-up Diagram) AND the current engineering data assigned to the AVEVA Instrumentation object type (i.e Loop, Equipment or Hookup Type). A complete set of DataLinks is not available to each drawing until the engineering data is complete (i.e. the loop wiring, equipment terminations or hookup template is finished). To view DataLinks for a group select the '+' box at the left of the group name:

6:6

12.0

Instrument Designer User Guide


Drawing Generation

The example above shows DataLinks for the Drawing List Data group. If the DataLink {DWGNO} is placed in the AutoCAD drawing file then it will be updated during auto generation with the value "01-80001". For more technical information about DataLinks refer to DataLinks Reference. The DataLinks are grouped by Type (e.g. Project Data, Drawing List, Loop List, Instrument List, DCS I/O, Wiring etc). This grid can be printed for reference or users can copy and paste into AutoCAD Templates etc via Designer. DataLinks can be copied from this DataLinks window directly into the AutoCAD symbols (blocks) used as templates for loop diagrams and/or title blocks used as Seeds. To copy a DataLink select one (click on the DataLink) and use the Ctrl + C keys to copy to the Windows clipboard. Then select the AutoCAD DataLink text box and paste the DataLink value. Refer to Assigning DataLinks in AutoCAD. DataLinks can also be copied by 'drag and drop' selecting one (click in the white space immediately to the left of the DataLink field) drag the DataLink into an AutoCAD DataLink text box and drop it (release the mouse button). When copied to an AutoCAD attribute the DataLink is stored within the Block inside AutoCAD. You may copy blocks (including DataLinks) within an AutoCAD drawing file or between drawing files using standard AutoCAD commands (copy, insert etc), any DataLinks will remain within the copied blocks and drawings. This means you can set up DataLinks for your typical blocks and then copy the block to make up new templates without having to assign Datalinks again to those blocks. Refer to Assigning DataLinks in AutoCAD.

6:7

12.0

Instrument Designer User Guide


Drawing Generation

The following table shows typical DataLinks shown for each group: Group Name Project Data: DataLink {ProjectNo} {ProjectName} {ProjectDesc} {PlantName} Drawing Data: {DwgNo} {Sheet} {NoOfSheets} {Title1} Drawing Revisions: {RevNo1} {Date1} {Revision1} {By1} Instrument Tag Data: {TAG1} {TAG1Manufact} {TAG1Model} Tag Wiring Data: {TAG1T1} {TAG1W1C1CableNo} {TAG1W1C1CableType} {TAG1W1C1Core} {TAG1W1E1} + C34FT1005 1Pr WH 34-JB-114 34-FT-1005 Honeywell TBA A 7/7/2003 ISSUED FOR REVIEW GRH 340-07-1045 1 1 Area 340 Example Value 25400 FuelX Modernisation Refinery Clean Fuels FuelX

DataLinks for Project Data, Drawing Data and Drawing Revisions are always the same regardless of drawing type being generated (whether the drawing is based on a Template or Seed or whether it is a Loop Diagram, Termination Diagram, Hookup or any other type). However, The Revision DataLinks always end in a number corresponding to Revision history sequence (example: {RevNo1} is always earliest Revision, {RevNo2} is the 2nd earliest etc). DataLinks for Instrument Tag Data always end in a number corresponding to the 'Loop Dwg Code' set for each instrument in the Instrument List. This number must be unique for each

6:8

12.0

Instrument Designer User Guide


Drawing Generation

instrument in a loop and is used to identify each instrument in the loop drawing. This 'Loop Dwg Code' can be modified from Instrument Engineer or Designer from the Drawing Information window or the 'LoopDwgCode' field can be added to a GridView in Engineer's Instrument List for bulk editing. Note: You may consider setting 'Loop Dwg Code' by instrument type. For example Transmitters = 11, Solenoid Valves = 51, Control Valves = 61 etc Why? To reduce editing associated with each DataLink in the AutoCAD templates. You can easily set up a set of blocks to represent a Transmitter and all its associated wiring, junction boxes, marshalling cabinet all using DataLinks like {TAG11. Once done you can copy this set of symbols to make up more complex loops containing transmitter, I/P, Limit switches etc.

6.4

Seed Drawings List


Seed drawings are used by Designer to create termination drawings. Seed drawings are normally just an empty drawing file containing a drawing title block (drawing frame with attributes). The title block will have attributes linked to the project database using DataLinks. In addition to the title block AVEVA Instrumentation requires specific parameters to enable termination diagrams to be auto-drawn. These parameters are set in the Seed Drawing List window. Note: To use a Seed file to auto-generate drawings all the Seed parameters below must be entered for the Seed file and the Seed file must be located in the AVEVA Instrumentation project 'Seed' folder. To open a the Seed Drawing List window which contains a list of all Seed files for your project: Activate the View tab, click Seed List. This displays the Seed List window below showing typical metric units:

This window contains a list of all Seed drawing files added to the project database through this window. Note: You must ensure that a Seed file is copied (or saved in AutoCAD) to the project seed folder with the same file name as the 'Seed File' name entered in the Seed List otherwise Designer cannot use the seed drawing to generate termination drawings. This Seed Drawing List contains important information used by Designer when termination drawings are parametrically created. The following parameters are required to be entered for all Seed drawings:

6:9

12.0

Instrument Designer User Guide


Drawing Generation

Parameter Seed File Description Size MaxNoOfTStrips MaxNoOfTerminals DefaultSpacing TStripStartX TStripStartY ExtentsMinY AllCablesVertical

Description A unique name that matches the Seed File name (the AutoCAD drawing file name). User defined description (optional). User defined size - used to help a user select the appropriate seed drawing size (optional). Maximum number of Terminal Strips you want placed on the drawing (See NOTE 1 below). Maximum number of Terminals to draw in a single vertical set of terminals before starting at the top again. Horizontal spacing between terminal strips. X coordinate where the first terminal strip will be started (the top left of the strip). Y coordinate where the first terminal strip will be started (the top left of the strip). Minimum Y coordinate in which AutoCAD can draw within the title block (affects bottom of vertically drawn cable). Defines whether all cables will be drawn to the bottom of the drawing sheet (to the ExtentsMinY above) - see Exceptions below.

Notes: 1. If the Equipment being drawn has multiple terminal strips or the number of terminals in a single terminal strip exceeds the MaxNoOfTerminals parameter then Designer will start a new strip of terminals. If the MaxNoOfTStrips is exceeded for the current equipment, then AVEVA Instrumentation will automatically create a new drawing sheet and continue to draw terminals/terminal strips until their are no more terminals/terminal strips for the Equipment. AVEVA Instrumentation will continue to create new sheets if required. 2. If the Equipment being drawn has terminal strips containing more terminals in a single terminal than the MaxNoOfTerminals parameter then Designer will start a new Terminal Strip to continue until all terminals are drawn. If the MaxNoOfTStrips in not exceeded the continuation Terminal Strip is drawn on the same drawing sheet. If the MaxNoOfTStrips is exceeded for the current equipment, then AVEVA Instrumentation will automatically create a new drawing sheet and continue to draw terminals/terminal strips until their are no more terminals. 3. ExtentsMinY controls the positioning of cables drawn to the bottom of the drawing. AVEVA Instrumentation will not draw below the ExtentsMinY. To Open a Seed in AutoCAD Select the Seed file name, click Open from the toolbar menu, AutoCAD then starts (if not already running) and the file is opened.

6:10

12.0

Instrument Designer User Guide


Drawing Generation

To Add a new Seed file, click New from the toolbar (existing seed records can be copied by using the 'copy' drop down toolbar command next to the New command). AVEVA Instrumentation will bring up the new seed window (the following figure shows the window after typical parameters have been entered for a metric drawing):

You should complete all parameters as described in the drawing units required in your AutoCAD drawing files (i.e. mm or inches) Parameter Seed File Name Description Size Max No. of TStrips Max No. of Terminals TStrip Start X TStrip Start Y TStrip Spacing Extents Min Y Draw All Cables Vertically Description A unique name that matches the Seed File name (the AutoCAD drawing file name). User defined description (optional). User defined size - used to help a user select the appropriate seed drawing size (optional). Maximum number of Terminal Strips you want placed on the drawing (See NOTE 1 above). Maximum number of Terminals to draw in a single vertical set of terminals before start at top again. X coordinate where the first terminal strip will be started (the top left of the strip). Y coordinate where the first terminal strip will be started (the top left of the strip). Horizontal spacing ('X') between terminal strips. Minimum Y coordinate in which AutoCAD can draw within the title block (affects bottom of vertically drawn cables). Defines whether all cables will be drawn to the bottom of the drawing sheet (to the Extents Min Y above).

6:11

12.0

Instrument Designer User Guide


Drawing Generation

Exceptions

If 'Draw All Cables Vertically' is selected (True) then the user may add a list of exceptions. Exceptions are cable types that will always be drawn horizontally and are entered with a comma delimiter. In the above example all cables will be drawn vertically except cables that are 1r, 2Pr, 4Pr, 1Tr, 2Tr, 1C, 2C etc as shown the Exceptions textbox.

Note: Remember that to use a new Seed file an AutoCAD drawing file with the same name as the seed entry must exist in the AVEVA Instrumentation project 'Seed Folder'.

6.5

Auto Inserting Blocks


Designer allows auto insertion of user defined blocks into any AVEVA Instrumentation generated drawing by adding block names to the Drawing List for any or all drawings. The inserted blocks can contain DataLinks that will be updated by AVEVA Instrumentation with project data. AVEVA Instrumentation supports up to 6 blocks per drawing. Blocks are always inserted at drawing coordinates 0,0. This feature was added to AVEVA Instrumentation to allow users to reduce the number of seed and template drawings as often the only difference between drawings is a different set of drawing notes etc. It can also be used in a situation where you are required to show detailed process data, such as a detailed 'P&ID' type bubble diagram on Loop Diagrams. In this case although the wiring is standardised and a simple template could be used on for example 50 loops (e.g. 2 Wire Analog Input to DCS), the process connections may be quite different. The Auto Inserting Blocks facility can be used here as only one template (wiring) is required but maybe 3 or 4 different 'P&ID' Blocks can be used depending on whether the transmitter is a D/P Flow connected to a orifice plate, a D/P Level transmitter connected to a vessel etc. Add an Auto Inserting Block To enable Designer to locate the user defined blocks, each block must reside in the current projects 'CAD Block/Circuit' folder as defined in the Project Setup window (Drawing Manager Project menu > Edit command. To assign blocks to a specific AVEVA Instrumentation Drawing add the block name to one of the Drawing List's six block fields (Block1, Block2, ..., Block6). The easiest way is to add the Block fields to a GridView using AVEVA Instrumentation Grid Manager or Hookup Drawing List Tools menu > Grid Manager command. Once the Block fields are in your Drawing List data grid select from the pull down list that appears in each 'Block' cell of the grid when the mouse is hovered over the cell. When generating the drawing AVEVA Instrumentation inserts any defined Blocks just prior to updating DataLink data so DataLinks can be embedded in the Auto Inserting Blocks successfully. Note: AVEVA Instrumentation only inserts these Blocks if the drawing is being created (i.e. the drawing file does not currently exist). If you wish to add Blocks to an existing drawing you will need to delete the drawing file prior to Update for the blocks to be auto-inserted.

6:12

12.0

Instrument Designer User Guide


Drawing Generation

6.6
6.6.1

DataLinks
DataLinks Reference
Designer allows any attribute within any AutoCAD drawing to be updated from the Instrument Design Office Project Database. A DataLink is attached to each block's attributes in a Template file or Seed file as Extended Entity Data (Xdata). Extended Entity data is invisible in AutoCAD, so the DataLinks will not effect the CAD file visually. Note: DataLink definitions are invisible within the drawing file and can only be accessed by an applications program such as Designer (or AutoLisp/Visual Basic etc). An AVEVA Instrumentation DataLink represents a data value that is replaced by the actual project data when updated by Designer. When a drawing is updated by Designer all AutoCAD attributes that contain a DataLink are automatically updated with the current data from the AVEVA Instrumentation project database. This data could include title block and revision information as well as engineering, wiring or other project data. Types of DataLinks Designer uses two types of DataLinks: Keywords. These are always enclosed in curly brackets {} Examples:

{DwgNo} {Title1} {Tag1}

returns the value of the Drawing Number field for the current drawing. returns the value of the Title1 field of the Drawing List for the current drawing. returns the Tag No of the first instrument in current loop (if the current drawing is a Loop Diagram).

Note: Refer to DataLink Keyword Samples for a comprehensive list of Keyword DataLink definitions used within Designer. SQL Statements. These are always enclosed in curved brackets ( ) and are written in the form of a standard SQL (Structured Query Language) query definition for database access:

(SELECT Field1 FROM TableName WHERE Field2 = Value)


For Example:

(SELECT ModelNo FROM InstrumentList where TagNo ='FT-600')


returns the ModelNo field value from the InstrumentList table where the TagNo field is equal to FT-600). Keyword DataLinks are predefined within the Designer and cannot be user defined. SQL Statements are user definable and are included to enable advanced users to access data that has not been defined as a Keyword DataLink. Note: To view available Keyword DataLinks for any drawing in the Designer's Drawing List bring up the DataLinks Report Window.

6:13

12.0

Instrument Designer User Guide


Drawing Generation

Multiple DataLinks Designer supports multiple DataLinks for each Block Attribute. They can be used to update multiple values within a single attribute. For Example: Attribute with DataLinks: {DWGNo} {Rev1} would fetch the current drawings 'Drawing No' and 'Rev1' fields and append them together with a space in between (such as D1234 A - if 'Drawing No was: 'D1234' and Revision 1 was 'A'). You may also concatenate character or numerical values within the DataLink definition. For Example: Attribute with DataLinks: Dwg No.{DWGNo}-{Rev1} would fetch the current drawings 'Drawing No' field and append it after the characters 'Dwg No. ' followed by a '-' (dash) followed by the current drawings value of the 'Rev1' field. Nested DataLinks Designer supports Nested DataLinks for each Block Attribute. They can be used to update multiple values within a single attribute or used as a lookup value in a SQL type DataLink. For Example: Attribute with DataLink: (SELECT DrawnBy FROM Drawings WHERE DwgID = {DwgID}) Here the Keyword DataLink {DwgID} is being used as the value to search for in the DwgID field of the Drawings table. Another Example: Here's how you can get access to any data from the InstrumentList: In the following DataLink the Keyword DataLink {TAG1Key} is unique name of instrument 1 in the loop currently being created/updated. We use that value to lookup a field in the AVEVA Instrumentation InstrumentList table. Here we are returning the value of 'UserField1'. (SELECT UserField1 FROM InstrumentList WHERE InstKey= {TAG1Key}) Attaching DataLinks to Attributes in AutoCAD Open the Template, Seed or Drawing File using Designer's Open Template List or Open Seed List as this ensures the AutoCAD VBA (Visual Basic for Applications) program is loaded into AutoCAD. If the 'AVEVA Instrumentation' tools menu is not visible the menu has not yet been changed, so select the appropriate AutoCAD menu: Designer, Designer2004 or Designer2005 from the Program Files\AVEVA Instrumentation\AVEVA Instrumentation folder (or the wherever you installed AVEVA Instrumentation). Refer to the Assigning DataLinks in AutoCAD for more information. Editing DataLinks in AutoCAD Refer to the Assigning DataLinks in AutoCAD for more information. Auto-Erase Block in AutoCAD using DataLinks Designer provides an 'Auto-Erase' (or auto-delete) function where a block will be automatically erased from a drawing if a specific DataLink returns nothing. If you prefix your DataLink attribute with <DEL> and AVEVA Instrumentation evaluates the following DataLink with nothing (no value) then Designer will erase the block containing the <DEL> Datalink.

6:14

12.0

Instrument Designer User Guide


Drawing Generation

For example you may wish to erase a block if there is no tag number for {TAG10}. So entering: <DEL>{TAG10} in for an attribute in a block will tell AVEVA Instrumentation to erase the block if {TAG10} evaluates to nothing (i.e. there is no TAG10 for this drawing). <DEL> must be the first text in the attribute for AVEVA Instrumentation to recognise this operation. Forcing Uppercase Text in AutoCAD Designer provides a method to force any DataLink values retrieved from the AVEVA Instrumentation Database to become uppercase. For Example the database value for {Client} may be 'Oz Oil Company. To force this to become 'OZ OIL COMPANY' prefix your DataLink attribute with <UCASE> and AVEVA Instrumentation will update to uppercase. If you require both the <DEL> operator (see above) and the <UCASE> operator then <DEL> must be the first within the attribute (e.g. <DEL><UCASE>{TAG1Manufaturer}) Copying Blocks with DataLinks in AutoCAD Since DataLinks are defined as Extended Entity Data within AutoCAD their behaviour is same as Xdata. That is, if you copy a block with DataLinks attached the DataLinks are copied too. This can drastically reduce your data entry to set up DataLinks. For example, you can attach your required DataLinks to a block that may represent a Field Device. Then copy that block to as many drawings as you wish, saving you the effort of reentering the DataLinks each time. Another example is the Title block used in all drawings. Set up the first drawing with all DataLinks, once tested then copy that Title Block (which may contain multiple AutoCAD blocks) to your other drawings. Summary We learnt the following about DataLinks in this section: DataLinks are used to define where data comes from in the database and are attached to Attributes as Extended Entity Data. There are two types of DataLinks: Keywords (predefined) and SQL statements (which are User definable) You can use multiple DataLinks to fill in values to a single attribute and you may nest DataLinks within each other and/or concatenate them with character strings DataLinks are attached and edited from within AutoCAD by selecting the desired block containing attributes with the menu AVEVA Instrumentation > Edit DataLinks command. You can copy blocks with DataLinks within AutoCAD to reduce your setup time (and copy entire drawings!) You may get a list of predefined Keywords within the Designer Drawing List for any selected drawing by using the Show DataLinks menu option, under the Reports menu (after selecting a drawing in the Drawing List) to bring up the DataLinks Report Window.

6:15

12.0

Instrument Designer User Guide


Drawing Generation

6:16

12.0

Instrument Designer User Guide


Hookups

7
7.1

Hookups
Hookup (Installation) Drawings
Hookup drawings are created by assigning a pre-defined Hookup Template to each project hookup drawing. The Hookup Template is made up of two parts: an AutoCAD drawing that contains the graphical representation of the installation detail a Bill of Materials or Parts List that is assigned from the Designer Hookup parts catalogue.

When the project Hookup Drawing is created AVEVA Instrumentation updates the Hookup Template drawing with all parts and all tags assigned to the drawing. The Hookup Drawing List is the main Designer module window for adding/editing and accessing Hookup drawings.

7.1.1

Access the Hookup Drawing List


Activate the View tab and click Hookup Drawings List. This displays the Hookup Drawing List. By default all Hookup drawings for your project are shown in the grid. You may filter the display by Area and by Design Status by accessing lists of values from buttons in these cells.

Note: Refer to Working with the Data Grid for information on the grid control including how to select a record (a Drawing). Generally whenever you see a grid in AVEVA Instrumentation you may edit data directly within a cell (a field). However, some cells may be protected to ensure data integrity. If you cannot edit a specific cell within the grid you should use the 'Edit' command to access an edit window box.

7:1

12.0

Instrument Designer User Guide


Hookups

The grid provides details on each project Hookup drawing, including Drawing Number, Hookup Type, Title, Current Revision etc. This window is very similar to the Designer Drawing List, except that it is filtered to show only Hookup Drawings. Mandatory Data To produce a drawing you must enter a Drawing Number. Designer uses this field and the Sheet field to create a file name. For example: Drawing No: 123456 and Sheet No: 1 are combined to create a file name: 123456-1.dwg. To produce project Hookup Drawings you must assign a pre-defined Hookup Template to each of the drawings in this Hookup Drawing List. Auto Generation of Drawings AVEVA Instrumentation uses special 'DataLinks' to map database data to AutoCAD drawing attributes. DataLinks are automatically updated by Designer when a drawing is updated from the Drawing List toolbar command 'Update'. For information on using Designer's DataLinks to update Drawing Title Block (Drawing Border) - including revisions history, Tags numbers assigned to the hookup and the Bill of Materials (or Parts List). Hookup Drawing List Command Buttons New Edit Displays a window box for Add a New Hookup Drawing Displays a the Editing Hookup Details window for editing existing drawing data (you can also double-Click on any drawing record to bring up the edit window). This allows editing of Title block & Revision information. Note: Use Open to view the actual CAD drawing. Delete Undo Allows deletion of any selected drawing(s). Displays a Delete Options confirmation window box for you to confirm deletion. Undoes the last change made to the last row edit. Any subsequent undo will roll back 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 Open Reverses the last undo (see above) made to text in the grid. Open the selected drawing for reviewing/printing etc in AutoCAD (Editing title block & revision information should be done from the Edit button above. Updates selected drawing(s) - forces DataLinks in each CAD drawing to be updated with current project data from the AVEVA Instrumentation database.

Update

Note: If the drawing file does not exist the file is created by copying a) the template file (if drawing uses a template drawing) or b) the seed file (if drawing uses a seed drawing). Refer to Drawing Generation for more information. Issue Issues and updates selected drawing(s).

7:2

12.0

Instrument Designer User Guide


Hookups

Open Issues For Selected Open Issues For All

Displays the Issues window listing all the current issues for the selected drawing. Displays the Issues window.

The facilities for creating and viewing issues of drawings in the Hookup Drawing List are the same as those for the Drawing List. For details, refer to Drawing Issues. Revisions Displays a list of all drawings with revisions (and their revisions). Sub Menus are: Add Revisions Edit Revisions Used to create a new revision. Used to edit the current revision.

The facilities for viewing, creating and editing revisions of drawings in the Hookup Drawing List are the same as those for the Drawing List. For details, refer to Revision Entry (Multiple Drawings). Print Publish Find Filter Refresh Print selected drawing(s) - if the drawing file exists. Publishes selected drawings to a folder. The procedure is identical to that for publish drawings. Refer to Drawing Publishing. Displays a window allowing a "Find' any Text string (anywhere within the grid). Displays Advanced Grid Filters window for you to define the current Drawing List filter criteria (e.g Only Loop Diagrams). Update entire grid with latest database information (useful in multi-user project environments).

Refer to User Interface for information on the Explorer Bar menus.

7.2

Add a New Hookup Drawing


Add a new Hookup Drawing to your Project From the Hookup (Installation) Drawings List, click on the New button this displays the following window:

7:3

12.0

Instrument Designer User Guide


Hookups

Things to Know about this Hookup Drawing Information Window Double-click on any date field to bring up the Date Selection window (or press the Enter key when the date field has focus). This window is identical to the normal Designer Drawing Information window except it has two additional sections: Hookup Template Type Tags Assigned This contains information about the Hookup Template to be used when creating the Hookup Drawing This list contains a list of all tags assigned to the current Hookup Drawing

Assign a Hookup Template Type Click Select Type. This displays the Assigning a Hookup Template selection window. Once you have selected the Hookup Template AVEVA Instrumentation completes the 'Hookup Template Type' details in the window (fields with a yellow background above) based on the template selected. To Assign a new Tag to the Hookup Drawing Double-Click on any empty Tag Number record in the 'Tags Assigned' list. This displays the Assigning Tags to a Hookup window which allows you to select single of multiple tags to the current drawing. Note: A double-click on any Tag Number already assigned to a hookup will bring up the detailed Edit Instrument Data window enabling viewing/editing of detailed data as required. This is the only window in Designer that allows changing of Tag Numbers.

7:4

12.0

Instrument Designer User Guide


Hookups

Reassign a Tag Position in the Current Hookup Drawing Select a Tag and drag it into a new position. The figure below shows four tags, drag the 2nd tag and "drop" it onto the first position to move the selected tag to position one. This will automatically move all tag data on the corresponding hookup drawing to the new positions next time the drawing is updated.

Remove a Tag from the Current Hookup Drawing Select a Tag and press the <Delete> key. Note: Removing a tag does not delete its data only this only unassigns the tag from the drawing. To Pack Tags assigned in the Tags Assigned List If you remove tags and gaps appear in the Tags Assigned List, you can remove gaps and 'pack' the tags by using the Pack Tags command button. Packing Tags also re-sorts the order based on the Tag Number. The other section handles drawing revisions. Revision History List The Revision History list shows all revisions for the current drawing. Revisions Tab Command Buttons Add Revision Edit Revision allows a new revision to be added to the current datasheet by bringing up the Revision Entry (Single Drawings) window. allows editing the currently selected revision by bringing up the Revision Entry (Single Drawings) window box.

Note: Double-clicking on any existing Revision will also bring up the revision entry window. Delete Revision allows deletion of the currently selected revision.

Note: Pressing the <Delete> key on any existing Revision will also delete the currently selected revision AVEVA Instrumentation also allows addition of revisions to multiple drawings in one command. For information on this feature refer to Revision Entry (Multiple Drawings) topic.

7:5

12.0

Instrument Designer User Guide


Hookups

Importing from another Project Hookup drawings can also be imported from another Project. Refer to Import from another Project.

7.3

Assigning a Hookup Template


Assign a Hookup Template type to a Hookup Drawing From the Hookup Drawing Information window click the Assign Type command button. This displays the Hookup Template selection window showing the current Hookup Drawing Catalogue template drawings:

To assign a Template either, double-click on the Hookup Template record, or click on the Hookup Template record and then click Assign. To add new template drawings to your project refer to Hookup Items Catalogue.

7.4

Assigning Tags to a Hookup


To assign an instrument tag to a specific Hookup Drawing: From the Editing Hookup Details window double-click on an empty tag number record in the 'Tags Assigned' list. This displays the Assign Tag Numbers window as follows:

7:6

12.0

Instrument Designer User Guide


Hookups

This list shows all tags not yet assigned to any Hookup Drawing. To assign a Tag to the current Hookup Drawing, double-click on a Tag Number to assign the selected tag to the current hookup drawing. You may repeat the double-click selection to assign more than one tag (if the current drawing has multiple tags that are yet to be assigned). Click on Exit to exit assigning tag numbers. If you wish to assign multiple tags you can also select 'check' the Tag Numbers you want to assign, then click [Assign] to assign all selected tags to the hookup drawing. Note: The selected tag(s) are allocated to the next available spare tag position on the hookup. If you wish to change tag positions then the tags can be dragged into a new position in the Editing Hookup Details window. The tags list can be filtered by Plant Area (Display by Area combo box) to enable easier access to tags. You can also click on the list column headers to sort on the selected column and use Ctrl-F to bring up a Find Tag Number window.

7.5

Editing Hookup Details


To edit or view an existing Hookup Drawing Information in your project: From the Hookups Drawing List, click on the Edit button, or double-click on the Hookup drawing record in the Hookup Drawing List grid this displays the following Hookup Drawing Information window:

7:7

12.0

Instrument Designer User Guide


Hookups

Note: The Last Edit field displays the date and time when the hookup drawing data was last edited. The user name of the individual that performed the edit is displayed in a tooltip when the mouse cursor is hovered over the field. Click the button in the field to display the Audit Manager, which will display a list of all the changes to the hookup drawing data. This functionality is only available for SQL database projects. For Access database projects, the Last Updated: text displays the date and time of the last edit." Things to Know about this Hookup Drawing Information Window Double-click on any date field to bring up the Date Selection window (or press the Enter key when the date field has focus). This window is identical to the normal Designer Drawing Information window except it has two additional sections: Hookup Template Type Tags Assigned This contains information about the Hookup Template to be used when creating the Hookup Drawing This list contains a list of all tags assigned to the current Hookup Drawing

Assign a Hookup Template Type click the Assign Type command button. This displays the Assigning a Hookup Template selection window. Once you have selected the Hookup Template, AVEVA Instrumentation completes the 'Hookup Template Type' details in the window (fields with a yellow background above) based on the template selected.

7:8

12.0

Instrument Designer User Guide


Hookups

Assign a new Tag to the Hookup Drawing Double-Click on any empty Tag Number record in the 'Tags Assigned' list This displays the Assigning Tags to a Hookup window. Note: A double-click on any Tag Number already assigned to a hookup will bring up the detailed Edit Instrument Data window enabling viewing/editing of detailed data as required. This is the only window in Designer that allows changing of Tag Numbers. Reassign a Tag Position in the Current Hookup Drawing Select a Tag and drag it into a new position. The figure below shows four tags, drag the 2nd tag and "drop" it onto the first position to move the selected tag to position one. This will automatically move all tag data on the corresponding hookup drawing to the new positions next time the drawing is updated.

Remove a Tag from the Current Hookup Drawing Select a Tag and press the <Delete> key. Note: Removing a tag does not delete its data only this only unassigns the tag from the drawing. Pack Tags Assigned in the Tags Assigned List If you remove tags and gaps appear in the Tags Assigned List, you can remove gaps and 'pack' the tags by using the Pack Tags command button. Packing Tags also re-sorts the order based on the Tag Number. The other section handles drawing revisions. Revision History List The Revision History list shows all revisions for the current drawing. Revisions Tab command buttons Add Revision Edit Revision allows a new revision to be added to the current datasheet by bringing up the Revision Entry (Single Drawings) window. allows editing the currently selected revision by bringing up the Revision Entry (Single Drawings) window box.

7:9

12.0

Instrument Designer User Guide


Hookups

Note: Double-clicking on any existing Revision will also bring up the revision entry window. Delete Revision allows deletion of the currently selected revision.

Note: Pressing the <Delete> key on any existing Revision will also delete the currently selected revision. AVEVA Instrumentation also allows addition of revisions to multiple drawings in one command. For information on this feature refer to Revision Entry (Multiple Drawings) topic.

7.6

Rename Selected Drawings


Rename Selected Drawings allows the user to rename drawing in batches. It is active under the Tools tab when working in Hookup Drawing List and Drawing List grid views. Refer to Rename Selected Drawings for more information.

7.7

Hookups Template Catalogue


The Hookup Template Catalogue contains definitions of all the template drawings that will be used to create project hookup drawings. A Hookup Template drawing contains the graphic representation of the installation/hookup and also contains place holders so the component items/parts list can be created by AVEVA Instrumentation and instrument tags assigned to each drawing can be listed. The place holders are AutoCAD blocks with attributes. AVEVA Instrumentation uses Datalinks to map each attribute to a database field so that when the Template is used to generate a project CAD drawing, all the component items and all tags are automatically updated by AVEVA Instrumentation. The Hookup Template Catalogue is accessed from the Main window: Activate the View tab and click Hookup Catalogue. The following figure shows a typical Hookup Catalogue window:

Hookup Template Catalogue Command Buttons New Edit Displays a window box for Adding a New Hookup Template drawing. Displays a the Editing Template Data window for editing existing template drawing data (you can also double-click on any drawing record to bring up the edit window). This allows editing of Bill of Materials information.

7:10

12.0

Instrument Designer User Guide


Hookups

Delete Undo

Allows deletion of any selected drawing(s). Displays a Delete Options confirmation window box for you to confirm deletion. Undoes the last change made to the last row edit. Any subsequent undo will roll back 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 Find Filter Refresh

Reverses the last undo (see above) made to text in the grid. Displays a window allowing a "Find' any Text string (anywhere within the grid). Displays Advanced Grid Filters window for you to define the current Drawing List filter criteria (e.g Only Loop Diagrams). Update entire grid with latest database information (useful in multi-user project environments).

7.7.1

Adding a New Hookup Template


Add a new Hookup Template Drawing to your Project From the Hookup Catalogue grid list, click New, to display the Hookup Template Details window.

Enter a Category, Description, Template name and the maximum Number of Tags that can be assigned to the Hookup drawing. Copy an existing AutoCAD drawing to be used as the Hookup Template Click Open Drawing command button. This will pop-up a window asking you to locate the existing drawing file. Once you have selected the drawing it is copied into the project hookup template drawings folder. To complete the definition you should apply the appropriate DataLinks to each of the template drawings attributes to map fields to update:

7:11

12.0

Instrument Designer User Guide


Hookups

Title Block information Drawing Revision history Tags Assigned Bill of Materials

Assign a new Bill of Materials Catalogue Item to your new Hookup Template Click New Item to display the Find a Component window to allow Assigning Hookup Items. To Change the Quantity of any items assigned, click in the 'QTY' grid column and edit the value. Remove an Item from the Bill of Materials Select an Item record and click Remove Item. To assign a Template Drawing click Open Drawing. If the drawing is not found in the current project Hookup Template drawings folder AVEVA Instrumentation will allow you to select an existing drawing file which will be copied to the current project Hookup Template folder. Once the drawing is opened in AutoCAD appropriate DataLinks must be assigned to each block attribute so AVEVA Instrumentation can update the attribute values with hookup item bill of materials, tags assigned and title block information. Refer to Assigning Hookup DataLinks in AutoCAD. Note: Once the AVEVA Instrumentation DataLinks have been assigned to the Template drawing, Open Drawing will automatically update the DataLinks with the current Bill of Materials saved to the database. To save changes click Save.

7.7.2

Editing Template Data


Edit a Hookup Template Data for your Project From the Hookup Catalogue grid list click Edit to display the Hookup Template Details window or, double-click on the template record this displays the following window:

7:12

12.0

Instrument Designer User Guide


Hookups

Copy an existing AutoCAD Drawing to be used as the Hookup Template click the Open Drawing command button. This will pop-up a window asking you to locate the existing drawing file. Once you have selected the drawing it is copied into the project hookup template drawings folder. To complete the definition you should apply the appropriate DataLinks to each of the template drawings attributes to map fields to update: Title Block information Drawing Revision history Tags Assigned Bill of Materials

Assign a new Bill of Materials Catalogue Item to your new Hookup Template Click New Item command button, this pops-up the Find a Component window to allow Assigning Hookup Items. Change the Quantity of any Items Assigned Click in the 'QTY' grid column and edit the value. Remove an Item from the Bill of Materials Select an Item record, click Remove Item command button. Assign a Template drawing Click Open Drawing command button. If the drawing is not found in the current project Hookup Template drawings folder AVEVA Instrumentation will allow you to select an existing drawing file which will be copied to the current project Hookup Template folder. Once the drawing is opened in AutoCAD appropriate DataLinks must be assigned to each block attribute so AVEVA Instrumentation can update the attribute values with hookup item bill of materials, tags assigned and title block information. Refer to Assigning Hookup DataLinks in AutoCAD. Note: Once the AVEVA Instrumentation DataLinks have been assigned to the Template drawing, Open Drawing will automatically update the DataLinks with the current Bill of Materials saved to the database. To save changes click Save.

7.7.3

Import Hookup Catalogue


Import Hookup catalogue allows the user to import other Hookup catalogues from another AVEVA Instrumentation project. With the Hookup Catalogue grid view active, select Imports > Import from other Project from the Tools tab to display the Select an AVEVA Instrumentation Project window. The user must select a project from the available list and click Select. The user must then Login to the selected project to display the Hookup Catalog Import window.

7:13

12.0

Instrument Designer User Guide


Hookups

Note: To minimise the possibility that data currently being worked on by another user may be affected by an import, a list of the users working on the current project is available from the UserCount link. The number of current users is displayed next to the link. This total includes the user performing the import. This functionality is only available for SQL database projects. The user can select individual catalogues to be imported by clicking the required checkboxes. To select all the catalogues the user can click Select All to check all the boxes. Clicking Cancel closes the Hookup Catalog Import window and returns the user back to the Hookup Catalogue grid view. After selecting the required catalogues, clicking Import displays a progress window.

The import progress checks to see if the selected catalogues already exist in the project. If any existing catalogues are found an overwrite message screen is displayed.

7:14

12.0

Instrument Designer User Guide


Hookups

Click Yes to overwrite the existing catalogue. The message will re-appear each time the import process finds an existing catalogue. Click No to prevent the import process overwriting the existing catalogue. The message will re-appear each time the import process finds an existing catalogue. Click Yes To All to overwrite all the existing catalogues. The message will not re-appear each time the import process finds an existing catalogue. Click No To All to prevent the import process overwriting the existing catalogues. The message will not re-appear each time the import process finds an existing catalogue. If during the import process files are found that do not have a Template Filename, a message is displayed informing the user that these files will be ignored and not imported.

Click Yes to continue and Cancel to stop the import. Files with a Template Filename will be imported but if the import process cannot find the template files a message is displayed informing the user that the template files are not found.

Click OK to continue. The message will re-appear each time the import process cannot find a template file. After the import process is complete the Import Log window is displayed.

7:15

12.0

Instrument Designer User Guide


Hookups

The Import Log shows the user the import status and displays the successfully imported files in the grid view. Export To Excel opens a window allowing the user to name the Excel file and save the file to a chosen location. Print opens a Print Preview window allowing the user print the log. Clicking Close, closes the Import Log window and returns the user back to the Hookup Catalogue grid view.

7.7.4

Assigning Hookup Items


To assign a component item or part from the Hookup Items Catalogue to a hookup drawing the user must assign the item to the hookup template. From the Editing Template Data, click New Item command button. This displays the Find a Component window below:

7:16

12.0

Instrument Designer User Guide


Hookups

You may filter the items catalogue by selecting any combination of: Category, Size, Material or Manufacturer. The Show All command resets your filter so that all items are shown. Note: Only those Hookup items in the Hookup Items Catalogue that have been marked with 'Allow' are shown in this selection list. 'Allow' predefines the catalogue items that can be used for the current project. See the Hookup Items Catalogue for more information. Select an Item or Component to use on you Hookup Double-click on the desired item. Select Multiple Items Continue to double-click on as many items as required. To exit the window, click Close. Note: Each time you select an item (double-click) the item is added to the list of items in the template information window. If you select the same item the quantity of that item is incremented. You can also manually change the quantity by editing the number required in the template information window. Filtering the Catalogue Items List Use the predefined filter combo boxes to filter by Category, Size, Material and/or Manufacturer. AVEVA Instrumentation will filter on all the combo box filters as a logical 'AND'. For example: Category = 'Ball Valve' AND Size = '1/4"'. To reset the filters and show all catalogue items click Show All. Note: When selecting a Size, AVEVA Instrumentation finds any component matching the size anywhere within the catalogue size field. You can also type in a Size (e.g 1/4"OD and press the <Enter> key to filter on an exact size entered. You create a more complex filter by using the Filter toolbar command which displays the Advanced Grid Filters window. Use the Find toolbar command to search for any specific text in the grid.

7:17

12.0

Instrument Designer User Guide


Hookups

7.7.5

Assigning Hookup DataLinks in AutoCAD


To assign or modify DataLinks to an AutoCAD Hookup template the template drawing file the file needs to be opened using AutoCAD. The Hookup Template can be opened in AutoCAD by using the 'Open Drawing' command button from the Editing Template Data. Use the AVEVA Instrumentation Designer AutoCAD Menu To assign new DataLinks (or modify DataLinks already assigned) you need to ensure the AVEVA Instrumentation Designer AutoCAD menu is loaded into AutoCAD. This toolbar menu should be automatically loaded when an AutoCAD drawing is opened from AVEVA Instrumentation Designer. Note: If the 'iDesigner' menu is not auto loaded you will need to load the following menu manually (using the AutoCAD 'menu' command): AutoCAD Version AutoCAD 2000, 2000i, 2002 AutoCAD 2004 AutoCAD 2005, 2006, 2007, 2008 Designer AutoCAD Menu Designer.mns Designer2004.mns Designer2005.mns

These menu files are located in the AVEVA Instrumentation program installation folder (typically: 'c:\program files\AVEVA Instrumentation\AVEVA Instrumentation') Assign/Edit DataLinks Once the AutoCAD iDesigner menu is loaded select: iDesigner from the pull-down menus > Edit DataLinks. This displays a window showing all attributes in the selected AutoCAD block. AutoCAD will prompt you to 'Select Objects:' Go ahead a select a block with attributes, then press enter. AutoCAD will bring up the DataLinks Edit window as below:

7:18

12.0

Instrument Designer User Guide


Hookups

This window shows all attributes defined in the block selected. The text boxes all contain DataLinks. Note: To view available Keyword DataLinks for any drawing in the Designer's Drawing List bring up the DataLinks Report Window. This window enables 'copy and paste' of DataLinks from the report window into your AutoCAD 'Edit DataLinks' window above. In the example above the Description attribute has three Datalinks assigned. This will update the attribute value with item Description, Size and Material for the first item assigned to the hookup (e.g. Description1, Size1 and Material1 return the values for Item 1). To assign a DataLink you can type in a valid DataLink or you can copy from the DataLinks Report Window report created for a drawing that will use this template or seed. DataLinks can be copied from the DataLinks Report window (using Windows copy and paste - Ctrl-C / Ctrl-V etc) or dragged and dropped (hold the Ctrl key and drag the report DataLink to a text box above. Refer to DataLinks Reference for more information on DataLinks. Copying Blocks with DataLinks in AutoCAD Since DataLinks are defined as Extended Entity Data within AutoCAD their behaviour is same as Xdata. That is, if you copy a block with DataLinks attached the DataLinks are copied too. This can drastically reduce your data entry to set up DataLinks. For example, you can attach your required DataLinks to a block that may represent a Field Device. Then copy that block to as many drawings as you wish, saving you the effort of reentering the DataLinks each time. Another example is the Title block used in all drawings. Set up the first drawing with all DataLinks, once tested then copy that Title Block (which may contain multiple AutoCAD blocks) to your other drawings. Auto-Erasing Blocks with DataLinks in AutoCAD AVEVA Instrumentation Designer provides an 'Auto-Erase' (or auto-delete) function where a block will be automatically erased from a drawing if a specific DataLink returns nothing. If you prefix your DataLink attribute with <DEL> and AVEVA Instrumentation evaluates the following DataLink with nothing (no value) then Designer will erase the block containing the <DEL> Datalink. For example you may wish to erase a block if there is no tag number for {TAG10}. So entering: <DEL>{TAG10} in for an attribute in a block will tell AVEVA Instrumentation to erase the block if {TAG10} evaluates to nothing (i.e. there is no TAG10 for this drawing).

7.8

Hookup Items Catalogue


The Hookup Items (or Parts) Catalogue enables catalogue components to be added/edited to the project database. To access the Hookup Items Catalogue: On the View tab, click Hookup Items Catalogue. This displays the following typical grid:

7:19

12.0

Instrument Designer User Guide


Hookups

Hookup Catalogue Fields


Field Information Category can be any text value that allows you to easily locate the item. For example 'Ball Valve' or 'Male Elbow' etc. You can create your own new categories by entering them when creating new items and they will appear when adding future items to the catalog. Description is the detailed information you will see on the hookup drawing. Size and Material are more information to describe the item. Unit is the unit of measure (e.g each, metre, ft etc). Manufacturer and Catalogue Number are the manufacturer and model number details used to purchase the item. Allow Use defines whether the item can be selected and added to Hookup drawing for the current project. User Code is the code that will appear on your Hookup Drawing. This is a simplified code that for example could be a 3 digit number, so that all 1/2" Unions would be a 101 etc. Note: The User Code is optional. You can also use the Bill of Materials sequence number to refer to Bill of Materials items. The sequence number starts at 1 for all hookup drawings. Contingency enables the final bill of materials quantity to be increased by a percentage or a finite quantity. For a percentage increase add a percent character (%). If you do not enter a percent character AVEVA Instrumentation will add the Contingency quantity instead. For example '5%' will add 5% whereas '5' will add five (5) items to the final BOM quantity.

7:20

12.0

Instrument Designer User Guide


Hookups

Hookup Item Catalogue Command Buttons New Displays a window box for Adding a New Catalogue Item

Note: You can copy any existing item by selecting the desired item record then click on the pull-down menu button next to New. From the menu that appears click Copy selected. All component data from the selected item is copied to the new item, bringing up the Edit Detail window for you to change item catalogue number and other details as required Edit Displays a the Hookup item Detail window for editing existing components (you can also double-click on any item record to bring up the edit window). Allows deletion of any selected item(s). Undoes the last change made to the last row edit. Any subsequent undo will roll back 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 Find Filter Refresh Reverses the last undo (see above) made to text in the grid. Displays a window allowing a "Find' any Text string (anywhere within the grid). Displays Advanced Grid Filters for you to define the current Items List filter criteria (e.g Only Male Connectors). Update entire grid with latest database information (useful in multi-user project environments).

Delete Undo

7.8.1

Adding a New Catalogue Item


To add a new Hookup Item to the Items Catalogue for your project: From the Hookup Items Catalogue grid list, click New to display the Hookup Item Detail window.

7:21

12.0

Instrument Designer User Guide


Hookups

Field Information Category can be any text value that allows you to easily locate the item. For example 'Ball Valve' or 'Male Elbow' etc. The category combo box is automatically filled with all the unique Categories already defined in the catalog. You can create your own new categories by entering them here and they will appear when adding future items to the catalog. User Code is the code that will appear on your Hookup Drawing. This is a simplified code that for example could be a 3 digit number, so that all 1/2" Unions would be a 101 etc. User Catalogue Number is an Optional field used to enable your own materials management system to track the component. For example you may have a SAP code. MESC number etc. Contingency allows the project Bill of Materials report to be increased by a specific number of items to allow for spares or runover. You can enter an exact number (e.g 2 or 10 etc) or apply a percentage by entering a number and the percentage character '%' (e.g 2% or 5% etc). Both these methods enable you to increase you total quantities by some figure. This is ideal for tube and/or unions where you may just allow some additional quantity to ensure your site has some extra items. Details Description is the detailed information you will see on the hookup drawing. Manufacturer and Catalogue Number are the manufacturer and model number details used to purchase the item. Size and Material are more information to describe the item. Unit is the unit of measure (e.g each, metre, ft etc). Add a New Item Enter the field information as required click Allow Use checkbox to allow the item to be selected and used on the project click Save.

7:22

12.0

Instrument Designer User Guide


Hookups

Importing from Excel or from another Project Drawings can also be imported from Excel, refer to Import from Excel or from another Project, refer to Import from another Project.

7.9

Hookup Reports
Three reports related to hook-ups are available in Designer: BOM/Material Take Off Tags Assigned Tags not yet Assigned

These are accessed from the Hook-ups pane of the Reports tab. The BOM/Material Take Off report lists the hook-up items that comprise the project Bill of Materials. The report is displayed in the Hookup Bill of Materials window:

An item is added to the BOM by assigning it to a Hookup drawing and unchecking its No. checkbox (see Assigning Tags to a Hookup). The Tags Assigned report lists the tags assigned to Hookup drawings in the project:

7:23

12.0

Instrument Designer User Guide


Hookups

The Tags not yet Assigned report lists the tags not yet assigned to Hookup drawings in the project:

Only those tags that are pre-assigned via Hookup type (template) are listed.

7:24

12.0

Instrument Designer User Guide


Engineering Data

8
8.1

Engineering Data
Loop Data
AVEVA Instrumentation Designer allows access to the Instrument Engineering data normally created by the Engineer application. The Loop Data window is accessed from Designers Drawing Information if the drawing is a Loop Diagram (i.e it has a Loop Number that is valid for the project). To Access the Loop Data window This window can be accessed from two places in Designer: 1. From the Drawing Information In the Loop No text box, click on the [ ] command button (only available if the Drawing is a Loop Diagram) Or 2. From the Drawing List grid list, click the 'Loop No' cell button which appears when the mouse hovers over the 'Loop No' cell. The options window is displayed. Note: The options window is only displayed if the LoopNo cell is populated.

Clicking Edit Loop Detail will display the Loop Data window showing the loop info:

8:1

12.0

Instrument Designer User Guide


Engineering Data

This window is a very powerful re-entry point into the Engineer application and enables you to: Edit Loop information (including checking 'Drawing Required'). Editing Instrument Tag data (double-click on any tag in the Loop Instruments list will bring up the Instrument Data window). Add new tags/instruments to the current loop (use the Add Tag command button to bring up the Assigning Tags to Loops. Check current loop instrument wiring including terminations (use the Loop Check Wiring command button. Create Loop Wiring for current Loop based on user defined Wiring Rules. (use the Create Loop Wiring command - Learn more about Using Wiring Rules to Create Data here). Remove Loop Wiring created previously with the 'Create Loop Wiring' command. Note: The Last Edit field displays the date and time when the loop data was last edited. This functionality is only available for SQL database projects. The user name of the individual that performed the edit is displayed in a tool-tip when the mouse cursor is hovered over the field. Click the button in the field to display the Audit Manager, which will display a list of all the changes to the loop data.

8:2

12.0

Instrument Designer User Guide


Engineering Data

Related Loops You may assign up to two 'related loops' which enables AVEVA Instrumentation to place information for related loops (including their instrument tag data) on any Loop Diagram created with Designer. To assign a related loop select a command inside the related loop text boxes. This displays a Loop Selection window enabling selection of any loop defined in Engineer's Loop List. Loop Instruments List The 'Loop Instruments' list at the bottom of the window shows all instruments assigned to the current loop. To assign Instrument Tag Numbers to this loop click the Add Tag button (refer to Assigning Tags to Loops). To edit instrument data, double-click on the desired tag number. To remove a tag from the current loop, select the instrument tag record and press the <Delete> key. To change the loop order of instruments drag & drop each to the desired position. Special Loop Command Buttons The three loop command buttons: Loop Wiring Check, Create Loop Wiring and Remove Loop Wiring are typically used by designers to view and build loop wiring details from wiring rules. Loop Wiring Check: Displays the loop wiring print preview window showing all instrument wiring in the AVEVA Instrumentation database for the current loop. Create Loop Wiring: Allows auto creation of instrument field wiring for instruments in the current loop. Displays the Creating Loop Wiring using Wiring Rules window. Remove Loop Wiring: Removes all field wiring/cables & terminations for the current loop instruments previously created with 'Create Loop Wiring'

8.1.1

Assigning Tags to Loops


To Assign a Tag(s) to a Loop From the Edit Loop Data window, click Add Tag to display the Add Instruments to Loop window.

8:3

12.0

Instrument Designer User Guide


Engineering Data

The left hand list shows typical tags and descriptions for the Engineer's ISA tag catalogue built using the current loop Function prefix in the Edit Loop Data window. The right list shows all tags assigned to the current loop (if any). To assign a tag to the current loop you may use two methods: 1. Build a Tag Number using the ISA tag catalogue (left list) Double-click on the desired tag and the full tag number is added to the 'Tags to Add' list (right list) Note: If the tag you build does not exist in Engineer's Instrument List it will be added. If it does exist AVEVA Instrumentation will reassign the tag to the current loop. 2. Pick an existing tag number from the Instrument List Click the From Instrument List button, which displays a window for Selecting Existing Tags not assigned to any loop. Save Cancel Saves assignment changes (if any) Cancels assignment changes (if any)

8.1.2

Selecting Existing Tags


After clicking the From Instrument List command button in the Assigning Tags to Loops the following window appears:

8:4

12.0

Instrument Designer User Guide


Engineering Data

This window contains only those tags yet to be assigned to a loop. The tag list can be filtered to enable easy access to tags by Plant Area ('Display by Area' combo box). Assign a Tag to the Current Loop To assign a single tag: Double-Click on a Tag Number to assign the selected tag to the current Loop. Or: To assign multiple tags: Click the check boxes for all the tag number to assign, Click the Assign button. The Exit button cancels any tag assignment. Use Ctrl-F to bring up a search window, where you can locate a tag number faster if the list of instruments is large.

8.2

Instrument Data
Designer allows access to the Instrument Engineering data normally created by the Instrument Engineer application. The Instrument Data window is accessed from the Designer's Loop Data window (which is accessed from the Drawing Information). To Access an Instrument Data Window From the Drawing Information In the Loop No text box, click on the [ ] command button (only available if the Drawing is a Loop Diagram). This displays the Loop Data window (not shown here), from the Loop Data window:

8:5

12.0

Instrument Designer User Guide


Engineering Data

Double-click on any tag listed in the Loop Instruments list. The following figure shows the Instrument Data window showing a typical instrument:

The two important fields for loop drawing generation are found under the 'Detail' tab:

8:6

12.0

Instrument Designer User Guide


Engineering Data

1. Wiring Config - This applies the Wiring Rules Overview for the current instrument tag. 2. Loop Dwg Code - This is the code number used when Designer creates DataLinks. In the example above the Loop Dwg Code is 10 meaning that all tag DataLinks will be created prefixed '{TAG10'. If the code was 51 then all DataLinks would be created prefixed '{TAG51' This field is only used for generation of DataLinks used to create loop drawings from templates. Note: AVEVA Instrumentation recommends using the same Loop Dwg Code for each instrument type. e.g Always use 10 for transmitters, 50 for Control Valves etc. This means the Datalinks you embed into the CAD symbols can be copied without to much thought since it is likely you will use the same CAD symbol for each transmitter, control valve etc. Click on this link to view information on Edit Tag Details - Tabs. Many field options have a user definable PickList associated. Clicking on the # command button next to a combo box displays the PickList Management window. Note: The Last Edit field displays the date and time when the instrument data was last edited. This functionality is only available for SQL database projects. The user name of the individual that performed the edit is displayed in a tool-tip when the mouse cursor is hovered over the field. Click the button in the field to display the Audit Manager, which will display a list of all the changes to the instrument data.

8.2.1

Edit Tag Details - Tabs


PickList (combo boxes) can be updated with new values to choose from by selecting the [#] button to the right of most combo boxes. The following screen captures show the seven (7) instrument edit tabs: Note: The combo boxes (drop-down lists) allow selection from user defined Picklists and manual data entry. General

The General tab is used to enter typical common data for most instruments on your project.

8:7

12.0

Instrument Designer User Guide


Engineering Data

Detail

The Detail tab is used for more detailed design data and includes data typically required for wiring and installation information. The Wiring Configuration PickList is used to assign a Wiring Rule to the instrument. This name is used to auto generate the instrument termination arrangement including terminal details, cable type, connection arrangement & wire ferrule numbers etc. Typically this choice is made by the person responsible for detail wiring design. It can also be edited from the Designer application. The Junction Box in-cell command button enables assignment of the current instrument to a Junction Box. The pop-list is populated from junction box equipment tags created in Wiring Manager. The Hookup Config in-cell command button enables assignment of the current instrument to a Hookup type. The pop-up list is populated from a list of Hookup templates created in Designer. Datasheet

Operating Principle PickList is used to pre assign an instrument to a data sheet form type. The button Datasheet No. in-cell command button [..] allows direct access to the datasheet (if exists). If the tag is not yet assigned to a datasheet the user is allowed to assign the

8:8

12.0

Instrument Designer User Guide


Engineering Data

current tag to an existing data sheet (if the project utilises multiple tags per data sheet) or you can create a new datasheet 'on the fly'. DCS System

This tab is used to assign DCS I/O information for the current tag (if the current tag will be connected to the DCS System). All field captions are user definable. To change captions use the Grid Manager accessed from the Instrument List Tools menu. PLC/ESD System

This tab is used to assign PLC or ESD (Emergency/Safety Shutdown) I/O information for the current tag (if the current tag will be connected to the PLC or ESD System). All field captions are user definable. To change captions use the Grid Manager accessed from the Instrument List Tools menu.

8:9

12.0

Instrument Designer User Guide


Engineering Data

User

Engineer has sixteen(24) user defined fields (UserField1 to UserField24) these can have their captions changed to any value. In the example above UserField1 has its caption set to 'Date Required, UserField10 caption is 'FEED Estimate' etc. To change captions use the Grid Manager accessed from the Instrument List Tools menu. Alarms/Settings

Use this tab to enter Alarm and Settings data required for your project.

8.3

Loop Check Wiring Reports


Loop Wiring Check Reports show a graphical 'loop diagram' type report of all wiring for current loop. The report may be printed or saved as a PDF file. This report is only available if the drawing has a valid loop number and wiring exists in the project wiring database for the instruments in the current loop. Create a Loop Wiring Check Report From the Drawing Information, in the Loop No text box. Click on the [ ] command button (only available if the Drawing is a Loop Diagram).

8:10

12.0

Instrument Designer User Guide


Engineering Data

This displays the Loop Data window (not shown here), from the Loop Data window: Click on the Loop Wiring Check command button. The following figure shows a typical report:

You may print the report to a printer or save the report to a file in Adobe Acrobat PDF format by clicking the relevant Print or Export to PDF buttons. The Setup button allows you to change print properties such as page size and orientation etc. When exporting to PDF AVEVA Instrumentation creates a file named after the Loop Number. The file name for this example would be: 00-F-100.pdf You may Double-click on the report to zoom in or select a zoom ratio from the list of options after selecting the Zoom button: Note: If your PC has a license for Wiring Manager when you right-click on any equipment tag AVEVA Instrumentation will bring up an option to allow access to the Wiring Manager's Terminations window which allows drag & drop editing of cable/wire terminations or to generate termination reports for the selected equipment. Note: If your PC has a license for Wiring Manager when you right-click on any cable AVEVA Instrumentation will bring up an option to allow access to the Wiring Manager's Cable Detail window which allows viewing/editing for the selected cable.

8.4

Equipment Data
Designer allows access to the following equipment and termination viewing and editing facilities in Wiring Manager: The Layout window, which is used to view internal equipment component layouts in a graphical user interface. The Terminations window, which enables editing of wiring terminations and rearrangement of terminal strips etc. The Termination Report window, which is used to preview, print a graphical representation of the equipment termination, or export it to various file formats.

8:11

12.0

Instrument Designer User Guide


Engineering Data

The Select Equipment window, used to select or change the equipment that the termination drawing is for

Accessing Wiring Manager Facilities Either click on the command button next to 'Equipment No' text field in the Drawing Information window (only available if the Drawing is a Termination Diagram). Or, click on the 'Equipment No' cell command button which is displayed when the mouse cursor is hovered over the 'Equipment No' cell in the Drawing List. The Options window is then displayed:

Click Edit Detail to display the Layout window. Click Edit Termination to display the Terminations window. Click View Termination to display the Terminations Report. Click Change Equipment to display the Select Equipment window.

The Select Equipment window:

8:12

12.0

Instrument Designer User Guide


Engineering Data

The Terminations window:

Refer to Wiring Manager documentation for details of these facilities

8:13

12.0

Instrument Designer User Guide


Engineering Data

8:14

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

9
9.1

Using Wiring Rules to Create Data


Wiring Rules Overview
AVEVA Instrumentation uses 'Wiring Rules' to auto generate typical field instrument wiring/ cabling. By using the Wiring Rules features you can save many hours otherwise required to build devices and their associated terminal arrangements, cables, terminations etc in Wiring Manager. To apply a Wiring Rule refer to Creating Loop Wiring using Wiring Rules By applying a Wiring Rule to a field instrument, you are defining a specific: Terminal Arrangement - number of terminals, their markings, sequence Default wire numbers to be used on wire terminations Default Cable Type - type of cable (individual cores, pairs or triad etc), whether shielded/screened, and whether armoured etc Default Cable Number, based of the instruments tag number fields from Instrument Engineer Default Wire terminations at field device - how the cable is connected to the field device terminals (core 1 to terminal 1, core 2 to terminal 2 etc) Default wire terminations at non-field device - how the cable is connected at the other end.

When you Create Wiring based on a Wiring Rule, AVEVA Instrumentation creates all the above for you. Just prior to saving this data AVEVA Instrumentation allows you to: Change the default Cable Number created by the Wiring Rule Select equipment the cable will terminate to at the other end (provides a list of Junction Boxes, Cabinets etc).

After accepting defaults (or making changes as required) the Field Device and terminals are created, cable created and terminated at both ends (if you have selected equipment at the other end). At the other end AVEVA Instrumentation always uses the next available spare terminals. At any time after a Wiring rule is applied you can easily edit data that has been generated by: 1. Re-running the Create Wiring command using same Wiring Rule - this allows you to reassign a Cable No, reassign a Junction Box etc. 2. Re-running the Create Wiring command using a new Wiring Rule - this updates terminal arrangements, cable type, terminations AND allows you to reassign a Cable No, reassign a Junction Box etc. 3. Edit the cable details/type using Wiring Manager - Cables (the AVEVA Instrumentation Cable Schedule user interface).

9:1

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

4. Edit terminations using Wiring Manager - Equipment (the AVEVA Instrumentation Terminations editing user interface). Note: You can also access Equipment Terminations directly from Designer - refer to Equipment Data.

9.2

Using Wiring Rules


Designer allows access to two Wiring Rules commands from the Loop Data window. The Loop Data window is access from the Designer's Drawing Information if the drawing is a Loop Diagram (i.e. it has a Loop Number that is valid for the project). Note: AVEVA Instrumentation uses Wiring Rules when you assign tags to Junction Boxes in Wiring Manager. Refer to the Wiring Manager Help/Documentation for more information. Access the Loop Data Window From the Drawing Information, in the Loop No text box, click on the [ ] command button (only available if the Drawing is a Loop Diagram). The following figure shows the Loop Data window showing a typical loop:

Just below the Loop Instruments list there a three buttons: Loop Check Wiring Reports: This command shows all instrument wiring associated with the current loop.

9:2

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

Creating Loop Wiring using Wiring Rules: This command Creates Loop Wiring from Wiring Rules applied to each field instrument in current loop. Remove Loop Wiring: This command removes anything previously created by Wiring Rules for each field instrument in current loop.

Note: The Loop Instruments list shows the name of a Wiring Rule associated with each instrument (Wiring Config column).

9.3

Creating Loop Wiring using Wiring Rules


Note: Although you can use Wiring Rules to create field cables/terminations from Designer, this is limited to working on a Loop by Loop basis. AVEVA Instrumentation recommends creating your field wiring using Wiring Rules from the Wiring Manager's Equipment View or Cable Block Diagram by assigning (allocating) field tags to Junction Boxes which is more efficient than doing it in Designer by each Loop. Designer will auto create the field device, terminals, cables, cores and wire numbers and terminate cable cores at both the field device and Junction box cable ends based on assigned Wiring Rules Overview for each specific Loop instrument. This effectively completes field wiring in a very efficient and simple manner that can save hundreds on manhours on a large project! Note: The loop must have tags assigned. To assign tags to a loop you must use the Instrument Engineer application. Note: AVEVA Instrumentation uses Wiring Rules when you assign tags to Junction Boxes in Wiring Manager. See the Wiring Manager Help/Documentation for more information. Create Loop Wiring using Wiring Rules From the Loop Data window, click on the Create Loop Wiring command button Designer will bring up the following window:

This window shows all instruments assigned to the current loop. Only those instruments selected will be processed by the Create command.

9:3

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

Columns Explanation Select TagNo Only those instruments selected are processed when the Create command is used The instrument tag number - Non editable (tags can only be assigned to a loop using Engineer)

Note: Although the Wiring Rule (Wiring Config) defines the terminal arrangement of the Field Device you can select a different type by clicking on the 'Tag No' cell button that appears when the mouse hover over this cell. Code The 'Loop Code' is used by AVEVA Instrumentation Datalinks to map information into a loop drawing template when generating CAD drawings. It is ONLY required if you intend to generate CAD loop drawings in Designer. This 'Loop Code' must be unique for the current loop for CAD loop drawing creation. The name of the Wiring Rule to apply to the tag. This cell is a combo box (PickList) so you can easily apply a rule (or change). This combo box only appears when your mouse pointer hovers over the WiringConfig cell. This holds the name of the equipment the cable will run to. This cell has a small command button embedded at the right side of each cell. Clicking on that button will display Assigning a Junction Box window. This button only appears when your mouse pointer hovers over the JBox cell. When 'checked' cores will be terminated at the JBox end (on the next available spare terminals). When 'unchecked' cores will not be terminated at the JBox end. The cores will need to be terminated manually using Wiring Manager by dragging the cable or cores to the desired terminals. This shows the default cable number as created by the wiring rule or the actual cable number from the AVEVA Instrumentation Cable Schedule (if the cable has been created previously). You may enter a new value if you require. This shows the base cable type. It can be changed by selecting the cell command button that appears when you hover your mouse over this columns cell. The initial cable type comes from the Wiring Rule catalogue cable (if the cable is not yet created) or from the Cable Schedule (if the cable has been created previously). Clicking the 'Cable Type' cell button displays the Catalogue Cable selection window allowing a new catalogue cable to be selected. You can enter a Cable Length here. This length is saved in Wiring Manager's Cable Schedule.

WiringConfig

JBox

Terminate

CableNo

Cable Type

Length

Command Buttons Create Goes ahead and Creates all selected tags, cables, termination and other wiring data from the Wiring Rules & data in this grid.

9:4

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

Note: Create will make the field device(s), terminals & wire markings, the field cable(s) and cores & terminate the field cable(s) at both the field device and Junction Box ends. This effectively completes field wiring in a very simple and efficient manner. Save Saves changed data in the grid, but does not go ahead and create Wiring Rule data. This allows you to pre-assign junction boxes etc prior to cable/device creation. Quits the window, not saving or creating.

Cancel

Note: Wiring Manager allows limited editing of the predefined Wiring Rules. Limitations are that only Cable No, Wire No, Terminal Marking and Cable Types can be changed. Currently creation of new wiring rules is outside the scope of this document.

9.4

Assigning a Junction Box


When selecting a Junction Box when running Wiring Rules, the following window appears showing all junction boxes defined in the current plant area:

This window initially shows all Junction Boxes in the instrument's plant area. You may select the 'All Areas' option to view equipment in all plant areas. Assign the Instrument to a Junction Box double-click on the desired equipment tag. Junction Boxes and other Equipment (other than field devices) can only be created by Wiring Manager - Equipment module Note: The instrument Signal Type is shown near the top of this window. This comes from the Instrument's Signal Type field in the AVEVA Instrumentation Instrument Data window. There is nothing to stop you assigning any instrument to any junction box, regardless of signal type. This is a guide only in this release of AVEVA Instrumentation.

9:5

12.0

Instrument Designer User Guide


Using Wiring Rules to Create Data

9:6

12.0

Instrument Designer User Guide


Import and Export

10

Import and Export


The import and export options available on the Tools tab are described below.

10.1

Import from Excel


The following can be imported from an Excel spreadsheet: Drawings - to add to the Drawing List Hookup catalogue items - to add to the Hookup Items Catalogue

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, in the case of imports into the Drawing List, the Excel file must contain an identity column e.g. the drawing number column in 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, Drawing Number 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 To import drawings or items, open the appropriate grid (i.e. the Drawing List or Hookup Items Catalogue). On the Tools tab, click Imports then Import from Excel. The Select excel workbook to import window is displayed:

10:1

12.0

Instrument Designer User Guide


Import and Export

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

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

10:2

12.0

Instrument Designer User Guide


Import and Export

OR use the automatic mappings created by AVEVA Instrumentation and make changes to these mappings (if 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 command button in the previous window reveals Mapping Name and Description fields and changes the New button to Save.

Once you have entered the details for the mapping, click Save and 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 performed quite often. AVEVA Instrumentation displays the following window showing all the columns in the Excel Workbook selected earlier. Importing the Data To go ahead and import the Excel data, click Import. AVEVA Instrumentation will pop-up an Option window to enable import record data One by one or in Batch. Batch processes all records together then displays a differences report allowing you to accept or reject each change. One by One displays a differences report for each record one at a time.

10:3

12.0

Instrument Designer User Guide


Import and Export

If you are testing the Import Mapping we recommend using Process each Tag... one by one, once the option is selected, click Import. AVEVA Instrumentation will go ahead and process the data and show any differences in a window:

The Import Differences window shows the differences between AVEVA Instrumentation data and Proposed (imported Excel) data for a single tag record (One by one option above). To accept the changes either, select individual field data by clicking Accept checkbox for each, Or: Select the Accept All checkbox at the top of this window (all individual records will be autoselected). To save the checked (accepted) data to the Instrument List, click Save. AVEVA Instrumentation will then proceed to the next tag record to be Imported. To cancel any import for the current tag record, click Close.

10:4

12.0

Instrument Designer User Guide


Import and Export

AVEVA Instrumentation will then proceed to the next record to be Imported. Note: To cancel ALL further importing, click Stop Import.

10.2

Import from another Project


The following can be imported from another AVEVA Instrumentation project: Hookup drawing templates - to add to the Hookup Catalogue Hookup catalogue items - to add to the Hookup Items Catalogue

To import catalogue records, open the appropriate grid (i.e. the Hookup Catalogue or Hookup Items Catalogue). On the Tools tab, click Imports then Import from other Project. The Select an AVEVA Instrumentation Project window is then displayed. Select the project from which data is to be imported and click Select. Login if required. A catalogue import window is then displayed, for example:

Note: To minimise the possibility that data currently being worked on by another user may be affected by an import, a list of the users working on the current project is available from the UserCount link. The number of current users is displayed next to the link. This total includes the user performing the import. This functionality is only available for SQL database projects. Select the catalogue records you want to import, by checking their Select checkboxes. Check the Select All checkboxes to select all forms types. Click Import to copy the selected definitions to your project.

10:5

12.0

Instrument Designer User Guide


Import and Export

AVEVA Instrumentation will copy the selected catalogue records from the selected project to the current project. A progress window is displayed:

If a template file of the same name as an imported form type already exists in the current project, you will be prompted to overwrite it:

When the import is completed, an Import Log window is displayed:

10:6

12.0

Instrument Designer User Guide


Import and Export

10.3

Export to Excel
The contents of the Drawing List, Seed List, Hookup Drawing List, Hookup Catalogue and Hookup Items Catalogue 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 (see above). To export the contents of a grid to an Excel spreadsheet, open the appropriate grid. On the Tools tab, click Exports then Export to Excel. 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. The contents of a grid (except the Seed List) 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 from the Exports menu. 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.

10:7

12.0

Instrument Designer User Guide


Import and Export

10.4

Export to XPS and PDF Files


The contents of the Drawing List, Seed List, Hookup Drawing List, Hookup Catalogue and Hookup Items Catalogue grids can be exported to PDF and XPS files. To the contents of a grid to an Excel spreadsheet, open the appropriate grid. On the Tools tab, click Exports then Export to XPS or Export to PDF as appropriate. A Save file as window (see above) 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.

10.5

Export Selected Drawing Files


The drawing files (.dwg files) of drawings selected in the Drawing list grid can be exported to: a folder specified at time of export with file names formed from the drawing number and sheet number in the normal way, and a pre-defined folder or folders with file names in a pre-defined, user-defined format. The folder(s) and the file name format are specified using facilities accessed from the Application > Setup menu, as described below.

The .dwg files of the selected drawing must be present in the Drawing folder of the project.

10.5.1

Export Drawings to a Specified Folder


Select the drawings in the Drawing Grid. On the Tools tab, click Exports then Export Selected Drawings, then Copy/Archive to a Folder. The Export folder window is then displayed:

10:8

12.0

Instrument Designer User Guide


Import and Export

Use the window to select the folder to which the drawings are to exported. Browse to the required folder and double-click on it to select it. If drawings are to be exported to a new folder, enter the location and name of the new folder in the New folder name (if required) field. Click Ok. If you specified that a new folder is to be created, a message is displayed requesting that you confirm this. The export of the selected drawings then takes place. A message is displayed when the export is completed, for example:

10.5.2

Export Drawings to Pre-Defined Folders with File Names in a PreDefined Format


Before drawings can be exported using this option, the folder or folders to which they are to be exported and the format of the drawing file names must be defined. Setting the Folder Name and File Name Folder To specify the folder and sub-folders that drawings are to be exported into, and the files names that they will be given, click Setup on the main Application menu. On the Setup menu, click Export File Name/Folders. The File Export Settings window is then displayed:

In the Root Folder field, enter the root folder under which the sub-folders that contain the exported files are to be located. Click the button to browse for the required folder.

10:9

12.0

Instrument Designer User Guide


Import and Export

If no sub-folders are specified, as described below, all the files will be exported into this folder. To specify the sub-folder structure, select the drawing attributes that will define the names of the sub-folders and from the Sub Folder list. To select an attribute, check the appropriate checkbox. The selected attribute is then displayed in curly brackets in the field below the list. As required, enter delimiter characters or text between the selected attributes in this field. To specify the file name format of exported drawings, follow the same procedure as for subfolders, but using the File Name list and field. Example:

In the example above, a Sub Folder structure of {ProjectNo}-Area{Area} and a file name format of {DwgNo}-{Sheet}-{Rev} have been selected. The selected root folder is "C:\AI Drawings". Using these settings, from a project called "Project1", drawings are exported with the following details: Area 00 01 Drawing Number ABC123 XYZ890 Sheet Number 1 1 Revision A B

This will result in the creation of folder structure and files as follows: C:\AI Drawings (root folder) Project1-Area00 (sub-folder) ABC123-1-RevA.dwg (exported drawing file) Project1-Area01 (sub-folder) XYZ890-1-RevB.dwg (exported drawing file)

10:10

12.0

Instrument Designer User Guide


Import and Export

Export Drawings Select the drawings in the Drawing Grid. On the Tools tab, click Exports then Export Selected Drawings, then Copy to User Defined Names. Note: Drawings may also be optionally exported when they are updated. Refer to Update Drawings. The export of the selected drawings then takes place. A message is displayed when the export is completed, for example:

10.6

Export to AVEVA NET


AVEVA Instrumentation Designer includes facilities to export reports and associated drawing data (i.e. of the drawings on the reports) for import into AVEVA NET. The files produced by the export can subsequently be imported into AVEVA NET Portal (refer to AVEVA NET documentation for details).

10.6.1

AVEVA NET Export Configuration


Before files can be exported for AVEVA NET, the export must be configured. From the Application menu, click Setup, then AVEVA NET Export. The AVEVA NET Export Configuration window is then displayed.

10:11

12.0

Instrument Designer User Guide


Import and Export

The window consists of a number of tabs. The Staging tab is used to specify where files are to be exported to and general settings for AVEVA NET exports. Note that the settings specified on this tab are applied to exports from all AVEVA Instrumentation modules for the project. In the Staging Area field of the Staging tab, specify the top level folder into which files are to be exported. Click the button to browse for the required folder. Note that a separate folder for the export of Designer reports can be specified instead. See below. In the Log File field, specify the file name and the location of the log file (a .txt file) that will be used to record details of AVEVA NET exports. Click the button to browse for the required folder. Click the open file button example Notepad. to open the log file. It will open in the default text editor, for

If no file is specified in the field, a new, blank .txt file is opened. If you specify a file that does not exist, you will be asked if you wish to create that file at the specified location. If you click Yes, a new blank .txt file is created and opened for editing. If, for every object being exported, a separate output file is to be generated, check the Output File Per Object checkbox. If it is required that Designer report data is to be exported to a separate folder, check the Separate Folder Per Deliverable checkbox. If the Create Trigger File checkbox is checked, a trigger.start file (an empty text file) is created in the staging area folder for each file type. The purpose of the trigger.start file is to

10:12

12.0

Instrument Designer User Guide


Import and Export

trigger the AVEVA NET Portals import controller to automatically process all the files that reside in the same folder. The AVEVA Instrumentation Designer Deliverables field below this checkbox can then be used to specify an output folder for the Designer report data export. By default, the field will be populated with the folder specified in the Staging Area field. Change this are required. Click the button to browse for a folder. The other three tabs are used to select configuration and mapping files for the export of Designer report data. For details of these files, refer to AVEVA NET Export Configurations Files. The three tabs each include a field for the Designer report data export. Specify the configuration or mapping file to be used.

Click the button to browse for the required file. Click the open file button for example Notepad. to open the selected file. It will open in the default text editor,

If no file is specified in the field, a new, blank .txt file is opened. If you specify a file that does not exist, you will be asked if you wish to create that file at the specified location. If you click Yes, a new blank .txt file is created and opened for editing. To populate the fields with the default configuration and mapping files supplied with AVEVA Instrumentation, click Copy Sample Files. Note this selects configuration and mapping files for all AVEVA Instrumentation modules, not just the current module, and will replace any files previously selected.

10:13

12.0

Instrument Designer User Guide


Import and Export

10.6.2

Export Reports and Associated Data


To export reports and associated data, on the Reports tab, click Report Manager to open the Report Manager. Select the report to be exported, then click Export to AVEVA NET option, which is on a drop-down menu opened from the Export button.

A Save As dialog is then displayed. Specify the name and the location that the report PDF is to be saved to. Click Save. The Export To AVEVA NET window is then displayed, showing the progress of the import.

Once the export is completed, the Export Report window is displayed, listing the report for which the data export was requested and whether or not that export was successful or not:

10:14

12.0

Instrument Designer User Guide


Import and Export

10.6.3

Export Overview
AVEVA Schematic Gateway is a common Gateway that will be used by different AVEVA schematic applications to export various kinds of data to AVEVA NET. This Gateway refers to various configurations which are provided to it through various configuration files (described in sections below). As of now, AVEVA Schematic Gateway processes data (provided to it in a form of a Dataset) as well some external files (Excel spreadsheets - xls and xlsx, PDF files). Data provided to the Gateway through dataset gets processed and output gets generated into EIWM format. Gateway processes excel spreadsheets and produces output in MHTML format. Gateway processes PDF files and produces output in PDF format.

10:15

12.0

Instrument Designer User Guide


Import and Export

10:16

12.0

Instrument Designer User Guide


Work Packs

11

Work Packs
Work packs can be created which consist of collections of items with shared project management requirements or properties. For example, all the items an individual user or group of users is concerned with may be assigned to a single work pack. Time constraints may be assigned to work packs, for example the required start and completion dates of items in the a work pack, so that work can be more easily prioritised. 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 Application Menu > Work Packs > Open. To create a work pack, click New to display the Work Pack window. 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.

11:1

12.0

Instrument Designer User Guide


Work Packs

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. Click Cancel to exit the WorkPack window and return to the Select a WorkPack window.

11:2

12.0

Instrument Designer User Guide


Work Packs

Once a work pack has been created, items can be assigned to it. To assign instruments to a work pack, select the required instruments in the grid view and select Application Menu > Work Packs > Assign to Work Pack to display the Select a WorkPack window. Select the required work pack from the list and click Select. The selected items will now be displayed in the WorkPackNumber column in the grid view. Note: When working in a work pack any newly created objects will automatically be assigned to the current work pack. To un-assign an item from a work pack, select the item in the grid view and select Application Menu > Work Packs > Un-Assign from Work Pack. 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 Application Menu > Work Packs > Open 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 Application Menu > Work Packs > Open to display the Select a WorkPack window. Select the work pack to be deleted from the list and click Delete. If entities have been assigned to the work pack, a Delete confirmation window will be displayed informing the user that entities 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 entities assigned to the work pack will be un-assigned.

11.1

Import Work Pack


The Import from Excel option, available from the Tools tab, recognises when the user is working in a work pack and displays a message informing the user they are working under a 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. Note: The Import from Excel is only active for some areas within the application.

11:3

12.0

Instrument Designer User Guide


Work Packs

11:4

12.0

Instrument Designer User Guide


Change Reports

12
12.1

Change Reports
Audit Manager
AVEVA Instrumentation has an in-built Audit Manager that enables users to view database changes made during your project in the database audit log. Note: Audit Manager is supported by SQL Server databases only. Audit Manager is not available if your project database uses Access. The Audit Manager is available from most Grid Views within each AVEVA Instrumentation module by selecting: Tools from the top menu bar, then View Audit Log option, AVEVA Instrumentation will open the Audit Manager main window:

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.

12:1

12.0

Instrument Designer User Guide


Change Reports

The Audit log includes the User Name and Date/time of the change. The User Name is the Windows login name for the user who 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 to export the grids data to Excel if required.

12.2
12.2.1

Database Revisions
Project Database Revisions
AVEVA Instrumentation allows users to make a copy of the current database state by saving the database as a Database Revision. At any time, the current database can be compared to a saved Database Revision. 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: From the Application menu, click Setup option, then click Project Revisions option AVEVA Instrumentation will open the Project Revisions window:

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

12:2

12.0

Instrument Designer User Guide


Change Reports

Toolbar Menus Command New Description Saves the state of the current project database as a Revision for change reporting in the future with the Saving a Database Revision window. Deletes the selected Database Revision. Displays the Compare Changes between Database Revisions to compare current database sate with the selected Database Revision. Finds a value in the Grid. Displays a window to Filter the Grid. Refreshes (re-loads) the grid with data from the database. Closes this window.

Delete Compare Find Filter Refresh Close

12.2.2

Saving a Database Revision


Prior to comparing changes a Database Revision must be saved. A 'Compare Changes' report always compares a previously saved Database Revision to the current database. To Save a Database Revision From the Database Revisions window, click New from the toolbar menu. This pops up the New Database Revision window:

To save the current database state as a Database Revision enter 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: We recommend that Database Revisions are saved only when all other engineers and designers have exited AVEVA Instrumentation application modules.

12:3

12.0

Instrument Designer User Guide


Change Reports

12.2.3

Compare Changes between Database Revisions


Prior to comparing changes a Database Revision must be saved. A 'Compare Changes' report always compares a previously saved Database Revision to the current database. To Compare Changes to a saved Database Revision: From the Database Revisions window, click Compare from the toolbar menu. This pops up the Compare Database Revisions window:

To compare the current database state to the Database Revision selected in the previous Database Revision list: First: Select the Change Report type from the list on the right of the above window. Note: Multiple Change Reports may be selected by clicking on any number of names 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 you run multiple detail reports. When the comparison reports are completed AVEVA Instrumentation will display any differences in the Changes grid as shown in this next example:

12:4

12.0

Instrument Designer User Guide


Change Reports

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

12:5

12.0

Instrument Designer User Guide


Change Reports

12:6

12.0

Instrument Designer User Guide


Report Manager

13

Report Manager
AVEVA Instrumentation has an in-built Report Manager that enables users to create and modify reports. The Report Manager is available from most Grid Views within each AVEVA Instrumentation module by selecting: On the Reports tab, select Reports, then Report Manager to display the AVEVA Instrumentation Report Manager window.

The Report Manager shows a list of all previously defined reports for the current AVEVA Instrumentation Grid in the list on the left hand side. In the example above only one report has been created. If there a multiple reports already created the user can run those reports by clicking on the report name (in the list of Reports on the left side). The Report Manager supports printing to your printer and PDF file format as well as to Excel and other formats. The data is formatted as defined within the report design. The report design is created and modified by AVEVA Instrumentation users using the Report Designer.

13:1

12.0

Instrument Designer User Guide


Report Manager

Report Manager Command Buttons New Edit Used to create new reports. Refer to Create a New Report (for the current Grid). Used to edit existing reports. Opens the AVEVA Instrumentation Report window as described in a Create a New Report (for the current Grid) with details of the report selected in the left hand pane displayed for editing. Used to delete the report selected in the left hand pane. A message is displayed requesting that the deletion be confirmed. Click Yes to proceed. Displays the Report Preferences window. Refer to Report Preferences. Issues selected report(s). Displays the Issues window listing all the current issues for the selected report. Displays the Issues window. Highlights the differences between the current report and a report issue selected from a further sub-menu For details, refer to Report Issues. Revision Add Revisions Edit Revisions Displays a list of all reports with revisions (and their revisions). Sub-menu options are: Used to create a new revision. Used to edit the current revision. For details, refer to Report Revisions. Import Export Close Used to import reports from another AVEVA Instrumentation project or from an Access database. Refer to Import Reports. Used to export reports and associated data to AVEVA NET. Refer to Export to AVEVA NET. Closes the Report Manager

Delete

Preferences Issue Open Issues For Selected Open Issues For All Highlight Issue Changes for

13:2

12.0

Instrument Designer User Guide


Report Manager

Report Command Buttons These buttons provide facilities for the currently displayed report. Search Opens a Find window with standard facilities, used to search for text within a report.

Print Quick Print Page Setup Scale

Used to print the current report. Opens a standard Windows Print Options window. Used to print the report using the default printer settings. Used to configure the report page. Opens a standard Windows Page Setup window. Used to scale the report. Opens the following drop-down:

Hand Tool Magnifier Zoom Out Zoom % Zoom In First Page Previous Page Next Page Last Page

Changes the cursor to the hand tool, which can be used to pan around the report. Changes the cursor to the magnifier tool, used to change the report view by zooming in and out. Used to change the report view by zooming out. Used to adjust the report view by the zoom percent value. Used to change the report view by zooming in. Used to display the first page of a report. Used to display the previous page of a report. Used to display the next page of a report. Used to display the last page of a report.

13:3

12.0

Instrument Designer User Guide


Report Manager

Multiple Pages

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

Color Background

Used to change the colour of the report background, as selected from the following drop-down:

13:4

12.0

Instrument Designer User Guide


Report Manager

Watermark

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

13:5

12.0

Instrument Designer User Guide


Report Manager

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:

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.

13:6

12.0

Instrument Designer User Guide


Report Manager

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. Edit Layout Exit Opens the Report Designer, used to edit the layout of the report. Refer to Refer to Edit Report Layouts Closes the Report Manager.

13:7

12.0

Instrument Designer User Guide


Report Manager

13.1

Create a New Report (for the current Grid)


Click New (or select an existing report and click the small drop-down menu arrow next to new to 'Copy Selected'), to display the AVEVA Instrumentation Report window.

The user must create a Report Name by entering a name for the report in the View Name field and a Description for the report. Note: Document No and Description are mandatory fields. Click the Fields tab to show a list of fields available for use in the report.

13:8

12.0

Instrument Designer User Guide


Report Manager

The user can select multiple fields as required from the Fields list. Define a Sort Order, by clicking Sorting to select a field(s) to sort by in the new report.

13:9

12.0

Instrument Designer User Guide


Report Manager

To select a field double-click the field from the list of View Fields. The user can also set a data filter to apply to your report (to limit the data to certain criteria) by clicking Filtering.

13:10

12.0

Instrument Designer User Guide


Report Manager

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

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

13:11

12.0

Instrument Designer User Guide


Report Manager

Note: Revisions can also be added, edited, deleted and viewed using facilities directly accessible from the Report Manager window. Refer to Report Revisions. The user must complete the fields and select Save to return to Revisions where the added revision will be displayed in the list. Clicking Cancel returns to Revisions without adding a revision to the list. 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 window is displayed requesting the user to confirm the deletion.

Click Yes to confirm the deletion and return to Revisions. The selected revision is now removed from the list. Click No to cancel the revision. The user can view the revision in a sub-report by clicking View Revisions Subreport to display the Custom Report window.

13:12

12.0

Instrument Designer User Guide


Report Manager

Note: The report can also be viewed by selecting Custom Reports on the Reports tab. If the user has added revisions and wants to view them, these must be saved before clicking View Revisions Subreport. A message will be displayed requesting the user saves the changes.

Click Yes to save the changes to report view and proceed to view the report with all the changes displayed, or click No to view the report without the changes. Once the user has defined all the fields, sort order and any Filters, click Save. AVEVA Instrumentation will then build the report and display it in the Report Manger window.

13.2

Report Preferences
To set report preferences, click Preferences on the Report Manager toolbar. The Report Preferences window is displayed:

13:13

12.0

Instrument Designer User Guide


Report Manager

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.

13.3

Report Revisions
Revisions can be viewed, created, edited and deleted from the AVEVA Instrumentation Report window (refer to Create a New Report (for the current Grid)). These facilities are also directly accessible from the Report Manager window, as explained below.

13.3.1

Create a Revision
To create a revision for a report select the report, then click Add Revision, accessible from the drop-down menu displayed by clicking the button next to the Revisions button. The Revision Entry window is then displayed:

13:14

12.0

Instrument Designer User Guide


Report Manager

Note: Double-click on the Date text box to bring up a date selection form (you can also press the Enter key when the Date text box has focus). Note: The Description field contains a list of all previously created revision descriptions. You can add a new description by entering any desired description. Any new descriptions will be available in future Revision Entry. Command Buttons Create New Creates a new Revision with data entered in the Revision Details fields.

Note: When creating a new revision leaving the Revision No text box blank will cause Designer 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. Edit Current Cancel Changes the current revision record to data entered in the window fields above. Exits without saving changes or adding a revision.

13.3.2

Edit a Revision
To edit the current revision, click Edit Revision, accessible from the drop-down menu displayed by clicking the button next to the Revisions button. The Revision Entry window is then displayed with the details of the current revision displayed for editing.

13:15

12.0

Instrument Designer User Guide


Report Manager

13.3.3

Viewing and Editing Multiple Document Revisions


To view a list of all revisions of all reports, click Revisions. 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. To edit an existing revision click Edit. The Multi-Field Edit (Bulk Edit) window is displayed.

13:16

12.0

Instrument Designer User Guide


Report Manager

To edit a revision field, check the appropriate checkbox and enter the new value. Click Select all to select all fields for editing. Click Copy first record's data to copy the values for the revision first selected in the Revision window into the fields. Once the required changes have been entered, click Save.

To add a new revision, click New. The Revision Entry window (described above) is then displayed. Enter the required details and click Save. To delete a revision, select the revision and click Delete. A message will then be displayed requesting that the deletion be confirmed. Click Yes to confirm the deletion or No to cancel.

13.4

Report Issues
To issue a report select it and click Issue. A progress dialog for the issue is displayed:

13:17

12.0

Instrument Designer User Guide


Report Manager

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.

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.

13.4.1

View Previous Issues


To see previous issues click either Open Issues For Selected or Open Issues For All accessible from the drop-down menu displayed by clicking the button next to the Issue button.

The Issues dialog is then displayed.

13:18

12.0

Instrument Designer User Guide


Report Manager

If Open Issues For Selected was clicked the dialog lists all the issues for the drawing currently selected in the grid. If Open Issues For All was clicked the dialog lists all the issues for all the drawings 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 Delete Open the selected issues in the Preview window (see below). 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:

Print Find

Prints the selected issues. Displays the Find window to search by any text string located anywhere within the grid.

13:19

12.0

Instrument Designer User Guide


Report Manager

Filter Refresh Close

Opens the Advanced Grid Filters window used to define the current grid view filter criteria. Updates entire grid with latest database information (useful in multi-user project environments). Closes the window.

Preview Window The Preview window is opened by selected 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 Manager window, with the addition of buttons for opening and saving reports, and with the exception of the Edit Layout button. Many of the facilities accessible from the toolbar are also accessible from the File, View and Background menus.

13.4.2

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, click Highlight Issue Changes for, accessible from the drop-down menu displayed by clicking the button next to the Issue button, then selected the issue with which the current data is to be compared from the sub-menu.

13:20

12.0

Instrument Designer User Guide


Report Manager

Changes are then highlighted in the colour selected in the Report preferences window (refer to Report Preferences).

Changes to revision data are not highlighted.

13.5

Import Reports
Reports definitions can be imported from another AVEVA Instrumentation project, or from an Access database. Importing from another Project To import from another AVEVA Instrumentation project click Import on the Report Manager toolbar. The Select an AVEVA Instrumentation Project window is then displayed. Select the required project and click Select. The Report Import window is then displayed. This lists all the reports definitions in the selected project for the current grid, e.g. the Drawing List

13:21

12.0

Instrument Designer User Guide


Report Manager

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 left hand pane of the Report Manager. 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. Importing from an Access Database Reports can be imported from an Access database. This can be used to import reports from another project that are not accessible from the current installation of AVEVA Instrumentation via the Select an AVEVA Instrumentation Project window. To import from another AVEVA Instrumentation project click the small down arrow next to the Import button on the Report Manager toolbar. From the menu that is then displayed, click Import from Access File. A standard Windows Open window is then displayed. Use this to browse for and select the Access database (.mdb) file. Click Open. Only AVEVA Instrumentation report databases should be selected. The Report Import window is then displayed. This lists all the Designer reports definitions in the selected project. Select and import the required reports as described above.

13:22

12.0

Instrument Designer User Guide


Report Manager

13.6

Edit Report Layouts


To edit the layout, click Edit Layout - located at the top right of the Report window to display the Report Designer window.

The Report Designer enables the user to: Layout your selected fields on the page Set font details (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 Note: To add additional fields to your report drag the field name onto the page (from the Fields List tab tree view) at the middle right of this window. If you need to add a new field that is not yet in that tree view then you will need to save the layout and select your new fields from the Grid fields list as described in 'Second: Select the Grid Fields above'. For more information about editing report layouts please refer to the Report Designer User Guide.

13.7

View, Edit and Create Custom Reports


Custom reports, which include Revision sub-reports can be viewed by clicking Custom Reports on the Reports tab. The Report Manager window is then displayed.

13:23

12.0

Instrument Designer User Guide


Report Manager

The Report Manager for custom reports provides the same facilities as that for non-custom reports, as described above, except that the Preferences, Issue and Revisions buttons are not available, and the New and Edit buttons display a window that is used to create and edit the SQL queries that define custom reports:

When creating a new custom report, enter the name of the report in the Report Name field. To add an SQL query, click Add Query. The SQL Query Maker is then displayed, in which the query can be defined.

13:24

12.0

Instrument Designer User Guide


Report Manager

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.

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. Click Save to save changes to the report definition and exit the window. Click Cancel to exit the window without saving.

13.8

Export to AVEVA NET


XML files containing details of items (e.g. drawings) detailed on reports, plus PDF files of reports can be generated. These files are exported to a staging area from where they can be imported into AVEVA NET. Initiate the export by selecting a report and clicking the Export to AVEVA NET option, which is accessible from a drop-down menu from the Export button. Refer to Import and Export for further information.

13:25

12.0

Instrument Designer User Guide


Report Manager

13:26

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

AVEVA NET Export Configurations Files


Following configuration files will be used by the AVEVA Schematic Gateway to process the input: Project Configuration Attributes Mapping Classes 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.

A.1
A.1.1

Project Configuration
High Level Structure of the Project Configuration
<?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> <TargetClassID> </TargetClassID> <TargetContext> </TargetContext> <TargetName> </TargetName> </Association> </Mapping> <InputFiles> <Files> <Extension> </Extension> <ExcelRanges> </ExcelRanges> <ExcelAddHotspotting> </ExcelAddHotspotting> <TagsNamedRange> </TagsNamedRange> </Files> <RegularExpression> <Search> </Search>

A:1

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

</RegularExpression> </InputFiles> </ConfigurationSettings>

A.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 Attribute:

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

A:2

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

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')"/> <Context Value="PROJECTCONTEXT"/> <ClassID From="Description"/> <Name From="Description" Default="N/A" RegExPattern="[A-Z]{3}" RegExRemovePattern="\s"/> </Mapping>

A:3

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

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 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. 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 following sub-elements:

A:4

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

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 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 support 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> <Extension>xlsx</Extension> <ExcelAddHotspotting>true</ExcelAddHotspotting> <ExcelRanges>true</ExcelRanges> <TagsNamedRange>VNETTags,TagNo</TagsNamedRange> </Files>

A:5

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

Files will support 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.

A.2

Attributes Mapping
Attributes mapping configuration file helps in mapping attributes of the source entity to its corresponding characteristics in the output file.

A.2.1

High Level Structure of the Attributes Mapping


<?xml version="1.0" encoding="utf-8"?> <Attributes>

A:6

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

<Attribute> </Attribute> </Attributes>

A.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. 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".

A:7

12.0

Instrument Designer User Guide


AVEVA NET Export Configurations Files

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

A.3.1

High Level Structure of the Classes Mapping


<?xml version="1.0" encoding="utf-8"?> <Classes> <Class> </Class> </Classes>

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

A:8

12.0

Instrument Designer User Guide

Index

A
Add/Edit Revisions . . . . . . . . . . . . . . . . 5:23 Apply Filter . . . . . . . . . . . . . . . . . . . . . . 3:15 Areas Adding . . . . . . . . . . . . . . . . . . . . . . . 4:1 Assign Edit DataLinks . . . . . . . . . . . . . . . . . 6:5 Junction Box . . . . . . . . . . . . . . . . . . . 9:5 Tags to Loops . . . . . . . . . . . . . . . . . . 8:3 Wiring Rule . . . . . . . . . . . . . . . . . . . . 8:7 Audit Manager . . . . . . . . . . . . . . . . . . . . 12:1

Drawing Creation . . . . . . . . . . . . . . . . . . . . . . 6:1 Generation . . . . . . . . . . . . . . . . . . . . 6:1 Importing . . . . . . . . . . . . . . . . . . . . 5:17 Information . . . . . . . . . . . . . . . . 5:9, 5:10 List . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1 Title Setup Preferences . . . . . . . . . 5:20

E
Edit Engineering Loop . . . . . . . . . . . . . . 5:10 Tag Details . . . . . . . . . . . . . . . . . . . . 8:7 Existing Tags . . . . . . . . . . . . . . . . . . . . . 8:4 Export Reports and Associated Data . . . 10:14 Selected Drawing Files . . . . . . . . . 10:8 to AVEVA NET . . . . . . . . . . . . . . . 10:11 to Excel . . . . . . . . . . . . . . . . . . . . . 10:7 to XPS and PDF Files . . . . . . . . . . 10:8

B
Blocks Copying . . . . . . . . . . . . . . . . . . . . . 6:15

C
Check New Loops . . . . . . . . . . . . . . . . . . . 5:17 New Terminations . . . . . . . . . . . . . 5:18 Create Loop Wiring Check . . . . . . . . . . . . . 8:10 Loop Wiring using Wiring Rules . . . . 9:3 New Grid View . . . . . . . . . . . . . . . . 3:18 Wiring Re-running . . . . . . . . . . . . . . 9:1

F
Filter Criteria Exists . . . . . . . . . . . . . . . . . . . . . . . 3:16 Select . . . . . . . . . . . . . . . . . . . . . . . 3:15

G
Grid View define . . . . . . . . . . . . . . . . . . . . . . . 3:18

D
DataLinks Assign . . . . . . . . . . . . . . . . . . . . . . . . 6:4 AutoCAD . . . . . . . . . . . . . . . . . . . . . 6:4 Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5

H
Hookup

Index page 1

12.0

Instrument Designer User Guide

Accessing . . . . . . . . . . . . . . . . . . . . . 7:1 Add New Drawing . . . . . . . . . . . . . . . 7:3 Assigning Tags . . . . . . . . . . . . . . . . . 7:6 Drawing List . . . . . . . . . . . . . . . . . . . 7:1 Items Catalogue . . . . . . . . . . . . . . . 7:19 Template . . . . . . . . . . . . . . . . . . . . . 7:6 Template Catalogue . . . . . . . . . . . . 7:10

T
Template Open . . . . . . . . . . . . . . . . . . . . . . . . 6:3 Title Block . . . . . . . . . . . . . . . . . . . . . . . . 6:6

W
Wiring Configuration PickList . . . . . . . . . . . 8:8 Wiring Rules . . . . . . . . . . . . . . . . . . . . . . 9:1 Applying . . . . . . . . . . . . . . . . . . . . . . 9:1 Assign . . . . . . . . . . . . . . . . . . . . . . . 8:7 Running . . . . . . . . . . . . . . . . . . . . . . 9:1 Using . . . . . . . . . . . . . . . . . . . . . . . . 9:2 Work Packs . . . . . . . . . . . . . . . . . . . . . 11:1 Import . . . . . . . . . . . . . . . . . . . . . . . 11:3

I
Import from another Project . . . . . . . . . . . . 10:5 from Excel . . . . . . . . . . . . . . . . . . . 10:1 Import and Export . . . . . . . . . . . . . . . . . 10:1 Instrument Signal Type . . . . . . . . . . . . . . 9:5 Issues . . . . . . . . . . . . . . . . . . . . 5:24, 13:17

L
Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 Data . . . . . . . . . . . . . . . . . . . . . . . . . 8:1 Wiring Check Create . . . . . . . . . . . 8:10 Wiring Check Reports . . . . . . . . . . 8:10

N
New Grid View . . . . . . . . . . . . . . . . . . . 3:18

O
Open Template . . . . . . . . . . . . . . . . . . . . . 6:3 Template List . . . . . . . . . . . . . . . . . 6:14

P
PickList Management . . . . . . . . . . . . . . 3:28

R
Report Manager Edit Report Layout . . . . . . . . . . . . 13:23 Import Reports . . . . . . . . . . . . . . . 13:21 Report Preferences . . . . . . . . . . . 13:13 Revision Entry . . . . . . . . . . . . . . 5:23, 13:14 Revision History . . . . . . . . . . . . . . . . . . . 5:7

S
Seed Drawing List . . . . . . . . . . . . . . . . . . 6:9 Selecting Filter Criteria . . . . . . . . . . . . . . . . . . 3:15 Junction Box . . . . . . . . . . . . . . . . . . . 9:5

Index page 2

12.0