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.

The Microsoft Office User Interface is subject to protection under U.S. and international intellectual property laws
and is used by AVEVA Solutions Limited under license from Microsoft.

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

Revision Sheet

Date Version Comments / Remarks

March 2012 Copyright added to all pages.
March 2013 12.1.SP1 Updates incorporated
Instrumentation Designer User Guide
 Instrument Designer User Guide

Instrument Designer User Guide

Contents Page

Instrument Designer
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Feature Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4
AVEVA Instrumentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:4
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:5

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

Instrument Designer Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Project Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Home Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Data Management Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
View Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Contextual Actions Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Working with the Data Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Finding and Replacing Text in a Grid. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Advanced Grid Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Grid Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
PickList Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Revisions Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Rev Clouds Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

© Copyright 2000 to current year. i 12 Series

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

Terminations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4

Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Drawing List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Add a New Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3
Drawing Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:10
Rename Selected Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:13
Delete Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17
Import Drawings into the Drawing List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17
Loop Diagram Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17
Termination Diagram Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:19
Importing from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:20
Drawing Title Setup Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:21
Update Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:22
Drawing Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23
Create a Revision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23
Edit a Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:24
Viewing and Editing Multiple Document Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:25
Drawing Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:26
View Previous Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:28
Non-AI Termination Drawing References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:29
Drawing Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30
Publishing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30
Publishing Drawings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:32

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

Open a Template Drawing with AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:3
Assign DataLinks in AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5
DataLinks Report Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:6
Seed Drawings List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:9
Auto Insert Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:12
DataLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
DataLinks Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13

Hookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Hookup (Installation) Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

© Copyright 2000 to current year. ii 12 Series

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

Access the Hookup Drawing List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Add a New Hookup Drawing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:4
Assign a Hookup Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6
Assign Tags to a Hookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6
Editing Hookup Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
Hookups Template Catalogue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10
Add a New Hookup Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10
Edit Template Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:12
Import Hookup Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13
Assign Hookup Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:15
Assign Hookup DataLinks in AutoCAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:17
Hookup Items Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:19
Adding a New Catalogue Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:20
Hookup Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:21

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:12
Equipment Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:14

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

Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Export to XPS and PDF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Export Selected Drawing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Export Drawings to a Specified Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Export Drawings to Pre-Defined Folders with File Names in a Pre-Defined Format . . . . . 10:2

© Copyright 2000 to current year. iii 12 Series

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

Export to AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:4

AVEVA NET Export Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:5
Export Reports and Associated Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:7
Export Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:8

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

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

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

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

© Copyright 2000 to current year. iv 12 Series

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

1 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)

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 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.

Opening AutoCad Drawings

When attempting to open an AutoCAD template, from within AVEVA Instrumentation you
may receive the following message:
Error Decrypting Data
This is caused by the fact that the original drawing was created by an application that is not
trusted by AutoCAD. To bypass this problem the following action need to be completed:
Open the drawing in native AutoCAD
At the command line enter: Dwgcheck
Enter a new value = 0
Save the drawing
This will prevent this error occurring.

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

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

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

• 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).
• 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 enables users to view changes by object type.

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

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

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

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

1.2 System Requirements

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

1.3 AVEVA Instrumentation

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

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

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

1.4 Guide Structure

Introduction a brief description of Instrument Designer.

User Interface begins by displaying the View tab of Instrument Designer.

Options describes how to set various Designer options and preferences

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

Drawing List is the main Designer window for adding/editing and accessing
drawings.

Drawing Generation how Designer generates CAD drawings from the Drawing List.

Hookups drawings are created by assigning a pre-defined Hookup

Template to each project hookup drawing.

Engineering Data allows access to the Instrument Engineering data normally

created by the Engineer application.

Using Wiring Rules to to auto generate typical field instrument wiring/cabling.

Create Data

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

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

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

Report Manager that enables users to create and modify reports.

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

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

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

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

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

2 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 Home tab.

2.1 Instrument Designer Tabs

On opening, the Designer module each displays four tabs: Project, Home, Data
Management and View. Once a grid is opened, an optional "Contextual Actions" tab, named
after that grid and containing commands specific to that grid, is displayed if applicable.

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

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

The rest of this section describes those tab options specific to Designer.
For details of options common to all Instrumentation modules, refer to the Common
Functionality User Guide.

2.1.1 Project Tab

The Project tab includes the following Designer-specific options:

Setup Sub Menu:

Loop Titles (Import Displays the Loop Import Drawing Titles Settings window.
format) Refer to To Define Loop Diagram Drawing Titles.

Termination Titles Displays the Termination Import Drawing Titles Settings

(Import format) window. Refer to To Define Termination Diagram Drawing
Titles.

Set Export File Name/ Displays the File Export Settings window allowing users to
Folders 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

Drawings Export to Allows a choice where the file is published and an executable
External System format for each published item. Refer to Drawing Publishing.
Configuration

2.1.2 Home Tab

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

Drawing List Displays the Drawing List grid view.

Template List Displays the Template window showing all project Template files
(enables opening selected template in AutoCAD. Refer to Opening
AutoCad Drawings.). Refer to Open a Template Drawing with
AutoCAD.

Seed List Displays the Seed List grid view. Refer to Seed Drawings List.

Hookup Displays the Hookup Drawings List grid view showing only hookup
Drawing List drawings and hookup specific commands. Refer to Hookup
(Installation) Drawings.

Under the Catalogue heading:

Hookup Displays the Hookup Catalogue grid view. Refer to Hookups

Catalogue Template Catalogue.

Hookup Items Displays the Hookup Items Catalogue grid view.

Catalogue

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

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

The following Designer-specific options are accessed from the Fixed Reports option in the
Reports section:

DataLinks for If a single Drawing is selected, this command displays the

Selected Drawing DataLinks Report Window which displays all the Datalinks
available for the drawing, including values returned by each
DataLink based on current project data.

Templates Used 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. Refer to
Open a Template Drawing with AutoCAD.

BOM/Material Take- Displays the Hookup Bill of Materials window. Refer to Hookup
off Reports.

Tags Assigned Displays the Tags Assigned to Hookup window. Refer to Hookup
Reports.

Tags not yet Displays the Tags not yet Assigned to a Hookup window. Refer
Assigned to Hookup Reports.

2.1.3 Data Management Tab

The Data Management tab includes the following Designer-specific options:
In the AVEVA Integration section:

Publish to AVEVA Used to export data to AVEVA NET. Not currently active.
NET

In the Import section:

From Other Project Used to import Hookup drawing templates and Hookup
catalogue items from another Instrumentation project. Refer to
Import Hookup Catalogue

2.1.4 View Tab

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

2.1.5 Contextual Actions Tab

The Contextual Actions tab contains options specific to the grid which is currently being
viewed. If no grid is open, the tab will not be displayed.
The name of the tab will be the name of the current grid.

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

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

For details of the options on this tab, refer to the appropriate grid topic:

Drawing List Displays the Drawing List grid view.

Template List Displays the Template window showing all project Template files
(enables opening selected template in AutoCAD. Refer to Opening
AutoCad Drawings.). Refer to Open a Template Drawing with
AutoCAD.

Seed List Displays the Seed List grid view. Refer to Seed Drawings List.

Hookup Displays the Hookup Drawings List grid view showing only hookup
Drawing List drawings and hookup specific commands. Refer to Hookup
(Installation) Drawings.

Hookup Displays the Hookup Catalogue grid view. Refer to Hookups

Catalogue Template Catalogue.

Hookup Items Displays the Hookup Items Catalogue grid view.

Catalogue

2.2 Working with the Data Grid

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

2.3 Finding and Replacing Text in a Grid

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

2.4 Advanced Grid Filters

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

2.5 Grid Manager

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

2.6 PickList Management

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

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

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

3 Options

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

3.0.1 General Tab

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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. Default option which uses the drawing number shown in the
DwgNo column on the Drawing List grid view.

Use Client Dwg No 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.

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

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

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 Default colour is White. This is the Layer associated with a 0.25mm pen width
and 2.5mm text height.

L3 Default colour is Yellow. This is the Layer associated with a 0.35mm pen width
and 3.5mm text height.

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

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

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

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

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

4 Areas

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

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

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

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

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

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

Note: Hookup drawings are created using a separate facility. See Hookups.

To open the Drawing List, click Select in the Grids and Schedules section of the Home
tab.
Select Drawings from the list of grids that is then displayed. The Drawing List grid is then
displayed:

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.

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

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

Special 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:
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 Contextual Action Options

The following options are located on the Contextual Actions - Drawings tab:

Records Section

Refresh

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

Delete

Actions Section

Open Opens the selected drawing for reviewing/printing etc in AutoCAD

(editing title block and revision information should be done from the Edit
button on the Home tab). Refer to Opening AutoCad Drawings

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

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). Refer to Drawing Issues.

Sub-menu options are:

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

Open Issues Displays the Issues window. Refer to View Previous

For All Issues for further information.

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

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

Revisions Displays a list of all drawings with revisions (and their revisions). Refer
to Viewing and Editing Multiple Document Revisions.
Sub-menu options are:

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

Revisions Revision.

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

Revisions Revision.

Check for Checks for new Loop drawings created in the Engineer module and
New Loops imports them into the Drawing List. Refer to Import Drawings into the
Drawing List.

Check for Checks for new Termination drawings created in the Wiring Manager
New module and imports them into the Drawing List. Refer to Import
Terminations Drawings into the Drawing List.

Termination Used to view, add and edit list of non-AVEVA Instrumentation

Ref Drawing Termination Drawing numbers for equipment. Refer to Non-AI
Nos (non- Termination Drawing References.
IDO)

Tools Section

Show Used to view the list of DataLinks for a selected drawing. Refer to
Datalinks DataLinks Report Window.

Rename Used to rename batches of selected drawings. Refer to Rename

Selected Drawings.

Printing Section

Print Print selected drawing(s) - if the drawing file exists.

Export Section

To External Publishes selected drawings to a folder. Refer to Drawing Publishing.

System

Selected
Drawings Used to export selected drawings files in the following ways:

Copy/Archive Used to export drawing files to a folder defined during

to Folder the export process. Refer to Export Drawings to a
Specified Folder.

Copy to User Used to export drawing files to a pre-defined folder or

Defined folders with file names in a pre-defined, user-defined
Names format. Refer to Export Drawings to Pre-Defined
Folders with File Names in a Pre-Defined Format.

5.1 Add a New Drawing

This topic describes how to manually add drawings to the Instrument Designer's Drawing
List.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
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 Contextual Actions tab. Refer to Import Drawings into the
Drawing List.
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 Contextual Actions tab. Refer to Import
Drawings into the Drawing List

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

With the Drawing List open click New on the Home tab to display the Drawing Information
window:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 on the Home tab.

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.
Select the drawing type from the list provided: Loop Diagram, Segment Check Report, Loop
Check Report, Enhanced Termination Report, Layout, Location Plan, Other and Termination
Plan.
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 must 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 must be entered if the drawing will represent an equipment
Termination Diagram. This equipment number is used by Designer to locate all relevant
Wiring/Cable data for the loop (and its associated instruments) from the AVEVA
Instrumentation project wiring database.
A segment name from Wiring Manager must be entered if the drawing is a Segment Check
Report.
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:

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

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

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, assign the Engineering Loop Number by clicking on the
small command button next to the Loop No text box (which is shown when the '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, 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

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

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

Create a Segment Check Report

If the drawing is a Segment Check Report, you may assign the Segment Name by clicking
on the small command button next to the Segment Name text box (which is shown when the
'Drawing Type' field list is set to 'Segment Check Report').
These fields are mandatory:
• A valid Segment Name from the Wiring Manager Segment List must be entered in the
'Segment Name' 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Drawing Revisions
for more information.

Edit Allows editing the currently selected revision by displaying the

Revision Entry window. Refer to Drawing Revisions for more
information.

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 button 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 Viewing and Editing Multiple Document
Revisions.

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

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

5.2 Drawing Information

To edit or view existing Drawing information, with the Drawing List open click Edit on the
Home tab, or double-click on the drawing record in the Drawing List to display the Drawing
Information window.

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.

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. This functionality comes from the Instrument Engineer
application (and is only available if Engineer is installed).

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

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

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 is only available if Wiring
Manager is installed).

To Create a Segment Check Report

• A valid Segment name from the Wiring Manager Segment List must be entered in the
'Segment Name' text box
• A valid Seed drawing must be entered in the 'Seed' text box
If the drawing is a Segment Check Report, select the Segment by clicking on the small
command button in the Segment Name text box (if the drawing represents a Segment
Check Report). This will bring up the Select Segment window. This functionality comes from
the Wiring Manager application (and us 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:

Revisions Tab Command Buttons:

Add Allows a new revision to be added to the current datasheet by

displaying the Revision Entry window. Refer to Drawing Revisions
for more information.

Edit Allows editing the currently selected revision by displaying the

Revision Entry window. Refer to Drawing Revisions for more
information.

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

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

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 button 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 Viewing and Editing Multiple Document
Revisions 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:

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

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

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

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

5.3 Rename Selected Drawings

This facility enables the user to rename drawings in batches.
Select the items to be renamed in the Drawing List grid view and then click Rename on the
Contextual Actions - Drawings 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

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

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

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Delete Drawings

To delete a drawing, select it from the list and click Delete on the Home tab.The Drawing
Delete Options window is then displayed:

• Click Delete from Drawing List only if the drawing is to be deleted from the list, but the
drawing file is not be deleted.
• Click Delete Drawing File Only if the drawing file is to be deleted, but not the record in
the drawing list.
• Click Delete from Drawing List and Drawing File if both the drawing record in the list
and the associated drawing file are to be deleted.
After making the selected from the above options, click Delete to complete the deletion.

5.5 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 Application From

Loop Diagrams Engineer When the 'Drawing Required' option is
selected in the Loop List (or Loop Detail
window)
Termination Diagrams Wiring Manager When the 'Dwg Required' option is selected
in the Equipment List (or Equipment Detail
window)

5.5.1 Loop Diagram Import

To check Engineer's Loop List for loop drawings:

Click the Check for New Loops command on the Contextual Actions - Drawings tab.

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

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

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

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

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

The following table shows where the data from the Loop List goes in the Drawing list:

Drawing List Loop List Column

Column
Drawing No Loop No
Loop No Loop No
Type (the words 'Loop Diagram')
Title 1 As user defined in Drawing Title Setup Preferences
Title 2 As user defined in Drawing Title Setup Preferences
Title 3 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.

5.5.2 Termination Diagram Import

To check Wiring Manager's Equipment List for termination drawings:

Click the Check for New Terminations command on the Contextual Actions - Drawings
tab.
The Drawing Check Options window is then displayed:

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.

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

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

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:

The following table shows where the data from the Equipment List goes in the Drawing list:

Drawing List Equipment List Column

Column
Drawing Number Equipment No
Equipment No Equipment No
Type (the words 'Termination Diagram')
Title 1 As user defined in Drawing Title Setup Preferences
Title 2 As user defined in Drawing Title Setup Preferences
Title 3 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.

5.5.3 Importing from Excel

Drawings can also be imported from an Excel spreadsheet.
For a description of this functionality, refer to the Common Functionality User Guide.

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

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

5.6 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 Project tab, click Setup, then click Loop Titles (Import format). The following
window is then displayed:

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
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 Project tab, click Setup, then click Termination Titles (Import format). The
following window is then displayed:

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

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

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.7 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 Update on the Contextual Actions - Drawings tab.
Each selected drawings in then opened in AutoCAD. Refer to Opening AutoCad Drawings.
The Update Options window is displayed:

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

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

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 Setup menu on the Project tab. Refer to
Export Drawings to Pre-Defined Folders with File Names in a Pre-Defined Format for
details.

5.8 Drawing Revisions

5.8.1 Create a Revision

To create a revision for a drawing, select the drawing in the Drawing List, then click Add
Revision on the Contextual Actions - Drawings tab. The Revision Entry window is then
displayed:

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

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

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

Save 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
Instrumentation to use the next revision number. e.g. if the current revision is "A",
then the next is "B" or if current revision is "2", then the next is "3" etc.

Cancel Exits without saving changes or adding a revision.

5.8.2 Edit a Revision

To edit the current revision of a drawing, select the drawing and click Edit Revision on the
Contextual Actions - Drawings tab. The Revision Entry window is then displayed with the
details of the current revision displayed for editing.

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

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

5.8.3 Viewing and Editing Multiple Document Revisions

To view a list of all revisions of all reports, click Revisions on the Contextual Actions -
Drawings tab. The Revisions window is displayed:

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.

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

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

To edit an existing revision click 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 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.

5.9 Drawing Issues

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

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

Click Cancel to cancel the issue or OK to create a new revision. Refer to Drawing Revisions
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 (refer to Opening AutoCad Drawings), 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 on
the Contextual Actions - Drawings tab.
The Issues dialog is then displayed.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 check box
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 Open the selected issues in AutoCAD. Refer to Opening AutoCad

Drawings.

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

Print Prints the selected issues.

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

Filter Opens the Advanced Grid Filters window used to define the current grid
view filter criteria.

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

Close Closes the window.

5.10 Non-AI Termination Drawing References

To view, add and edit list of non-AVEVA Instrumentation Termination Drawing numbers for
equipment, click External Ref Drawing Nos on the Contextual Actions - Drawings tab.
The Termination Drawing References window is then displayed:

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

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

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

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

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

Select Drawings Publishing Configuration from the Setup menu on the Project tab. 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.
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.

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

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

5.11.2 Publishing Drawings

To publish drawings, select them in the grid and click To External System on the
Contextual Actions - Drawings tab. 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.
Any errors that occur during the publishing process are reported in the Error Summary
window.

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

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

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

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

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

6 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
procedure 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 Assign 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 Drawing List commands that can create a Loop or Hookup CAD drawing:
Open and Update on the Contextual Actions - Drawing tab.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

Command Functionality Remarks

Open Opens drawing file, no data Only applicable to one drawing at a time
is updated
Update 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. Refer to Opening AutoCad Drawings.
• 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. Refer to Opening AutoCad Drawings.
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. Refer to Opening AutoCad Drawings.
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
drawing’s 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Insert 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 Drawing List commands that can create a Termination CAD drawing: Open
and Update on the Contextual Actions - Drawing tab.

Command Functionality Remarks

Open Opens drawing file, no data is Only applicable to one drawing at a time
updated
Update 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. Refer to Opening AutoCad Drawings.
• Update - Recreate the drawing with database information (if any), then view the
updated drawing in CAD.
When update is used, the Seed file is copied to create the Drawing file (whether the drawing
file exists or not).
The drawing file is opened in CAD (refer to Opening AutoCad Drawings) and the 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 tab > Edit Project
menu option to view the template folder name. Refer to Opening AutoCad Drawings.
Alternatively you see all the current template files for your project and open them in
AutoCAD from within Designer. Refer to Opening AutoCad Drawings.
To open the Drawing List, click Select in the Grids and Schedules section of the Home
tab.
Select Templates from the list of grids that is then displayed. The Templates grid is then
displayed:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 tab's Edit Project
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 and click Open from the
Contextual Actions - Templates tab. AutoCAD then starts (if not already running) and the
file is opened. Refer to Opening AutoCad Drawings.

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

Templates Used Report

A report listing the templates used in the project and how often each of them has been used
is accessed by selecting Templates Used from the Fixed Reports list accessed from the
Reports section of the Home tab.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

For descriptions of the toolbar buttons of the report window, refer to Report Manager.

6.2 Assign 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 Opening AutoCad Drawings.
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. Refer to Opening
AutoCad Drawings.

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 Designer AutoCAD Menu

AutoCAD 2000, 2000i, 2002 Designer.mns

AutoCAD 2004 Designer2004.mns

AutoCAD 2005, 2006, 2007, 2008 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:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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.

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:
• Select a drawing from the Drawing List, then click Show Datalinks on the Contextual
Actions - Drawing tab
• Or select the drawing and select Show Datalinks for Selected Drawing from the
Fixed Reports list accessed from the Reports section of the Home tab.
• Or right-click on a drawing in the Drawing List and click Show Datalinks on the menu
that is then displayed.
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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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:

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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 Assign DataLinks in AutoCAD.
The following table shows typical DataLinks shown for each group:

Group Name DataLink Example Value

Project Data:

{ProjectNo} 25400

{ProjectName} FuelX Modernisation

{ProjectDesc} Refinery Clean Fuels

{PlantName} FuelX

Drawing Data:

{DwgNo} 340-07-1045

{Sheet} 1

{NoOfSheets} 1

{Title1} Area 340

Drawing Revisions:

{RevNo1} A

{Date1} 7/7/2003

{Revision1} ISSUED FOR REVIEW

{By1} GRH

Instrument Tag Data:

{TAG1} 34-FT-1005

{TAG1Manufact} Honeywell

{TAG1Model}

Tag Wiring Data:

{TAG1T1} +

{TAG1W1C1CableNo} C34FT1005

{TAG1W1C1CableType} 1Pr

{TAG1W1C1Core} WH

{TAG1W1E1} 34-JB-114

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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
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, click Select in the Grids and Schedules section of the Home tab.
Select Seeds from the list of grids that is then displayed. The Seeds grid is then displayed:

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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:

Parameter Description

Seed File A unique name that matches the Seed File name (the AutoCAD
drawing file name).

Description User defined description (optional).

Size User defined size - used to help a user select the appropriate
seed drawing size (optional).

MaxNoOfTStrips Maximum number of Terminal Strips you want placed on the

drawing (see NOTE 1 below).

MaxNoOfTerminals Maximum number of Terminals to draw in a single vertical set of

terminals before starting at the top again.

DefaultSpacing Horizontal spacing between terminal strips.

TStripStartX X coordinate where the first terminal strip will be started (the top
left of the strip).

TStripStartY Y coordinate where the first terminal strip will be started (the top
left of the strip).

ExtentsMinY Minimum Y coordinate in which AutoCAD can draw within the

title block (affects bottom of vertically drawn cable).

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

To Open a Seed in AutoCAD

Select the Seed file name, click Open on the Contextual Actions - Seeds tab. AutoCAD
then starts (if not already running) and the file is opened. Refer to Opening AutoCad
Drawings.
To add a new Seed file, click New on the Home tab (existing seed records can be copied by
using the 'copy' drop down toolbar command next to the New option).
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 Description

Seed File Name A unique name that matches the Seed File name (the AutoCAD
drawing file name).

Description User defined description (optional).

Size User defined size - used to help a user select the appropriate seed
drawing size (optional).

Max No. of Maximum number of Terminal Strips you want placed on the drawing
TStrips (see NOTE 1 above).

Max No. of Maximum number of Terminals to draw in a single vertical set of

Terminals terminals before start at top again.

TStrip Start X X coordinate where the first terminal strip will be started (the top left
of the strip).

TStrip Start Y Y coordinate where the first terminal strip will be started (the top left
of the strip).

TStrip Spacing Horizontal spacing ('X') between terminal strips.

Extents Min Y Minimum Y coordinate in which AutoCAD can draw within the title
block (affects bottom of vertically drawn cables).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

Draw All Cables Defines whether all cables will be drawn to the bottom of the drawing
Vertically sheet (to the Extents Min Y above).

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 Insert 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 (Project tab >
Edit Project option).
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 the AVEVA Instrumentation Grid Manager, accessed from
the Manage option on the Home tab.
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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

6.6 DataLinks

6.6.1 DataLinks Reference

Designer allows any attribute within any AutoCAD drawing to be updated from the AVEVA
Instrumentation 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} returns the value of the Drawing Number field for the current drawing.

{Title1} returns the value of the Title1 field of the Drawing List for the current
drawing.

{Tag1} 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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, how to 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 options (on the
Contextual Actions tabs) 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
Assign DataLinks in AutoCAD for more information.

Editing DataLinks in AutoCAD

Refer to the Assign 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 re-
entering 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
• 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)
• DataLinks can be used to fill in values to a single attribute and they may be nested
within each other and/or concatenated within 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.
• Blocks may be copied with DataLinks within AutoCAD to reduce setup time (and to
copy entire drawings)
• A list of predefined keywords within the Designer Drawing List for any selected drawing
can be viewed by using the Show Datalinks option on the Contextual Action -
Drawings tab (after selecting a drawing in the Drawing List), which opens the
DataLinks Report Window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Drawing Generation

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

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

7 Hookups

7.1 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.
Hookup drawings can be one of the following types: General, Process, Pneumatic or
Mounting.
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

To open the Drawing List, click Select in the Grids and Schedules section of the Home
tab.
Select Hookup Drawings from the list of grids that is then displayed. The Hookup Drawing
List grid is then displayed:

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Contextual Action Options

The following options are located on the Contextual Actions - Drawings tab.
These facilities are the same as those for the Drawing List, except where noted.

Records Section

Refresh

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

Delete

Actions Tab

Open Opens the selected drawing for reviewing/printing etc in AutoCAD

(editing title block and revision information should be done from the Edit
button on the Home tab). Refer to Opening AutoCad Drawings.

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

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). Refer to Drawing Issues. Sub-
menu options are:

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

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

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

Open Issues Displays the Issues window. Refer to View Previous

For All Issues for further information.

Revisions Displays a list of all drawings with revisions (and their revisions). Refer
to Viewing and Editing Multiple Document Revisions. Sub-menu options
are:

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

Revisions Revision.

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

Revisions Revision.

Check for Checks for new Loop drawings created in the Engineer module and
New Loops imports them into the Drawing List.
Not relevant to the Hookup Drawing List.

Check for Checks for new Termination drawings created in the Wiring Manager
New module and imports them into the Drawing List.
Terminations Not relevant to the Hookup Drawing List.

Termination Used to view, add and edit list of non-AVEVA Instrumentation

Ref Drawing Termination Drawing numbers for equipment. Refer to Non-AI
Nos (non- Termination Drawing References.
IDO)

Tools Tab

Show Used to view the list of DataLinks for a selected drawing. Refer to
Datalinks DataLinks Report Window.

Rename Used to rename batches of selected drawings. Refer to Rename

Selected Drawings.

Printing Tab

Print Print selected drawing(s) - if the drawing file exists.

Export Tab

To External Publishes selected drawings to a folder. Refer to Drawing Publishing.

System

Selected
Drawings Used to export selected drawings files in the following ways:

Copy/Archive Used to export drawing files to a folder defined during

to Folder the export process. Refer to Export Drawings to a
Specified Folder.

Copy to User Used to export drawing files to a pre-defined folder or

Defined folders with file names in a pre-defined, user-defined
Names format. Refer to Export Drawings to Pre-Defined
Folders with File Names in a Pre-Defined Format.

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

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

7.2 Add a New Hookup Drawing

With the Hookup Drawing List open, click New on the Home tab to display the Hookup
Drawing Information window:

This window is identical to the standard Drawing Information window except that it has two
additional sections:

Template This contains information about the Hookup Template to be

used when creating the Hookup Drawing

Tags This list contains a list of all tags assigned to the current
Hookup Drawing

Assign a Hookup Template Type

Click Assign Type.
This displays the Assign 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.

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

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

To Assign a new Tag to the Hookup Drawing

Double-click on any empty Tag Number record in the 'Tags Assigned' list, or click on an
empty record and click Assign.
This displays the Assign 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.

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 click Un-Assign.

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 button. Packing Tags also re-sorts the order based
on the Tag Number.

Revision History List

The Revision History list shows all revisions for the current drawing.
Revisions Tab Command Buttons

Add Revision allows a new revision to be added to the current datasheet by

displaying the Revision Entry window. Refer to Create a Revision.

Edit Revision allows editing the currently selected revision by displaying the
Revision Entry window. Refer to Edit a Revision.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Viewing and Editing Multiple Document
Revisions topic.

7.3 Assign a Hookup Template

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 Assign Tags to a Hookup

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 existing Hookup Drawing information, with the Hookup Drawing List open
click Edit on the Home tab, or double-click on the drawing record in the Hookup Drawing
List to display the Hookup Drawing Information window:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 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 hookup
drawing data.

This window is identical to the normal Designer Drawing Information window except it has
two additional sections:

Hookup Template Type This contains information about the Hookup Template to be
used when creating the Hookup Drawing

Tags Assigned 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 Assign 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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, or click on an
empty record and click Assign.
This displays the Assign 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.

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 click Un-Assign.

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 button. Packing Tags also re-sorts the order based
on the Tag Number.

Revision History List

The Revision History list 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 Create a
Revision.

Edit allows editing the currently selected revision by displaying the

Revision Entry window. Refer to Edit a Revision.

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

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

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 button 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 Viewing and Editing Multiple Document
Revisions topic.

7.6 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.
To open the Hookup template catalogue, click Select in the Grids and Schedules section
of the Home tab.
Select Hookup from the list of grids that is then displayed. The Hookup template catalogue
grid is then displayed:

7.6.1 Add a New Hookup Template

With the Hookup catalogue template grid open, click New on the Home tab to display the
Hookup Template Details window:

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

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

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:
• 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, used to assign items to the
template. Refer to Assign 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. Refer to Opening AutoCad Drawings.
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 Assign Hookup DataLinks in AutoCAD.

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

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

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.6.2 Edit Template Data

With the Hookup Catalogue Template open, click Edit on the Home tab to display the
Hookup Template Details window:

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 to display the Find a Component window, used to assign items to the
template. Refer to Assign 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.

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

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

Assign a Template drawing

Click Open Drawing command button. Refer to Opening AutoCad Drawings.
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 Assign 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.6.3 Import Hookup Catalogue

Import Hookup catalogue allows the user to import other Hookup catalogues from another
AVEVA Instrumentation project.
With the Hookup grid view active, select From Other Project from the Import section of
the Data Management 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 Catalogue Import window.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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.

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.

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

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

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.

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.6.4 Assign 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.

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

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

From the Hookup Template Details window (see Edit Template Data), click New Item.
This displays the Find a Component window below:

Note: Only those Hookup items in the Hookup Items Catalogue that have been marked
with 'Allow' are shown by default 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. Unclick the Show Allow Only checkbox to also list items not
marked with ‘Allow’.

Select an Item or Component to use on your 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.

Filter the Catalogue Items List

You may filter the items catalogue by selecting a size from the Size list. The “All” option
resets the filter so that all items are shown, and by using the standard grid filtering facility.

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.

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

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

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.6.5 Assign 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. Refer to Opening AutoCad Drawings.
The Hookup Template can be opened in AutoCAD (refer to Opening AutoCad Drawings) by
using the 'Open Drawing' command button from the Edit 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 Designer AutoCAD Menu

AutoCAD 2000, 2000i, 2002 Designer.mns

AutoCAD 2004 Designer2004.mns

AutoCAD 2005, 2006, 2007, 2008 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:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

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

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

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.7 Hookup Items Catalogue

The Hookup Items (or Parts) catalogue enables catalogue components to be added/edited
to the project database.
To open the Hookup Items catalogue, click Select in the Grids and Schedules section of
the Home tab.
Select Hookup Items from the list of grids that is then displayed. The Hookup Items
catalogue grid is then displayed:

Hookup Catalogue Fields

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.

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

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

7.7.1 Adding a New Catalogue Item

To add a new Hookup Item to the Items Catalogue for your project:
With the Hookup items grid open, click New on the Home tab to display the Hookup Item
Detail window.

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.

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

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

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.

Importing from Excel

Items can also be imported from Excel.
For a description of this functionality, refer to the Common Functionality User Guide.

Importing from another Project

Items can also be imported from another project. This works the same way as the facility for
importing catalogue drawings from another project. Refer to Import Hookup Catalogue for
details.

7.8 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 Fixed Reports list accessed from the Reports section of the
Home 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 Assign Tags to a Hookup).
The Tags Assigned report lists the tags assigned to Hookup drawings in the project:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.
For descriptions of the toolbar buttons of the Tags Assigned and Tags not yet Assigned
report window, refer to Report Manager.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

8 Engineering Data

AVEVA Instrumentation Designer allows access to the Instrument Engineering data

normally created by the Engineer application.
Refer to the Instrument Engineer User Guide for further details.

8.1 Loop Data

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 Saves assignment changes (if any)

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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 list.
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:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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. 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

General

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

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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.

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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

Alarms/Settings

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

Properties

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

Power Supply

Used to enter details of any power supply requirements for the instrument. If appropriate,
check the Requires Power Supply checkbox and enter the details in the fields provided.
If the instrument data is to be shared with AVEVA Electrical, click Share with Electrical.

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

Associated Items

Used to view the process equipment and lines associated with the instruments, to add
further associations, and to remove associations.
The Properties button is used to open the Edit Process Equipment or Edit Process
Lines window for the process item selected on the tab, in which further details of the item
can be viewed. Refer to the Process Engineer User Guide for further details.

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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 window, 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:
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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

The Terminations window:

Refer to Wiring Manager documentation for details of these facilities.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Engineering Data

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Using Wiring Rules to Create Data

9 Using Wiring Rules to Create Data

9.1 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).

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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:

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Using Wiring Rules to Create Data

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Using Wiring Rules to Create Data

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.

Instrumentation can 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 man-
hours 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.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Using Wiring Rules to Create Data

Columns Explanation

Select Only those instruments selected are processed when the Create
command is used

TagNo The instrument tag number - Non editable (tags can only be assigned
to a loop using Engineer)

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

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

Junction Box 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.

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

Cable No. This shows the default cable number as created by the wiring rule or
the actual cable number from the AVEVA Instrumentation Cable
Schedule (if the cable has been created previously). You may enter a
new value if you require.

Length You can enter a Cable Length here. This length is saved in Wiring
Manager's Cable Schedule.

Cable Type This shows the base cable type. It can be changed by selecting the
cell command button that appears when 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.

Command Buttons

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.

Cancel Quits the window, not saving or creating.

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.

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

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

10 Exports

The export options available on the Data Management and Contextual Actions tabs are
described below.

10.1 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 a description of this functionality, refer to the Common Functionality User Guide.

10.2 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.
For a description of this functionality, refer to the Common Functionality User Guide.

10.3 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
Setup menu on the Project tab, as described below.
The .dwg files of the selected drawing must be present in the Drawing folder of the project.

10.3.1 Export Drawings to a Specified Folder

Select the drawings in the Drawing Grid.
On the Contextual Actions - Drawing tab, click Selected Drawings in the Export section,
then Copy/Archive to a Folder from the menu that is then displayed.
The Export folder window is then displayed:

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

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

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.3.2 Export Drawings to Pre-Defined Folders with File Names in a Pre-

Defined 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 Project tab. On the Setup menu, click
Export File Name/Folders.

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

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

The File Export Settings window is then displayed:

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

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

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

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 Drawing Number Sheet Number Revision

00 ABC123 1 A

01 XYZ890 1 B

This will result in the creation of folder structure and files as follows:
C:\AI 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)

Export Drawings
Select the drawings in the Drawing Grid.
On the Contextual Actions - Drawing tab, click Selected Drawings in the Export section,
then Copy to User Defined Names from the menu that is then displayed.

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.4 Export to AVEVA NET

AVEVA Instrumentation Designer includes facilities to export files of drawing data and report
PDF files for import into AVEVA NET.
The following can be exported:
• Drawings data
• Hookup Drawings data
• Reports and associated item data (i.e. of the items on the reports)

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

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

The files produced by the exported can subsequently be imported into AVEVA NET Portal
(refer to AVEVA NET documentation for details).

10.4.1 AVEVA NET Export Configuration

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

Instrumentation data of various types and from different sources can be exported to AVEVA
NET, for example drawing data or data from reports. From the Name field, select the type of
data export to AVEVA NET to be configured.
If a log file is to be generated for the export type, check the Log Enabled checkbox.
The Log File field will then become enabled. In the field, specify the file name and the
location of the log file (a .txt file). Click the adjacent button to browse for the required folder.
In the Staging Area field, specify the top level folder into which files are to be exported.
Click the adjacent button to browse for the required folder.
If the Create Trigger File checkbox is checked, a 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
trigger the AVEVA NET Portal’s import controller to automatically process all the files that
reside in the same folder.
To select mapping files for the export of data and specify other settings, click Settings.
If Reports exports are being configured, the Non-CAD Mapping Configuration window is
displayed.

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

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

If Drawings or Hookup Drawings exports are being configured, the CAD Mapping
Configuration window is displayed.

Mapping Setup
The mappings between Instrumentation data and AVEVA NET Portal format data are stored
in XML files, one for each of the types of mapping:
• Presentation Mapping (Drawing and Hookup Drawing exports only)
• Object Mapping
• Class Mapping
For details of these files, refer to AVEVA NET Export Configurations Files.
In Non-CAD Mapping Configuration window and on Mapping tab of the CAD Mapping
Configuration window, click the appropriate … button to browse for the required mapping
file.

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

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

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

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 mapping files supplied with AVEVA Instrumentation,
click Copy Sample Files.
On the Mapping tab of the CAD Mapping Configuration window, if unmapped attributes,
i.e. Instrumentation attributes not mapped to AVEVA NET Portal characteristics in the
Attribute mapping files, are to be exported to export files as characteristics, check the Keep
Unmapped Attributes checkbox.

Other Settings (for Drawings and Hookup Drawings Exports)

Additional export settings may be specified for the export of Drawings and Hookup
Drawings on the Settings tab of the CAD Mapping Configuration window.

To select the background colour of the SVG files generated by drawing exports, either:
• select the required colour from the Colour field list, or
• enter the RGB values of the colour in the fields provided, or
• press the Pick Colour button and select the required colour from the standard colour
selection dialog.
In Scale Factor field, enter the stroke-width attribute value of lines in the output SVG files.

10.4.2 Export Reports and Associated Data

To export reports and associated data, in the Reports section of the Home tab, click Report
Manager to open the Report Manager.
Select the report to be exported, then click Publish to AVEVA NET.
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.

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

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

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.4.3 Export Overview

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

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.
For a description of this functionality, refer to the Common Functionality User Guide.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Work Packs

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Change Reports

12 Change Reports

12.1 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.
For a description of this functionality, refer to the Common Functionality User Guide.

12.2 Database Revisions

AVEVA Instrumentation allows users to make a copy of the current database state by saving
the database as a Database Revision. At any time, the current database can be compared
to a saved Database Revision. 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'.
For a description of this functionality, refer to the Common Functionality User Guide.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Change Reports

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 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.
For a description of this functionality, refer to the Common Functionality User Guide.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
Report Manager

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
AVEVA NET Export Configurations Files

A AVEVA NET Export Configurations Files

The following configuration files will be used by the AVEVA Schematic Gateway to process
the input:
• Project Configuration
• Presentation Mapping (Drawing and Hookup Drawing exports only)
• Object Mapping
• Class Mapping
For a description of these files, refer to the Common Functionality User Guide.

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

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Instrument Designer User Guide
AVEVA NET Export Configurations Files

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

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

Index

A List . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Title Setup Preferences . . . . . . . . . 5:21
Assign
Edit DataLinks . . . . . . . . . . . . . . . . . 6:5
Junction Box . . . . . . . . . . . . . . . . . . . 9:6
E
Tags to Loops . . . . . . . . . . . . . . . . . . 8:3 Edit
Wiring Rule . . . . . . . . . . . . . . . . . . . . 8:7 Engineering Loop . . . . . . . . . . . . . . 5:10
Audit Manager . . . . . . . . . . . . . . . . . . . . 12:1 Tag Details . . . . . . . . . . . . . . . . . . . . 8:7
Existing Tags . . . . . . . . . . . . . . . . . . . . . 8:4
B Export . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Reports and Associated Data . . . . 10:7
Blocks Selected Drawing Files . . . . . . . . . 10:1
Copying . . . . . . . . . . . . . . . . . . . . . 6:15 to AVEVA NET . . . . . . . . . . . . . . . . 10:4
to Excel . . . . . . . . . . . . . . . . . . . . . 10:1
C to XPS and PDF Files . . . . . . . . . . 10:1

Check
New Loops . . . . . . . . . . . . . . . . . . . 5:17 H
New Terminations . . . . . . . . . . . . . 5:19 Hookup
Create Accessing . . . . . . . . . . . . . . . . . . . . 7:1
Loop Wiring Check . . . . . . . . . . . . . 8:13 Add New Drawing . . . . . . . . . . . . . . 7:4
Loop Wiring using Wiring Rules . . . . 9:4 Assigning Tags . . . . . . . . . . . . . . . . 7:6
Wiring Re-running . . . . . . . . . . . . . . 9:1 Drawing List . . . . . . . . . . . . . . . . . . . 7:1
Items Catalogue . . . . . . . . . . . . . . . 7:19
D Template . . . . . . . . . . . . . . . . . . . . . 7:6
Template Catalogue . . . . . . . . . . . 7:10
DataLinks
Assign . . . . . . . . . . . . . . . . . . . . . . . . 6:5
AutoCAD . . . . . . . . . . . . . . . . . . . . . 6:5 I
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5 Instrument Signal Type . . . . . . . . . . . . . 9:6
Drawing Issues . . . . . . . . . . . . . . . . . . . . . . . . . . 5:26
Creation . . . . . . . . . . . . . . . . . . . . . . 6:1
Generation . . . . . . . . . . . . . . . . . . . . 6:1
Importing . . . . . . . . . . . . . . . . . . . . 5:17
L
Information . . . . . . . . . . . . . . . . . . . 5:10 Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

© Copyright 2000 to current year. Index page 1 12 Series

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

Data . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Wiring Check Create . . . . . . . . . . . 8:13
Wiring Check Reports . . . . . . . . . . 8:12

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

P
PickList Management . . . . . . . . . . . . . . . 2:4

R
Revision History . . . . . . . . . . . . . . . . . . . 5:8

S
Seed Drawing List . . . . . . . . . . . . . . . . . . 6:9
Selecting
Junction Box . . . . . . . . . . . . . . . . . . . 9:6

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

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

© Copyright 2000 to current year. Index page 2 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.