Download as pdf or txt
Download as pdf or txt
You are on page 1of 390

AVEVA Instrumentation

Instrument Wiring Manager


User Guide
AVEVA Solutions Limited

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

To the fullest extent permissible at law:

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

b) AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the customer, including any loss suffered by the customer resulting from the inaccuracy or invalidity of
any data created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or
arise in contract, tort (including negligence) or otherwise;

c) AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
customer's claim is brought.

In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.

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

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

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

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

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

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

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

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

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

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

Revision Sheet

Date Version Comments / Remarks


March 2012 12.1 Copyright added to all pages.
March 2013 12.1 SP1 Updates incorporated
August 2013 12.1 SP2 Updates incorporated
July 2014 12.1 SP3 Updates incorporated
March 2016 12.1 SP4 Updates incorporated
December 2016 12.1.SP5 Updates incorporated
April 2017 12.1.SP6 Updates incorporated
August 2017 12.1.SP7 Updates incorporated
February 2019 12.2 Updates incorporated
January 2020 12.2 Fix 2 Updates incorporated
February 2021 12.2.SP3 Updates incorporated
Instrumentation Wiring Manager User Guide
Instrument Wiring Manager User Guide

Instrument Wiring Manager User Guide

Contents Page

Instrument Wiring Manager


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Feature Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:5
AVEVA Instrumentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:5
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:5

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


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

© Copyright 2000 to current year. i 12 Series


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

Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
I/O Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5
Equipment Layout Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Integration Options Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Data Management Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:7

Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Equipment View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1
Add Area, Buildings, Equipment Rooms and Vendor Packages. . . . . . . . . . . . 5:6
Add Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:6
Add Buildings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:7
Add Equipment Rooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:8
Add Vendor Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:8
Add Cabinets and Junction Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:9
Add Field Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:11
Edit and Rename Items in the Equipment View . . . . . . . . . . . . . . . . . . . . . . . . 5:16
Equipment Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:17
Compartment Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:23
Terminal Strips, Earth Bars, Din Rails, Devices, I/O, Modules, Compartments and
Group Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:25
Add Terminal Strips and Earth Bars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:25
Add DIN Rails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:27
Add Devices (Relays, Barriers etc.) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:28
Select Device from the Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:30
Adding I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:31
Selecting an I/O Module from the Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:33
Add Compartments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:34
Adding Group Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:34
Modify Terminal Strips and Earth Bars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:35
Copy Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
Copy and Move Equipment with Internal Components . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
Copy Equipment with Cables and Terminations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:36
Equipment List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:38
Select Parent Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:42

© Copyright 2000 to current year. ii 12 Series


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

Change Enhanced Cable Block Diagram Equipment Symbols . . . . . . . . . . . . . . . . . . . . . 5:42


Create or Import Multiple Major Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:43
Import Equipment from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:50
Termination Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:57
Report Revision Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:58
Attachments (External Documents) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:61
View the List of Attachments for an Equipment Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:61
Add a New Attachment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:62
Edit Attached Document Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:62
Delete Attached Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:63
Change Attached Document Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:63
Importing Attached Documents Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:65
Export Attached Documents Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:69
Equipment Catalogues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:70
Major Equipment Catalogue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:70
Field Device Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:72
Fieldbus Device Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:75
Device Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:79
I/O Module Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:83
Importing Catalogue Items from another Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:87

Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Cable Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Create a New Project Cable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:5
Select Catalogue Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:12
Select Cable Ends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:13
Create New Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:15
Copying Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:16
Edit Project Cable Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:17
Bulk Edit Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:20
Bulk Edit Parent and Child Cable Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:22
Bulk Update Cable Installation Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:23
Delete Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:24
Change Cable Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:25
Assign Cable Glands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:26
Assign Cable Gland Adaptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:27
Merge Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:28

© Copyright 2000 to current year. iii 12 Series


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

Import Cables from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:30


AVEVA Cable Design Data Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:35
Cable Design Import Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:35
Import the Design Data for Multiple Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:36
Import the Design Data of Single Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:39
Update Estimated Cable Lengths with Design Lengths . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:42
Bulk Freeze and Unfreeze Cables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:42
Change Enhanced Cable Block Diagram Cable Label Symbols . . . . . . . . . . . 6:43
Find Cable Cores Not Terminated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:44
Cable Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:46
Add Cables to the Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:46
Edit Catalogue Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:53
Change Cable Core Markings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:54
Importing Catalogue Cables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:56
Cable Glands and Cable Gland Adapters Catalogues . . . . . . . . . . . . . . . . . . . 6:62
Cable Gland Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:62
Cable Gland Adapter Catalogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:64
Cable Drums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:66
Cable Drum Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:67
Create Cable Drums Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:67
Importing Cables Drums from Excel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:72
Auto-Cable Drum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:78
Assign Cables to Drums from the Cable Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:80
Bulk Lock and Unlock Drums . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:80

Terminations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Access the Terminations Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Terminations User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Main Graphics Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Cables to Terminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Cores to Terminate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Tab Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Terminals Pop-up Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5
Terminal Descriptions Pop-up Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:8
Wire Pop-up Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:8
Devices and Wires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:9
Create and Edit Terminations using the Terminations Window . . . . . . . . . . . 7:10
Select Terminals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:10

© Copyright 2000 to current year. iv 12 Series


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

Set Terminals as Reserved or Spare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:11


Terminate Wires/Cores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:13
Cable Termination Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:14
Disconnect Wires/Cores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:14
Add a New Project Cable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:14
Assign Tags to I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:15
Create Multiple Wires between Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:15
Create Links and Looping Wires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:19
Auto Cross Patch Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:20
Wire Numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:21
Trace Wire Interconnections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:21
Create Terminations across Equipment Cabinets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:22
Change Terminal Markings and Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:22
Add or Change Terminal Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:24
Link Instrument Tag to Terminals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:25
Cables and Equipment Shared with AVEVA Electrical . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:26
I/O Tag Allocations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:26
Assign Tags to I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:26
Import I/O Allocations from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:28
Import Terminations from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:32
Import Signals from Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:38
Termination Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:44
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:47
Title Blocks on Termination Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:52
Enhanced Termination Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:52
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:54

Wire Numbering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1


Manual Ferrule Numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:2
Automatic Ferrule Numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3
Ferrule Rule Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:4
Assign Ferrule Rules to Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:7
Update Ferrule Numbers using Ferrule Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:8
Viewing Ferrule Markings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:9

Fieldbus Segments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1


New Fieldbus Segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1
Add Fieldbus Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2

© Copyright 2000 to current year. v 12 Series


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

Add Existing Fieldbus Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:2


Add New Fieldbus Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:3
Add Instruments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:7
Create Segment Wiring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:10
Segment Check Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:12

Cable Block Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1


Create a New Cable Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Create or Edit Content of a Basic Cable Block Diagram . . . . . . . . . . . . . . . . . 10:3
Add Existing Equipment and Cables to Basic Cable Block Diagrams . . . . . . . . . . . . . . . . 10:6
Interactive Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:7
Changing a Cable End (Destination) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11
Add Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:11
Create a New Project Cable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:15
Assign Field Devices to Junction Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:16
Field Device Wiring Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:17
Cable Drawing Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:18
Create or Edit Content of an Enhanced Cable Block Diagram . . . . . . . . . . . 10:19
Add Equipment and Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:26
Change Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:31
Create a New Project Cable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:31
Edit Symbols and Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
Edit Appearance of Cable Labels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:34
View and Edit Terminations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:35
View Termination Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:36
Assign Field Devices to Junction Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:38
Field Device Wiring Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:38
Delete Symbols and Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:40
Refresh the Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:41
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:42
Basic Cable Block Diagram Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:42
Enhanced Cable Block Diagram Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:46
Add or Edit Cable Block Diagram Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:51
Create New Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:53
Cable Label Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:59
Copy Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:60
Import Symbols from another Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:61
Edit Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:63
Delete Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:63

© Copyright 2000 to current year. vi 12 Series


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

Using Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1


Assign Field Devices to Junction Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:2
Select Tags to Assign to Junction Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:4
Create Wiring for Field Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:5
Select a Field Device Terminal Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:7
Assign a Junction Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:8
Assign Wiring Rules to Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:8
Wiring Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:9
Add a New Wiring Rule Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:11
Copy Existing Wiring Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:17
Edit Wiring Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:17
Import Wiring Rule Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:18
Field Device Wiring Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:19
Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:22

Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export to Excel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export to XPS and PDF Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Export to AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
AVEVA NET Export Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:2
Export Data from Grids. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:3
Export Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:4

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


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

Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:1
AVEVA NET Export Configuration Files . . . . . . . . . . . . . . . . . . . . . .A:1

© Copyright 2000 to current year. vii 12 Series


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

© Copyright 2000 to current year. viii 12 Series


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

1 Introduction

The Instrument Wiring Manager User Guide is designed to help users learn how to use the
Instrument Wiring Manager module of AVEVA Instrumentation. The User Guide describes
how to create detailed project cable and wiring termination data.
Instrument Wiring Manager manages all tasks typically carried out by an Instrument
Designer relating to detail cable, wiring and termination design. This includes definition of
equipment terminal arrangements (field devices, junction boxes and cabinet devices such
as relays, IS barriers and I/O modules), cable creation and termination, cross-patch wiring
etc., generation of Cable Schedules and cable, cable gland and cable gland adapter Bill of
Materials etc. Wiring Manager can be used to:
• Manage all project cables including the definition of cable type, source and
destinations, manufacturer, catalogue number, length etc. (i.e. a typical project Cable
Schedule).
• Manage equipment definitions including equipment layouts and terminal arrangements/
markings for Junction Boxes, Cabinets, Field Tags, Devices etc.
• Assign instrument tags to I/O modules.
• Manage cable/wire terminations including automated field device to junction box
cabling/terminations.
• Produce Cable Schedules / Bill of Materials, Equipment terminations and other reports.
• Produce Cable Drum Schedule.
• Produce Cable Gland and Cable Gland Adapter Bill of Materials.
• Create detailed Cable and Wire Termination reports.
• Produce interactive Cable Block Diagrams using a drag and drop interface.
• Create I/O assignment/allocation reports.
• Interface with other AVEVA Instrumentation applications to automate production of loop
diagrams, junction box and marshalling cabinet termination diagrams and reports,
including AutoCAD drawings.
• Share equipment and cables with AVEVA Electrical.
For a more detailed list refer to Feature Overview.

1.1 Feature Overview


Instrument Wiring Manager handles all tasks related to detail cable, wiring and termination
design. Instrument Wiring Manager has three integrated modules:

Wiring Manager - Equipment


Enables fast definition and editing of equipment terminal arrangements including terminal
strips, devices and I/O modules (including fieldbus devices), design of 'internal' wiring and
cable terminations.

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


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

Wiring Manager - Cables


Enables fast definition of project cables from a user-definable cable catalogue and
assignment of cable ends to equipment including fieldbus devices. Also used to assign
cable glands, gland adapters and for Bill of Materials reporting and Cable Drumming.

Wiring Manager - Cable Block Diagrams


Provides a graphical representation of cable interconnections. Users can create equipment
and cables within each diagram or drag existing equipment into a diagram. All
interconnected equipment is automatically added and the cables shown. Users can also
create fieldbus segment cabling and visualise fieldbus interconnectivity.
AVEVA Instrumentation uses 'Wiring Rules' to handle automatic generation of field
instrument wiring and cabling. By using the Wiring Rules features, users can save many
hours otherwise required to manually build field devices and their associated terminal
arrangements, cables, terminations etc. Refer to Using Wiring Rules for more information.
The features below enable easy and efficient cable/wiring design:

Advanced Graphic User Interface


• Graphical representation of all equipment terminal strips and terminals.
• Easy to learn, intuitive and accurate representation of plant equipment and cabling.
• Drag and drop wire terminations (from list of wires not yet terminated).
• Plant Equipment View displayed as hierarchy of plant areas, buildings, locations,
equipment types etc., for easy access.
• Search for and locate any equipment tag in Equipment View or Cable Schedule.
• Jump to Cable Terminations from cable schedule and jump to other end of wire when
viewing terminations.
• Build interactive cable block diagrams to view your project or plant cables.
• Jump to and edit Cable Terminations or internal equipment layout from any cable block
diagram.
• Jump to and edit cable details from cable block diagram.

Cable Management
• Create cables by copying existing cables or create manually by selecting from the user
definable cable catalogue.
• Cable Schedule grid supports user definable columns, order and filters.
• Auto create Cable Block Diagrams from the cable schedule.
• Merge two cables to create a new cable (where cables have same source and
destinations).
• Split cables into two, based on cable properties (cable type, core size, screens/shields
etc.).
• Change of catalogue number updates all core markings and re-aligns cores by type
and marking.
• Assign Cable Glands from user definable gland catalogue based on gland/cable
properties (i.e. auto match cable outside diameter/Gland range).
• Assign Cable Gland Adapters from user definable gland adapter catalogue based on
gland/equipment connection properties.
• Produce cable schedule reports, cable Bill of Materials (BOM), Gland BOM and Gland
Adapter BOM reports.
• Auto-assign cables to cable drums optimising drum usage (minimising cable wastage).

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


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

• Share individual cables and catalogue cables with AVEVA Electrical.

Equipment
• Graphical representation of all equipment terminal strips and terminals in Plant/Area
hierarchy.
• Define equipment terminal arrangements including:
• Field Devices, Devices (Relays, IS Isolators, Power Supplies etc.), I/O Modules etc.
(Field Devices can be added to the Instrument List in the Engineer module if
required).
• Junction Boxes, Marshalling Cabinets/Panels and other Equipment such as MCCs,
DBs etc.
• Terminal strips/DIN rails etc. within equipment.
• Copy existing equipment arrangements (and optionally cables and their terminations).
• Merge Terminal Strips in same equipment, move terminals to new strip (i.e. split),
retaining wire terminations.
• Move Terminal Strips to other equipment, retaining wire terminations.
• Supports DIN Rails with combination of terminals and devices (relays, IS Isolators, I/O
modules etc.).
• Supports user-definable equipment catalogue for definition of relays, IS Isolators/
Barriers, power supplies, I/O modules etc.
• Access equipment terminations.
• Create Termination diagram/reports in PDF format.
• Export equipment and equipment catalogue data to AVEVA NET.
• Share individual equipment with AVEVA Electrical.

Cable/Wire Terminations
• Drag and drop wire terminations (on wire by wire basis or terminate an entire cable).
• Supports Junction Box allocation to mass auto-create cables and terminations using
Wiring Rules.
• Auto-connect cables/wires by matching wire numbers.
• Work with a list of cables and cable cores not yet terminated.
• Supports multiple terminations per terminal.
• Supports wire number inheritance (wire numbers are 'passed' along interconnected
cable cores and wires).
• Supports independent wire ferrule numbers and automatic ferrule numbering based on
user-defined rules.
• Supports terminal marking modification (terminal re-numbering) one at a time or in
groups.
• Automatic cross-patch wiring within equipment (e.g. Marshalling Cabinets) and
between equipment in same location (room).
• Supports “Links” between terminals, fused terminals and disconnect terminals.
• Supports “Looping Wires” between terminals (external links between terminals).
• Create graphical termination reports instantly in PDF format without requiring any CAD
application.
• Export cable schedule, cable drum schedule and cable catalogue data to AVEVA NET.

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


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

I/O Allocations
• Drag and drop I/O assignments from a list of Tag Numbers (created in Engineer) not
yet assigned.
• Import I/O assignments from Excel (including creation of I/O modules if not yet created
within a Cabinet/Panel).

Cable Block Diagrams


• Auto create Cable Block Diagrams (CBDs) by dragging equipment from the AVEVA
Instrumentation Equipment Treeview or Equipment List.
• Auto create CBDs by dragging cables from the AVEVA Instrumentation Cable
Schedule.
• CBDs are fully interactive with the database enabling editing of cables, equipment and
terminations from the diagram.
• Export CBDs to AutoCAD (AutoCAD license required).
• Add new equipment and cables to the project database and drag and drop cable ends
to reconnect (updating Cable Schedule).

Reports
• Cable Schedule (user-defined layout) including export to Excel, XPS and PDF.
• Cable Bill of Materials.
• Cable Gland Bill Of Materials.
• Cable Gland Adapter Bill of Materials.
• Cable Drum Schedule.
• Ferrule Numbers (by Equipment/Terminals), including export to Excel.
• Termination Reports (print or saved as PDF).
• I/O Allocations.

Change Management
• Report all cables added, deleted and renamed.
• Report detail changes in each field (e.g. Length now 50, was 100).
• Log changes for future reporting (e.g. Cable No changed: Cable No. 1234, was 4567
etc.).
• Audit Manager enables users to view changes by object type.

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 cable) or no access (i.e. the user cannot view a cable).
AVEVA Instrumentation objects include project entities such as cables, equipment 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 AVEVA Instrumentation Security Manager. Users must then be allocated
to 'Security Groups' such as Engineers and Designers, Read-Only Users etc. Refer to the
AVEVA Instrumentation Security Manager User Guide for more information.

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


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

1.2 System Requirements


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

1.3 AVEVA Instrumentation


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

1.4 Guide Structure

Introduction a brief description of Instrument Wiring Manager.

User Interface describes the user interface of Instrument Wiring Manager.

Options describes how to set various Wiring Manager 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.

Equipment used to view project equipment in the Equipment Treeview.

Cables used to add/edit and view all project cables and allows
definition of cable types.

Terminations the user interface for all cable and wire terminations in the
project.

Wire Numbering describes the methods and procedures used to number


wires.

Fieldbus Segments describes how Fieldbus Segments can be used to create a


diagram that consists of Fieldbus Devices, Instrumentation
and connecting wiring.

Cable Block Diagrams describes the creation and use of cable block diagrams, that
provide interactive access to project equipment and cabling.

Using Wiring Rules describes how to use Wiring Rules to automatically


generate typical field instrument wiring/cabling.

Export to AVEVA NET describes the facilities to export files of item data for import
into AVEVA NET.

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

Change Reports describes facilities that enable users to view database


changes made to project

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


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

Reports describes the in-built Report Manager that enables users to


create and modify reports.

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

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


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

2 User Interface

When Instrument Wiring Manager starts up the AVEVA Instrumentation Wiring Manager
window is displayed showing the Home tab.

The Select an AVEVA Instrumentation Project window is also displayed.


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

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


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

• Claims

2.1 Open an AVEVA Instrumentation Project


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

2.2 Instrument Wiring Manager Tabs


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

2.2.1 Project Tab


The Project tab includes the following Wiring Manager-specific options:

Setup Sub Menu:

Ferrule Rule Displays the Ferrule Rule Definition window which is used for
Definitions creation or modification of Ferrule Rules. The Ferrule Rules
feature enables automatic ferrule numbers (wire number
markings) to be added to wire ends after termination.

Wiring Rule Displays the Wiring Rule Definitions window which is used for
Definitions creation or modification of Wiring Rules. The Wiring Rules
feature is used to automatically create field devices, field
cables and to terminate field cable cores/wires at each end.

AVEVA Cable Design Displays the AVEVA Cable Design Import window. Refer to
Import Configuration AVEVA Cable Design Data Interface.

2.2.2 Home Tab


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

Equipment View Displays equipment in a hierarchy. From the Equipment View,


equipment and their terminal arrangements including terminal
strips, devices, I/O modules and Earth Bars can be defined and
edited. Users can access the 'internal' component layouts of
equipment, cable terminations 'internal' wiring/termination designs.
Refer to Equipment Viewx.

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


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

Equipment List Displays equipment in a Grid View. From the grid, equipment and
their terminal arrangements can be defined and edited. Users can
access equipment 'internal' component layouts, cable terminations
and design of 'internal' wiring/terminations. The Grid View enables
easy filtering by equipment type and editing of additional
equipment properties. Refer to Equipment List.

Equipment Displays a list of equipment. Using this list, users can assign
Ferrule Rules Ferrule Rules for automated wire/ferrule numbering. Refer to
Assign Ferrule Rules to Equipment

Cable Schedule Displays the Wiring Manager Cable Schedule Grid View. From the
grid, users can create project cables from a user definable cable
catalogue and assign cable ends to equipment. Also provides
facilities to assign cable glands, gland adapters and for Bill of
Materials reporting. Refer to Cable Schedule.

Cable Drum Displays the Wiring Manager Cable Drum Schedule (cables can
Schedule also be 'auto-drummed' from the Cable Schedule grid). Refer to
Cable Drums.

Cable Block Provides graphical representations of cable interconnections.


Diagrams Users can create equipment and cables within each diagram or
drag existing equipment and/or cables into a diagram and all
interconnected equipment is automatically added and cables
shown. Users can access equipment 'internal' component layouts,
terminations and cable details from the diagram. Refer to Cable
Block Diagrams.

Fieldbus Displays the Fieldbus Segments grid view, used to create, edit or
Segments delete Fieldbus segments. Refer to Fieldbus Segments.

Reports Display the Reports grid, showing Wiring Manager-specific reports.


Refer to Reports.

Under the Catalogue heading:

Major Equipment Displays the Major Equipment Catalogue grid view.

Field Devices Displays the Field Device Catalogue grid view.

Fieldbus Devices Displays the Fieldbus Device Catalogue grid view.

Devices Displays the Device Catalogue grid view.

I/O Modules Displays the I/O Module Catalogue grid view.

Cables Displays the Cable Catalogue grid view.

Cable Glands Displays the Cable Gland Catalogue grid view.

Cable Gland Displays the Cable Gland Adapter Catalogue grid view.
Adapters

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


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

2.2.3 Manage Tab


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

Publish to AVEVA Used to export files of item data for import into AVEVA NET.
NET Refer to Export to AVEVA NET.

AVEVA Cable Used to import the design length of cables from AVEVA Cable
Design Import Design (from PDMS or Marine projects). Refer to AVEVA Cable
Design Data Interface.

In the Import section:

From Other Project Used to import Catalogue data (cables, field devices, fieldbus
devices, devices and I/O modules) from other projects. Refer to
Importing Catalogue Items from another Project.

Signals Used to import signal numbers for equipment terminal strips,


devices and I/O Modules. Refer to Import Signals from Excel for
details.

Attached Used to import attached documents details from an Excel


Documents spreadsheet. Refer to Attachments (External Documents).

From Excel Used to import terminations data from an Excel spreadsheet.


(Terminations) Refer to Import Terminations from Excel.

From Excel Used to import I/O Modules and Tag/Channel assignments from
(I/O Allocations) an Excel spreadsheet. Refer to Import I/O Allocations from
Excel.

2.2.4 View Tab


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

2.2.5 List Tools Tab


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

2.3 Select a Language


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

2.4 Select a Colour Scheme


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

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


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

2.5 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.6 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.7 Advanced Grid Filters


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

2.8 Grid Manager


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

2.9 Using PickLists


Many grid cells 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.

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

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


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

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


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

3 Options

Wiring Manager project preferences are set from the Options window.
On the Project tab, click Options to display the window.
The window consists of the following tabs. Continue at:
• General Tab
• I/O Properties Tab
• Equipment Layout Tab
• Integration Options Tab
• Data Management Tab

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


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

3.1 General Tab

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


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

The General tab is used to specify the following preferences.

Cable Length Units


Select meters (m) or feet (ft).

Cable Earth Core Code


Enter the code of cable earth cores.

Use Auto Ferrule Numbering Rules


When checked, switches on the facility for automatically updating of Ferrule Numbers to all
wire ends on termination based on Ferrule Number Rules.

Copy Instrument Service to Field Device description


When checked, Wiring Manager will copy an instrument's Service data from the Wiring
Manager Engineer Instrument List to the Equipment List. If the Service is empty Wiring
Manager copies the instrument Description from the Instrument List.

Catalogue Cable Group Core Markings


This effects catalogue cables created or edited after any change to this preference setting.
Wiring Manager will create cores in new catalogue cables using these default core
markings/colours.

Catalogue for ‘Core Group Type’ Core Markings


This effects catalogue cables created or edited after any change to this preference setting.
Wiring Manager will create cores in new catalogue cables using the default core group type
markings entered in the Cores Group Type window, accessed by clicking the Cores button.

Click Add Item to add another marking and enter it the Marking column. To delete a
marking, select it and click Remove Item.

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


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

Wiring Check Report Cable Label Symbol


These buttons control which cable label symbol is used on Wiring and Termination reports. If
the Use default symbol option is selected, the normal symbol used for cable labels on
Wiring Check Reports is used.
If the Use ECBD default symbol option is selected, an Enhanced Cable Block Diagram
(ECBD) cable symbol is used (the one specified as the default symbol for cable labels).
Refer to Add or Edit Cable Block Diagram Symbols for further details.

Auto Cable Number Options


If this option is checked, Wiring Manager will auto-name (auto Cable number) cables based
on their From and To (source/destination) equipment numbers. Wiring Manager will
automatically update the cable number whenever a cable end is added/changed. Auto cable
numbering currently only supports naming based on From and To equipment numbers.
The Cable No delimiter will be placed in between the From and To equipment numbers
(e.g. FROM '/' TO).

Overall Cable Schedule


Unless sharing with AVEVA Electrical is enabled for the project, the Show cables from
both Instrumentation and Electrical checkbox will be disabled. If sharing is enabled, it will
be checked by default.
If the checkbox is not checked, cables from Electrical are not displayed in Instrumentation. If
the checkbox is checked, such cables will be displayed, (for example in the Cable Schedule
list), but cannot be edited or deleted.

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

Sync. User Field Data


Some items (e.g. field devices) are present in both the Engineer and Wiring Manager
modules. To keep the data in their User fields synchronised (i.e. so that changing the User
field data for a field device in one module will automatically change it in the other), check the
Sync. User Field Data between Engineer and Wiring Manager checkbox. The checkbox
is unchecked by default.

DIN Rail Number Uniqueness


If all DIN rails within the same enclosure must have different numbers, check the Enforce
uniqueness within an enclosure checkbox. Otherwise, leave the checkbox unchecked
(the default state).

Ferrule Datalink {SignalNo-NoPolarity} Break Character


When labelling ferrules using the Automatic Ferrule Numbering facility, the {SignalNo-
NoPolarity} may be used. This datalink will include terminal marking signal numbers in
ferrule labels, but not polarities
In order that the datalink can identify which part of terminal markings is the signal number
and which part is the polarity, a break character must be used. Select the required character
from the Polarity Breaker list. When labelling ferrules using the {SignalNo-NoPolarity}
datalink, the system will not include anything after that character as it will assumed it is the
polarity.

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


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

To add another character to this list, enter it in the Polarity Breaker Symbol field and click
the Add button.

Ferrule Data for Cable Screens and/or Earth Cores


If ferrule data is to be generated for cable screens and/or earth cores, check the Generate
Ferrule data for Cable Screens and/or the Generate Ferrule data for Cable Earth Cores
checkboxes as required. Both are unchecked by default.

Note: Changes to these settings only apply to cable screens and earth cores created after
a setting is changed, i.e. ferrule data will not be added or deleted for existing cable
screens and/or earth cores. Existing cable screens and earth cores must be
disconnected and then reconnected for the changes to be applied to them.

Terminations
Ensure that the Allow cable core terminations across equipment cabinets checkbox is
checked (it is by default) if cable core terminations are to be permitted across equipment
cabinets (see Create Terminations across Equipment Cabinets for details). Otherwise,
uncheck the checkbox.

3.2 I/O Properties Tab

This tab is used to set the captions used by Wiring Manager for each of the 12 I/O Module
user fields. There are 8 text fields and 4 integer (numeric) fields that can be used to store
data such as system, rack, slot, system cable number etc.

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


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

3.3 Equipment Layout Tab

This tab is used to set the colours Wiring Manager uses to show different types of internal
equipment components in the Equipment Layout window.

3.4 Integration Options Tab

When data is imported using the Compare and Update Data facility (refer to the AVEVA
Instrumentation Common Functionality guide for details), 1000 records of results are
displayed per page by default. To change the default number of records displayed, edit the
value in the No of records per page field.

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


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

3.5 Data Management Tab

By default, when a grid is loaded, if the grid’s list contains more than 1000 records, only the
first 1000 of those records are loaded and displayed in the grid. As the user scrolls down the
grid, once the initial 1000 records have been scrolled past, the next 1000 batch of records is
displayed and so on until all the list records are displayed.
To change the default number of records initially loaded, enter the new value in the Grid
Lazy Loading - Records to load field. The range of values that may be entered is 100 to
100000. If a value outside that range is entered, the setting will default to nearest value
within the valid range (i.e. 100 or 10000).

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


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager 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 Wiring Manager User Guide
Areas

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5 Equipment

In Wiring Manager, the Equipment View provides a a hierarchical view of all instrumentation
equipment and field devices grouped by Plant Area and Location type.
From the Equipment View, equipment and field devices etc. can be created, as well as new
Plant Areas, buildings, equipment rooms etc. Refer to Add Area, Buildings, Equipment
Rooms and Vendor Packages, Add Cabinets and Junction Boxes and Add Field Devices for
details. See also Edit and Rename Items in the Equipment View and Copy Equipment.
Equipment can also be viewed in a grid format in the Equipment List.
Wiring Manager includes a facility for designing and viewing internal equipment component
layouts in a graphical user interface. Refer to Equipment Layout for details.
Terminal Strips, Din Rails and Devices can be added and edit both from the Equipment
Layout interface and the Equipment View. Refer to Terminal Strips, Earth Bars, Din Rails,
Devices, I/O, Modules, Compartments and Group Labels for details.
Facilities are provided to add major equipment to the project in bulk using a wizard. Refer to
Create or Import Multiple Major Equipment.
Equipment may also be added by importing from an Excel spreadsheet. See Import
Equipment from Excel for details.
In Wiring Manager, reports on equipment termination reports can be produced. Refer to
Termination Reports for details.
Wiring Manager includes facilities to attach external documents/files to equipment tags and
for the viewing of these attached documents. Refer to Attachments (External Documents)
for details.
Wiring Manager includes Equipment Catalogues which used to define standard equipment
items and their terminal arrangements. These catalogue items can be used in the creation
of project equipment. See Equipment Catalogues for further information.

5.1 Equipment View


The Equipment View window displays a hierarchical view of all instrumentation equipment
and field devices grouped by Plant Area and Location type.
To access the Equipment View window, click Select in the Grids and Schedules section
of the Home tab. Select Equipment View from the list of grids that is then displayed. The
Equipment View window is then displayed.
The figure below shows a typical Equipment 'treeview' with a pop-up menu, activated by a
right-click on a treeview node. The pop-up menu provides context sensitive commands to
add/edit equipment for a project:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Equipment Tree Overview


To navigate through the project treeview, 'click' on an equipment node's '+' icon to expand it.
The treeview not only shows the project equipment, but also the DIN Rails, circuit breakers,
terminal strips, compartments, compartment elements etc. of the equipment.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: In the case of Compartments created in AVEVA Electrical and shared with the
Instrumentation project, Compartments elements (which are created in the Electrical
version of Wiring Manager) are not displayed in AVEVA Instrumentation.

To add an equipment node, right-click on the appropriate node to display a pop-up menu
with relevant options for that equipment node type. The options vary depending on the
selected equipment type. For example, the pop-up menu in figure above gives add options
for the Junction Box node selected. For this Junction Box users can add: a field device, a
device (relay, IS Barrier etc.), an I/O module, a Terminal Strip, a DIN Rail (DIN Rails can
contain terminals and devices/IO modules mixed together in any sequence and quantity) or
an Earth Bar.
For most equipment nodes, options to edit and delete the selected item are available, plus a
facility to find any equipment number. When an Equipment node (i.e. a Motor, Control
Station, Field Device etc.) has been selected, an option to print (or print preview) the
terminations for the selected equipment is also provided.
Double-clicking on any node that contains terminals, terminal strips, DIN rails, earth bars,
devices, compartments or compartment elements will bring up the Wiring Manager's
Terminations. This window allows terminations to be defined through a 'drag and drop' style
graphical user interface.

Pop-up Menu Commands


As explained above, the right-click (on a node) pop-up menu is context sensitive. The menu
will display a selection of the following commands:

Edit Detail Displays a window for editing the data of the item
represented by the selected node. Refer to Edit and
Rename Items in the Equipment View for further
information.

Edit Terminations Displays the Terminations window. Refer to Terminations


User Interface for further information.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Various Add.... Clicking on an Add... command will display a window for


commands: adding equipment to the Wiring Manager database. The
item to be added is created at the equipment node (or Area
node if an Area node is selected etc.) selected when the
pop-up menu was opened (the node that was right-clicked
on). Refer to Add Area, Buildings, Equipment Rooms and
Vendor Packages, Add Cabinets and Junction Boxes, Add
Field Devices and Terminal Strips, Earth Bars, Din Rails,
Devices, I/O, Modules, Compartments and Group Labels.

Cut Used to move the currently selected equipment node.


Select the node to move, then Cut, then select a new parent
node and select Paste from the menu. This command also
moves any DIN Rails, terminal strips and devices etc. (if the
selected equipment has such internal components).

Paste Used to complete a copy or move/cut.

Note: Wiring Manager will only allow copying/moving to a valid parent node based on
equipment type. For example a Cabinet cannot be pasted (copied or moved) to a
Terminal Strip or a DIN Rail copied to an Plant Area or a Cabinet/Panel to a
Cabinet/Panel etc.

Copy Used to copy the currently selected equipment node. Select


the node to copy, right-click then select Copy, then select
the new parent node (e.g. a Plant Area, Building or Room)
then right-click and select Paste from the menu. This
command also copies any internal components (DIN Rails,
terminal strips and devices etc. - if the selected equipment
node has any). Any 'Links' and/or 'Looping Wires' are also
copied.

Copy (with 'From' This menu option only appears if the node selected has
cables) 'From' cables (i.e. cables in the cable schedule leading from
this equipment). Select the node to copy, right-click then
select Copy (with 'From' cables), then select the new
parent node (e.g. a Plant Area, Building or Room) then
right-click and select the Paste command.
This command is the same as above Copy command but
also copies any cables and terminates the new cables
exactly as the cables are terminated in the original 'source'
equipment selected. The Copy Equipment with Cables
window is displayed, used to assign new Cable Numbers to
the copied cables. See Copy Equipment.

Note: This is command is ideal for copying Junction Boxes with their main multi-pair (or
'home-run') cables.

Delete Used to delete the item (node).

Refresh Refreshes the view and closes all the sub-menus

Find Displays a window used to enter a Tag Number and search


for it within the Equipment View.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Collapse All Closes all the tree “branches”.


Also available on the Tools - Equipment Tree tab.

Expand Selected Opens all the sub-”branches” for the selected item.
Also available on the Tools - Equipment Tree tab.

Print Preview Displays Termination Reports for the currently selected


Terminations equipment node as a Print Preview (if the node represents
Equipment).

Ferrule No Report Displays a window that shows all wire ferrule numbers for
each terminal strip/device in the selected equipment
allowing for easy definition of ferrule/wire numbers.

Auto Ferrule Selected Used to automatically add ferrule numbers to the wire ends
Equipment connected to the equipment in accordance with pre-defined
numbering rules. Accesses a sub-menu from where the left,
right or both sides of the equipment can be selected for
numbering. Refer to Update Ferrule Numbers using Ferrule
Rules for further information.

Create Wiring Used to create the wiring for a field device. Refer to Create
Wiring for Field Devices for further information.

Wiring Check Report Opens a report that displays the wiring for field devices that
have had wiring created for them. Refer to Field Device
Wiring Reports for further information.

Junction Box Used to allocate field devices (from the Engineer’s


Allocation Instrument List) to a selected Junction Box. Refer to Assign
Field Devices to Junction Boxes for further information.

Attached Documents Displays the Attached Documents window. Refer to


Attachments (External Documents) for further information.

Enhanced Termination Displays the Enhanced Termination Report window. Refer


Report to Enhanced Termination Reports for further information

Note: Wiring Manager is configured to allow only certain types of Equipment objects to be
'external' or 'internal' to other equipment types. For example a Cabinet cannot be
created or pasted (copied or moved) to a Terminal Strip or a DIN Rail created or
copied or moved to a Plant Area etc.

Note: Equipment can also be accessed from Wiring Manager's Equipment List grid. The
Equipment List support the Grid Manager, filtering etc.

Equipment View - Tools Options

The following options are located on the Tools - Equipment Tree tab:

Records Section

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

Collapse All Closes all the tree “branches”.

Expand Opens all the sub-”branches” for the selected item.


Selected

Tools Section

Add Multiple Used to create multiple items of major equipment in bulk. Refer to
Equipment Create or Import Multiple Major Equipment for details.

Attached Documents Section

Open for Opens a list of all documents attached to the current equipment. Refer
Selected to Attachments (External Documents) for details.

Attach Used to attach a document to the current equipment. Refer to


Document Attachments (External Documents) for details.

Change Used to change the folder in which the attached documents of


Folder selected instruments are located. Refer to Attachments (External
Documents) for details.

Equipment Shared with AVEVA Electrical


Equipment created in AVEVA Instrumentation can be shared with AVEVA Electrical and vice
versa. Refer to Add Cabinets and Junction Boxes and Add Field Devices for details.
In the Equipment Tree, equipment created in Electrical and not shared with Instrumentation
is not displayed, nor is any “child” equipment of that equipment.

5.2 Add Area, Buildings, Equipment Rooms and Vendor


Packages
From the Equipment View, the areas, buildings and equipment rooms that equipment is to
be located in can be created.
Continue at:
• Add Areas
• Add Buildings
• Add Equipment Rooms
• Add Vendor Packages

5.2.1 Add Areas


To create an area, right-click on an existing area node in the Equipment View and select the
Add Area option from the menu.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Area Information window is then displayed:

The button next to the Area Type field displays a window used for creating new area types.
Refer to Areas for details of how to create areas and area types.
Once the area details have been added, click Save to add the new area to the Equipment
View.

5.2.2 Add Buildings


To create a building, right-click on an area node or an existing building node in the
Equipment View and select the Add Building option from the menu.
The Building Information window is then displayed:

Enter the details of the building and click Save to add it to the Equipment View.
The button next to the Status field displays a window in which the Status pick list can be
edited.
If the building is to be shared with AVEVA Electrical, click Share the Building with
Electrical.

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Buildings shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

5.2.3 Add Equipment Rooms


To create an equipment room, right-click on an area node in the Equipment View and select
the Add Equipment Room option from the menu.
The Equipment Room Information window is then displayed:

Enter the details of the room and click Save to add it to the Equipment View.
The button next to the Status field displays a window in which the Status pick list can be
edited.
If the room is to be shared with AVEVA Electrical, click Share the Room 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.

Note: Rooms shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

5.2.4 Add Vendor Packages


To create a vendor package, right-click on an area node or an existing building node in the
Equipment View and select the Add Vendor Package option from the menu.
The Vendor Package Information window is then displayed:

Enter the details of the package and click Save to add it to the Equipment View.
The button next to the Status field displays a window in which the Status pick list can be
edited.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

If the package is to be shared with VEVA Electrical, click Share the Room 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.

Note: Packages shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

5.3 Add Cabinets and Junction Boxes


Select the Add (Equipment Type) command from the from the Equipment View right-click
pop-up menu.
A window for entering the details of the equipment type is then displayed. For example:

Enter the Tag Number/Name.


Entries in all other fields are optional.
The Area No display the area that the equipment type is in, and cannot be changed. The
Area Path: displays the parent area(s) of that area, if there are any.
Many of the fields in these windows may be completed by copying data from the Major
Equipment Catalogue. This facility is accessed using the From Catalogue button, as
described below.
The button next to the Status field displays a window in which the Status pick list can be
edited.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Termination Drawing checkbox enables the equipment to be registered with the
AVEVA Instrumentation Designer's Drawing List, so that a CAD termination drawing can be
created for the equipment's terminations.
The Signal Class Applies and Signal Service Applies checkboxes are for reference
purposes only. There is no limit to the cables or field devices that can be assigned or
terminated to/at the equipment. They can be used, for example, to help the designer or
engineer flag analog signals to be used in the equipment.
If the equipment is to be shared with AVEVA Electrical, click Share the Equipment 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.

Note: Equipment shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

Click Save to save the new equipment tag.

Note: When saving, Wiring Manager will check the Tag No. is unique for the project.

Note: Although Equipment can contain Terminal Strips (users cannot add terminals directly
to Equipment, they must add a Terminal Strip which will contain Terminals) and/or
equipment rails (DIN rails) - which in turn may contain a mixture of terminal strips
and/or devices (barriers/relays etc.) and/or I/O modules. Refer to Add Terminal
Strips and Earth Bars.

Copying Equipment from the Major Equipment Catalogue


Users may copy a standard equipment configuration from those defined in the Major
Equipment Catalogue.
Clicking From Catalogue displays this window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To select a catalogue equipment, double-click on the equipment record or select the


equipment record and click Select.
New equipment created from catalogue equipment will contain the terminal strips and
terminals (including terminal markings) of the selected catalogue equipment. (after the Save
button is clicked in the original Equipment detail window).

Note: Equipment details derived from catalogue items can subsequently be edited as
required. This will not affect the source catalogue item.

5.4 Add Field Devices


AVEVA Instrumentation uses 'Wiring Rules' to auto-generate typical field instrument wiring/
cabling. By using the Wiring Rules features, users can save many hours otherwise required
to manually build devices and their associated terminal arrangements, cables, terminations
etc. in Wiring Manager. Refer to Using Wiring Rules for more information.
Using Wiring Rules to create field devices is limited to instruments that appear in AVEVA
Instrumentation Engineer Instrument List (instrument index). If a field device is required that
is not in the Instrument List (or it is preferred that field devices are to be created without
using Wiring Rules) then proceed as follows.

Note: Field devices are present in both the Wiring Manager and the Engineer modules.
The data for such items is kept in sync between modules. Be aware that field
captions in one module may be different from those in the other, depending on how
data grids have been configured, etc. In other words, the same field displaying the
same data may have a different name in each module.

Right-click on the appropriate field device node and select Add Field Device from the
Equipment View right-click menu.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Field Device Information window is then displayed:

Specify Field Device Tag Number


To specify the tag number of the new field device, click the button next to the Tag No
caption. The Instrument Tag window is then displayed:

This window is used to specify the tag of the new field device.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

When the required tag data has been entered, click OK to display the Field Device
Information window again, with the selected tag number now displayed:

The tag number can be changed by clicking the button next again to the Tag No caption to
re-display the Instrument Tag window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Specify other Field Device Details


The button next to the Status field displays a window in which the Status pick list can be
edited.
The Area No display the area that the equipment type is in. When the window is first
displayed in shows the current area number. Once the tag number of the device has been
specified, it displays the area selected for the tag number and cannot be changed. The Area
Path: displays the parent area(s) of that area, if there are any.
To specify the wiring configuration for the field device, click the button in the Wiring Config
field and select the appropriate wiring from the Wiring Rule Definitions window.
The terminal configuration of a field device can be specified by copying data from the Field
Device Catalogue. This facility is accessed using the From Catalogue button, as described
below.
If the new field device is to be automatically added to the list of instruments in Engineer,
ensure that the Add as Instrument in Engineer Module checkbox is checked.
If the equipment is to be shared with AVEVA Electrical, click Share the Equipment 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.

Note: Equipment shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

Click Save to save the new Field Device tag.

Note: When saving Wiring Manager will check the Tag No. is unique for the project.

Note: The field device type can be changed at any time by re-selecting the field device
from the catalogue. However, if the Field Device is recreated from Wiring Rules then
the Wiring Rule overwrites any changes made in this window.

Copying Terminal Configurations from the Field Device Catalogue


Users may copy the terminal configuration of a field device from those defined in the Field
Device Catalogue.
Clicking From Catalogue displays this window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

This window shows all Field Devices defined in the Field Device Catalogue. Users may add
to this list by defining new Field Devices in the Field Device Catalogue.
Select a configuration either by double-clicking on Field Device image on the Graphic tab or
the record on the List tab, or click on the required configuration on either tab and then click
Select.

5.5 Edit and Rename Items in the Equipment View


To edit any item in the Equipment View, right-click on it and select the Edit Detail option
from the menu.
A window is then displayed in which the item can be renamed, and its details changed. The
window displayed depends on the type of item selected.
If an area, building, equipment room, vendor package or field device is selected for editing,
the appropriate information window is displayed. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: The Last Edit field displays the date and time when the item 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 equipment data.

If a junction box, cabinet/panel, MCC, motor, local panel or compartment is selected for
editing, the Equipment Layout window is displayed, in which the item details can
amended. For details of the Equipment Layout window, refer to Equipment Layout.

Note: Renaming equipment automatically renames any references to that equipment (e.g.
all cables in the cable schedule with a destination to the equipment, termination
report and drawings etc. references will by changed).

Note: If a field device in the Equipment View represents an instrument from the Instrument
List (in Engineer) its Tag Number cannot be changed in Wiring Manager, only in
Engineer. Other details can be edited using the Equipment Information window.

5.6 Equipment Layout


Wiring Manager includes a facility for designing and viewing internal equipment component
layouts in a graphical user interface. This interface shows all the internal components such
as Terminal Strips, Devices, I/O Modules, Earth Bars and Compartments for the current
Equipment item (e.g. Marshalling Cabinet, Junction Box, Local Panel, I/O Panel etc.).
Access the Equipment Layout window from the:
• Equipment View, by right-clicking on any Equipment node then selecting Edit Detail
option.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

• Equipment List, by clicking on the in-cell button displayed when the mouse is hovered
over Equipment No field, then selecting Edit Detail option from the displayed Options
window.
• Cable Schedule, by clicking the button in the From and To cells, and selecting Edit
Detail from the displayed Options window.
• Cable Block Diagrams, by right-clicking on any equipment, then selecting the Edit
Detail option.
• Major Equipment Catalogue, by selecting an item from the Major Equipment Catalogue
grid view, then clicking Edit and selecting Edit Detail from the displayed Options
window.

Edit the equipment details as required.

Note: Any changes made in this window are not saved until the Save command button is
selected.

Note: Equipment layouts and details may be derived from a catalogue item specified during
item creation. They can subsequently be edited as required. This will not affect the
layout or details of the catalogue item.

Note: The Last Edit field that appears on this and other windows displays the date and
time when the equipment 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 equipment data.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Termination DWG Required checkbox allows the equipment to be added to the Wiring
Manager Designer's Drawing List so that a CAD termination drawing can be created for the
equipment's terminations.
The Signal Class Applies and Signal Service Applies checkboxes fields are for reference
purposes only. There is no limit to what cables or field devices that can be assigned or
terminated to this equipment. They can be used, for example, to help the Designer or
Engineer assign analog signals to this equipment.

Add or Edit Additional Information


To add or amend further details of the equipment, click More Information. The More
Information window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Enter or change the details in the fields as required.


The maximum number of cables, terminals and terminal strips cannot be reduced below the
number that already assigned to the equipment. If this is attempted, a message is displayed
to inform the user of this. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Add or Edit Existing Components


Right-click on a Terminal Strip, Device, I/O Module or Earth Bar (or any place holder line) to
display a context-menu, for example:

Note: Terminal Strips, Devices, etc. cannot be added to an MCC or Switchboard. They
must be added to their Compartments. See Compartment Layouts for more
information.

Click Edit Detail to edit information on the existing component right-clicked on.
Click Edit Terminations to edit wire terminations. The Terminations window is then
displayed. See Terminations User Interface for details.
Click Copy to copy the selected component.
Click Add to add a new component.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The window that is displayed when the Add (or Edit Detail) option is selected will depend of
the equipment component type:

Terminal Strip refer to Add Terminal Strips and Earth Bars

Device (IS Isolator/Barrier, refer to Add Devices (Relays, Barriers etc.)


Relay, Power Supply etc.)

I/O Module (DCS, PLC etc.) refer to Adding I/O Modules

Earth Bar refer to Add Terminal Strips and Earth Bars

If blank space is right-clicked on, a different menu is displayed:

This includes the Add options as described above, plus the following additional option:

Add Group/Label used to add a group name to the terminal strip, device etc.
that is next to the blank space that was clicked on to open
the menu. Refer to Adding Group Labels.

To delete an item, select the Delete Component option.

Equipment Arrangement
To rearrange the internal equipment, drag and drop components from DIN Rail to DIN Rail
or up and down a DIN Rail.

Note: Wiring Manager always inserts new or dropped components before the component
dropped on or right-clicked on.

Note: A DIN Rail is automatically added whenever a new component is added to a new
'column' or an existing component is dragged to a new 'column' within this layout.

Other Facilities
Click Edit Terminations (from the right-click menu or the button bar) to edit wire
terminations. The Terminations window is then displayed. See Terminations User Interface
for details.
Click Print Preview Terminations to view the Termination report for the item. Refer to
Termination Reports for details.
Click Ferrule No Report to view the ferrule markings/numbers of the item. Refer to Viewing
Ferrule Markings for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Click Auto Ferrule Selected Equipment to apply a Ferrule Rule to the item. Refer to
Update Ferrule Numbers using Ferrule Rules for details.

Share with AVEVA Electrical


If the equipment is to be shared with AVEVA Electrical, click Share the Equipment 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.

Equipment shared with AVEVA Electrical can be viewed in AVEVA Electrical but not edited.

5.6.1 Compartment Layouts


If the Equipment Layout window for an MCC or Switchboard is accessed (see Equipment
Layout), its Compartments are displayed in the window. For example:
The details of the equipment can be edited as described in Equipment Layout.

To add a Compartment to the equipment, right-click anywhere in the of the area window
displaying the equipment layout, and select Add Compartment from the menu that is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Compartment Information window is then displayed:

Enter the details of the compartment and click Save.


To view details of a Compartment, right-click on it and select the Edit Compartment Detail
option from the menu that is then displayed. The Compartment Information window is then
displayed. Edit the attributes of the compartment as required.
Terminal Strips, Devices, I/O Modules, Earth Bars and Groups/Labels cannot be added to
an MCCs or Switchboards. They must be added to the Compartments themselves.
To access the Equipment Layout window for a Compartment, either:
• Right-click on that Compartment in the Equipment Layout window of the equipment
that contains in and select Edit Detail option from the menu that is then displayed.
• Or, in the Equipment View, right-click on the Compartment node and then select the
Edit Detail option.
The Equipment Layout window for the Compartment is then displayed.
Terminal Strips, Devices, I/O Modules, Earth Bars and Groups/Labels can added and edited
in the same way as described in Equipment Layout, using right-click menus.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: If a Compartment is a shared item that was created in AVEVA Electrical its
Compartment elements will be displayed in the Equipment Layout window. In
common with other shared items, these cannot be edited in Instrumentation.

5.7 Terminal Strips, Earth Bars, Din Rails, Devices, I/O,


Modules, Compartments and Group Labels
Terminal Strips, Earth Bars, Din Rails, Devices I/O Modules, Compartments and Group
Labels can be created from the Equipment View and the Equipment Layout window.
Continue at:
• Add Terminal Strips and Earth Bars
• Add DIN Rails
• Add Devices (Relays, Barriers etc.)
• Select Device from the Catalogue
• Adding I/O Modules
• Selecting an I/O Module from the Catalogue
• Add Compartments
• Adding Group Labels
• Modify Terminal Strips and Earth Bars

5.7.1 Add Terminal Strips and Earth Bars


Note: The maximum number of terminal strips an equipment item (or equipment catalogue
item) can have may (optionally) be specified on the More Information window
accessed from the Equipment Layout window. If the user attempts to add a terminal
strip when the maximum number of strips has already been added to an equipment
item, a message is displayed to inform the user of this. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To add a Terminal Strip or an Earth Bar, from the Equipment Layout window, right-click on
any DIN Rail or existing component and click either Add Terminal Strip or Add Earth Bar
as appropriate on the pop-up menu.
Or, from the Equipment View context-sensitive right-click menu (after right-clicking on an
appropriate equipment node) click Add Terminal Strip or Add Earth Bar. The appropriate
information window is then displayed.

Terminal Strip No/ Enter any unique value for the current equipment as the Terminal
Earth Bar Name Strip number or Earth Bar name.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

No. of Terminals Defines the number of terminals in the strip/bar.

Note: The maximum number of terminals that an equipment item


(or equipment catalogue item) can have on a strip may
(optionally) be specified on the More Information window
accessed from the Equipment Layout window. If the user
attempts to add terminals in excess of this, a message is
displayed to inform the user of this.

First Terminal No Defines the starting terminal marking. Wiring Manager will create
incremented terminal markings for all subsequent terminals.

Note: Wiring Manager does not support auto-numbering of any terminals except for
simple incremental numerical (count). However, once the terminal strip/earth bar
has been created, users can edit individual terminal markings in the Terminations
User Interface.

Field Wires Is only valid when using Wiring Rules to terminate field cables on
Terminate on equipment terminal strips/earth bars. When checked, field cables
Right are terminated on the right side of this terminal strip/earth bar.
When unchecked field cables are terminated on the left of the
terminal strip/earth bar.

Create the New Terminal Strip or Earth Bar


Enter a Terminal Strip No or Earth Bar name (a label), a sequence number, enter the
number of terminals required, the first terminal number and click Save. Wiring Manager will
create all the terminals marked sequentially from the 'First Terminal No.' entered (e.g. 1, 2, 3
etc.) and add the new Terminal Strip or Earth Bar under the parent equipment tag in the
Equipment View.
Terminal markings can be edited from within the Wiring Manager Terminations User
Interface.
To change existing terminal strips and earth bars refer to Modify Terminal Strips and Earth
Bars.

5.7.2 Add DIN Rails


A DIN Rail enables any mixture of Terminal Strips, Devices, including I/O modules, on a
single mounting rail.
In the Equipment Layout window, a DIN Rail is automatically added whenever a new
component is added to a new 'column' or an existing component is dragged to a new
'column'.
DIN Rails can also be added by clicking Add DIN Rail (or Group) on the Equipment View
context-sensitive right-click menu (after right-clicking on an appropriate equipment node).
The Din Rail (Group) Information window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To create the new DIN rail enter a Din Rail name (a label) and a sequence number and click
Save.
Wiring Manager will place the new Din Rail under the parent equipment tag in the
Equipment View.

Note: Sequence numbers define the order of multiple terminal strips/DIN Rails within the
equipment. This effects the Equipment Treeview as well as equipment termination
reports and equipment termination drawings created by Designer. The lowest
sequenced terminal strip/DIN Rails will appear first, highest last etc. within each
Equipment item.

When editing a DIN Rail, users can change the Device sequence list on the right, which
shows all components currently assigned to the DIN Rail. To change the sequence of
components on the rail, drag and drop the items in the Device sequence list to create the
sequence required.

5.7.3 Add Devices (Relays, Barriers etc.)


A Device (component) is defined in the Wiring Manager Device Catalogue. This can be a
Relay, IS Barrier, I/O Modules, Power Supplies or any other 'black box' with terminals.
Although devices can be added to almost any equipment item, it is more usual to group
devices together on rails. In Wiring Manager DIN Rails offer a convenient method of
grouping devices and/or terminal strips together in a user defined sequence.
To add a Device, in the Equipment Layout window, right-click on any DIN Rail or existing
component and click Add Device from the pop-up menu.
Or, in the Equipment View context-sensitive right-click menu: (after right-clicking on an
appropriate equipment node), click Add Device menu option.
Devices may also be added from the Cable Block Diagrams window by right-clicking on any
Equipment and selecting the Edit Detail option to display the Equipment Layout window.
The Device Information window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To create a new device:


• Enter a Device Tag or Description and,
• Select a device from the Wiring Manager Device Catalogue - click Select from
Catalogue which allows selection from the Device catalogue. Refer to Select Device
from the Catalogue.
• Optionally enter a Status (new, existing etc.) from the Status list.
• Enter a Sequence number (defines the sequence the device will appear on the DIN
Rail).
Note: The sequence is not viewable in this window if creating or editing a Device from the
Wiring Manager Equipment Layout window. When adding a new Device in the
Layout window the sequence is defined by the position which the component is
added. To change the sequence in the Layout window, drag and drop the
component to a new position (sequence).

• Select the Rotated option to rotate the Device 180 degrees (i.e. place it upside down
on the rail with respect to its catalogue definition.
Once a device is selected, the Catalogue Information fields display the Model No,
Manufacturer and Description, and the graphic is updated to show the terminal
arrangement of the selected device. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Device information is fixed for each specific catalogue entry. Users cannot edit
device information from project equipment. Users can only edit/add devices from the
Wiring Manager Device Catalogue. Also, if a catalogue definition is changed in the
Device catalogue all the project instances are changed to the new definition.

Click Save to save the new device to the parent equipment (or DIN Rail).

Add Multiple Devices


If it is required to create multiple devices of the same catalogue component, then prior to
clicking Save, check the Add Multiple checkbox then enter the number of devices required
in the Quantity field. Click Save to create the number of devices entered.

Note: Wiring Manager will create these devices with a blank equipment no (tag no) and
increment the sequence from the one entered in this window.

Users may edit the device by selecting a different device component from the catalogue at
any time during the project by re-selecting another device from the Wiring Manager Device
catalogue.

5.7.4 Select Device from the Catalogue


When adding a new Device from the Wiring Manager Device Catalogue (see Add Devices
(Relays, Barriers etc.)) this window is displayed:

To select a Device from the catalogue, double-click on the Device record, or select the
Device record, then click Select.
Wiring Manager will then create the new project Device by copying the catalogue Device
definition, including all terminals and their markings.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Device information is fixed for each specific catalogue entry. Users cannot edit
device information from project equipment. Users can only edit/add devices from the
Wiring Manager Device Catalogue.

5.7.5 Adding I/O Modules


An I/O Module component is defined in the I/O Module Catalogue. This can be for any
control system (DCS, SIS, PLC etc.).
Although I/O modules can be added to almost any equipment item, it is more usual to group
modules together on rails. In Wiring Manager DIN Rails offer a convenient method of
grouping devices and/or terminal strips together in a user defined sequence.
To add an I/O Module, in Equipment Layout window, right-click on any DIN Rail or existing
component and click Add I/O Module from the pop-up menu.
Or, in the Equipment View context-sensitive right-click menu (after right-clicking on an
appropriate equipment node), click Add I/O Module menu option.
I/O Modules can also be added from the Cable Block Diagrams window by right-clicking on
any Equipment and selecting the Edit Detail option to display the Equipment Layout
window.
The I/O Module Definition window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To create a new I/O Module:


• Enter an I/O Module Tag No or Description, and
• Select an I/O Module definition from the Wiring Manager I/O Module catalogue, by
clicking the Select from Catalogue button. Refer to Selecting an I/O Module from the
Catalogue.
• Optionally select a Status (new, existing etc.) from the Status list.
• Enter a First Point/Channel No. This defines how Wiring Manager numbers the
points/channels for I/O assignment reports.
• Enter or select the number of leading zeros for channel numbers in the Leading Zeros
field. For example, if you specify 2, channels will be numbered with 2 leading zeros,
e.g. 001, 002 etc.
• Optionally enter a Start Address. This will define how Wiring Manager creates each
point/channel Address (only if a value is entered: e.g. %AI00201).
• The Properties tab is optionally used to enter data for I/O module properties such as
Rack/Slot, System etc. that can be viewed in the I/O Allocation Gridview/Report and
added to drawings produced with Wiring Manager Designer.
Once an I/O Module is selected, the Catalogue Information fields display the I/O Type,
Model No, Manufacturer, Description, No of Points etc. and the graphic is updated to
show the terminal arrangement of the selected device as described below.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: I/O Catalogue information is fixed for each specific catalogue entry. Users cannot
edit I/O Module information from project equipment. Users can only edit /add
modules from the Wiring Manager I/O Module Catalogue. Also, if a catalogue
definition is changed in the I/O Module catalogue all the project instances are
changed to the new definition.

Click Save to save the new device to the parent equipment (or DIN Rail).
An I/O Module can be edited by selecting a different I/O Module from the catalogue at any
time.

Note: Assigning tags to I/O is done from the Terminations window. See Terminations User
Interface and Assign Tags to I/O Modules.

5.7.6 Selecting an I/O Module from the Catalogue


When adding a new I/O Module from the Wiring Manager I/O Module Catalogue (seeAdding
I/O Modules), this window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To select an I/O Module from the Catalogue, double-click on the I/O Module record, or select
the I/O Module record, then click Select.
Wiring Manager will then create the new project I/O Module by copying the catalogue I/O
Module definition, including all terminals and their markings.

Note: I/O Module information is fixed for each specific catalogue entry. Users cannot edit
device information from project equipment. Users can only edit /add devices from the
I/O Module Catalogue.

5.7.7 Add Compartments


Note: Compartments cannot be added to equipment created in and shared from and
AVEVA Electrical project. If this is attempted, an message will be displayed to inform
the user of this.
It is recommended that, if AVEVA Electrical is in use for a project, all Compartments
should be created in that application. Compartments should only be created in
AVEVA Instrumentation if Electrical is not being used, so that the necessary cable
terminations etc. can be specified for them.

To add a Compartment, from the Equipment Layout window of an MCC or Switchboard,


right-click and select Add Compartment from the pop-up menu.
Or, from the Equipment View context sensitive right-click menu (after right-clicking on an
appropriate MCC or Switchboard node) click Add Compartment.
The Compartment Information window is then displayed:

Enter the details of the compartment and click Save.

5.7.8 Adding Group Labels


Labels can be added to terminal strips, devices etc. in the Equipment Layout window.
To add a label, right-click on blank space in the layout next to the item to be labelled, and
click Add Group/Label on the context sensitive menu.
The Group Detail window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Enter the label that will appear on the layout, and a location/description.
Enter a sequence number.

Note: The sequence defines the order of multiple terminal strips/DIN Rails within the
equipment. This affects the Equipment Treeview as well as equipment termination
reports and equipment termination drawings created by Designer. The lowest
sequenced terminal strip/DIN Rails will appear first, highest last etc. within each
Equipment item.

5.7.9 Modify Terminal Strips and Earth Bars


Existing terminal strips and earth bars can be modified:
From the Equipment View or Equipment Layout window, right-click on the Terminal Strip or
Earth Bar node or object. From the menu, select Edit Detail. The appropriate information
window then appears. For example:

Enter the number of terminals required. Users can also specify the first terminal number. If
this First Terminal No. value is changed all terminals are renumbered sequentially from the
number entered. Users can also change the Terminal Strip No or Earth Bar Name (its tag
or label).

Note: If the number of terminals in the Terminal Strip or Earth Bar is reduced then all cable
cores or wires terminated on the terminals being deleted are first disconnected by
Wiring Manager.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5.8 Copy Equipment


Wiring Manager provides facilities to:
• Copy and Move Equipment with Internal Components
• Copy Equipment with Cables and Terminations
Note: Field devices cannot be copied, although they can be moved (i.e. cut and pasted).

5.8.1 Copy and Move Equipment with Internal Components


Existing equipment (Cabinets/Panels, Junction boxes etc.) apart from field devices can be
copied with all their internal terminal/device arrangements by using the Equipment View's
Copy option on the right-click context menu.
From the Equipment View right-click on the Equipment node to be copied, click Copy on the
context menu, right-click on the parent node under which the new Equipment is to be placed
(typically an 'Area', 'Building', 'Room' or ‘Vendor Package’ node), and click Paste from the
context menu.
Wiring Manager will create a copy of the original Equipment naming the Equipment 'copy of
XXXXXX' where XXXXXX is the original Equipment Number.

Note: Use the right-click option Edit Detail to change the Equipment Number.

To move equipment, use the Cut and Paste options on right-click context menu the instead
of the Copy and Paste options, or drag and drop the equipment between nodes.

5.8.2 Copy Equipment with Cables and Terminations


Wiring Manager also supports copying existing equipment and any 'From' cables (cables in
the cable schedule with their 'From' ends defined as the equipment being copied). This
features enables the copying of all 'From' cables and will terminate the new cables exactly
as the original cables being copied. This features enables extremely fast creation of field
Junction Boxes and their main multi-pair (or home run) cables.
To copy Equipment along with cables and their terminations, from the Equipment View right-
click on the Equipment node to be copied, click Copy (with 'From' Cables) from the context
menu, right-click on the parent node under which the new Equipment is to be placed
(typically an 'Area', 'Building', ‘Vendor Package’ or 'Room' node), and click Paste from the
context menu.
The Copy Equipment with Cables window is then displayed, listing all the cables 'From'
the original equipment:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

This window also provides a field for entering the new Equipment Number.

To Select the Cables to be Copied


Check the Select checkbox for all cables to be copied.

To (Optionally) Rename the New Cables


Change the entry in the New Cable No. field to a new value (if this is not changed Wiring
Manager will instead rename any existing Cable 'copy of XXXXXX' where XXXXXX is the
original Cable Number).

To (Optionally) Change 'To' End of New Cables


If this is not changed the new cable is routed to the same 'To' equipment as the original
cable.
To change a ‘To’ end, click the button which appears when the mouse cursor is hovered
over an Equipment No. cell
The Select Equipment window is displayed, enabling the user to select any existing
Equipment (or set the 'To' cable end to 'Not Connected').

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To select an equipment tag, double-click on the required tag or click on it and then click
Select. The window is then closed and the number of the specified equipment is displayed
in the Equipment No. cell.
To create a new equipment tag, select New. This displays the Equipment Information
window. Create the new equipment as described in Create New Equipment. The new
equipment is then added to the list in the Select Equipment window.
To copy an existing equipment tag, select the equipment from the list then select Copy
Selected. This displays the Equipment Information window with the details of the selected
equipment displayed. Amend these details as required and click Save. The new equipment
is then added to the list in the Select Equipment window and is available for selection.
To exit the window without selecting destination equipment, or to de-select destination
equipment previously selected so that the other end of the cable is no longer connected,
click either Not Connected or Exit.

5.9 Equipment List


All project equipment in Wiring Manager can be viewed in a Grid view using the Equipment
List window. This list provides facilities for the printing of termination reports for multiple
(selected) equipment, updating termination report document numbers, revisions etc. and is
an alternate method of accessing equipment using grid filters and terminations.
To open the Equipment List, click Select in the Grids and Schedules section of the Home
tab.
Select Equipment List from the list of grids that is then displayed. The Equipment List grid
is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

All fields except those with a yellow background can be edited directly within the grid.
For information on Grid functionality refer to Working with the Data Grid.

Equipment List Layout


The Equipment List layout can be set by the user using the Grid Manager utility (select
Manager in the Grids and Schedules section of the Home tab). The Grid Manager enables
users to define Views, that is, which fields should be viewable in the Cable Schedule grid,
their default position (column order), column size, default sort order and whether a data filter
is applied (e.g. Show only 'New' items). New Grid Views can be saved for use by individuals
or for entire project teams and existing Views selected. Refer to Grid Manager for more
information.

Accessing Information
Clicking on the Equipment No. cell button (see highlighted above) that appears when the
mouse is hovered over that cell displays the Options window:

The options are as follows:


• Edit Detail: Displays the Equipment Detail window or Equipment Layout window,
depending on the selected equipment's type.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

• Edit Terminations: Displays the Terminations window. This option displays all
terminals/devices and terminations for the entire equipment.
• View Terminations (Print Preview): Displays the Termination Reports print preview
window.

Select/Change Parent Equipment


Clicking on the button that appears when the mouse is hovered over the Parent cell enables
users to set the Equipment's Parent from other Equipment in the database. Refer to Select
Parent Equipment for details.

Equipment Shared with AVEVA Electrical


Equipment created in AVEVA Instrumentation can be shared with AVEVA Electrical and vice
versa. Refer to Add Cabinets and Junction Boxes and Add Field Devices for details.
Whether or not equipment is shared, and if so, which application it was created in is
displayed in the Discipline column:
• If an equipment is not shared, the discipline will be “Instrumentation”.
• If an equipment is shared and was created in Instrumentation the discipline will be
“Inst(Shared)”.
• If an equipment is shared and was created in Electrical the discipline will be
“Elect(Shared)”.

Shared equipment may be viewed in either application but may only be edited in the
application in which it was created.

Equipment List - List Tools Options

The following options are located on the List Tools - Equipment List tab

Records Section

Refresh

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

Delete

Actions Section

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Edit Displays the Terminations window. Refer to Terminations User


Terminations Interface for further information.

Auto Ferrule Used to automatically add ferrule numbers to the wire ends
Selected connected to the selected equipment in accordance with pre-
Equipment defined numbering rules. Accesses a sub-menu from where the
left, right or both sides of the equipment can be selected for
numbering. Refer to Update Ferrule Numbers using Ferrule Rules
for further information.

Revisions Displays a list of all revisions for termination reports associated


with the equipment in the grid. Refer to Viewing and Editing
Multiple Termination Report Revisions.

Add Revision Displays the Revision Entry window, enabling the user to add a
revision to an equipment termination report. Refer to Create a
Revision.

Edit Revision Displays the Revision Entry window, enabling the user to edit an
existing revision. Refer to Edit a Revision.

Change Symbol Used to change the symbol used to represent individual items of
equipment on enhanced cable block diagrams. Refer to Change
Enhanced Cable Block Diagram Equipment Symbols.

Tools Section

View Ferrule Displays a window listing ferrule markings/numbers for the current
Markings equipment. Refer to Viewing Ferrule Markings for details.

Add Multiple Used to create multiple items of major equipment in bulk. Refer to
Equipment Create or Import Multiple Major Equipment for details.

Printing Section

Preview Creates a Termination Report for the currently selected equipment


Termination as a Print Preview. Refer to Termination Reports for details. If
Report multiple equipment is selected in the grid, multiple previews are
generated.

Print Termination Prints a Termination Report for all the equipment currently selected
Report in the grid. Refer to Termination Reports for details

Export Section

To PDF Exports a Termination Report in PDF format for all the equipment
currently selected in the grid. Refer to Termination Reports for
details

Attached Documents Section

Open for Opens a list of all documents attached to the current equipment.
Selected Refer to Attachments (External Documents) for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Attach Document Used to attach a document to the current equipment. Refer to


Attachments (External Documents) for details.

Change Folder Used to change the folder in which the attached documents of
selected instruments are located. Refer to Attachments (External
Documents) for details.

5.9.1 Select Parent Equipment


Users may select the Parent Equipment of an item of Equipment from a list of other
Equipment in the database.
This can be useful for example when users wish to group field devices together, such as
making a Limit/position switch have as its parent its Control Valve tag. In this example, the
Limit Switch would appear as a child node in the Equipment Treeview and any cable
connected to the Control Valve could be terminated on the Limit Switch in the Terminations
window since child field devices are shown in the parent equipment's Terminations window.
To select the Parent of equipment, click the Parent cell button that appears when the mouse
is hovered over that cell. The Select Parent Equipment window is then displayed:

To select an equipment tag, double-click on the required tag or click on it and then click
Select. The window is then closed and the number of the specified equipment is displayed
in the Parent cell.
To exit the window without selecting parent equipment, or to de-select parent equipment
previously selected so that the equipment no longer has parent equipment, click Not
Connected.

5.9.2 Change Enhanced Cable Block Diagram Equipment Symbols


The symbols used to represent equipment displayed on enhanced Cable Block Diagrams
may be changed on an individual basis.
In the Equipment List, in the Actions section of the List Tools tab, click Change Symbol.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Symbol List window is then displayed:

The window displays all the different project symbols for the selected item type (see Add or
Edit Cable Block Diagram Symbols). The Default Symbol checkbox indicates the default
symbol set for the type of item.
Select a different symbol either by double-clicking on it or clicking on it and clicking Select.
A message then confirms that the symbol for the item has been changed, and the window
exits.

5.10 Create or Import Multiple Major Equipment


Multiple items of major equipment can be created in bulk using the Add Multiple Equipment
facility.
Using this facility, multiple items of equipment can be added to the project and associated
with a selected major equipment catalogue item, from which their layout, cabling and
termination etc. details are derived, by either:
• Importing them from an Excel spreadsheet, in which the basic details of the equipment
and the major equipment catalogue item are identified.
• Entering details of multiple equipment, including the major equipment catalogue item,
in the Add Multiple Equipment wizard.

The Add Major Equipment Procedure


Open the Equipment View or the Equipment List. In the Tools section of the List/List Tools
tab, click Add Multiple Equipment.
The Add Multiple Equipment wizard window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: The facility can also be accessed from the Cable Block Diagrams window. See Add
Equipment. When the wizard is accessed from a Cable Block diagram, any
equipment created or imported is added to that diagram when the procedure is
completed.

Importing Equipment Details from a Spreadsheet


To import basic details from a spreadsheet, click Import. The following window is displayed,
which explains the format that spreadsheets to be imported from must be in:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Click Browse to select the required spreadsheet. Click Next > to start the import.
Details of the equipment imported from the spreadsheet are then displayed in the wizard:

As required, enter cable numbers and select destination equipment as described below.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Entering Basic Details in the Wizard


To enter basic details by entry into the wizard instead of, or as well as, importing from a
spreadsheet, click New.
A row of fields is then added to the wizard:

Select an Area number, enter a unique equipment number, and select a Major Equipment
Catalogue number.

Adding Multiple Rows


To add multiple rows of new equipment in one go, click Create Multiple, accessible from the
menu which is displayed when the arrow next to the New button is clicked.
The following is then displayed:

Select an Area number and a Major Equipment Catalogue number, and specify the number
of items to be added.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Click Next.
The multiple items are then added to the wizard:

The default equipment numbers of equipment added to the wizard in this way will be in the
following format, as shown above: “copy of New Equip(#)”. Amend these as required.

Entering Cable and Destination Details


Cable numbers must be entered if the selected Major Equipment Catalogue item for an
equipment item has a cable connected to it.
Enter the cable number in the cell provided. A new cable with this number will be created
along with the equipment.
If the Major Equipment Catalogue item for an equipment item has multiple cables connected
to it, then that number of cables will be created. If for example a Catalogue item for an
equipment item has four cables connected to it, and a cable number of “ABC” is entered in
the Cable No. field, a cable with that cable number will be created, plus three more called
“Copy of ABC”, “Copy of ABC(1)”, and “Copy of ABC(2)”. If a cable number already exists in
the database, the copy number will be incremented to make it unique.
If the selected catalogue item does not have a cable connected, leave this cell blank.
If a cable number has been entered, destination equipment may optionally be selected by
clicking the button in the Destination column. The Select Equipment window is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To select an equipment tag, double-click on the required tag or click on it and then click
Select. The window is then closed and the number of the specified equipment is displayed
in the Destination cell.
To create a new equipment tag, select New, this displays the Equipment Information
window. Create the new equipment as described in Add Field Devices. The new equipment
is then added to the list in the Select Equipment window.
To exit the window without selecting destination equipment, or to de-select destination
equipment previously selected so that the other end of the cable is no longer connected,
click either Not Connected or Exit.

Copying Rows
To copy a row, select it, then click Copy Selected, accessible from the menu which is
displayed when the arrow next to the New button is clicked.
A copy of the selected row is then added to the wizard. Amend the details as required.

Deleting Rows
To delete a row or rows, select them in the wizard and click Delete. A message is then
displayed requesting that the deletion be confirmed. Click Yes to delete the selected row(s),
or No to cancel the deletion.

Creating the New Equipment


Once all the required data has been entered in the wizard, click Create.
If there is any conflicted data, i.e. any reasons why equipment cannot be created, these are
then listed on the next page of the wizard:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

This page is not displayed if there is no conflicted data.


If required, click < Back to return to the previous page of the wizard to correct these
problems.
To proceed with the creation of those items that do not have conflicts, click Next >.
The creation of the equipment then takes place. A log of the equipment creation process is
then displayed, with those items successfully created and those items not successfully
created listed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Click OK to exit the wizard.


Equipment successfully created is added to the Equipment View and the Equipment List.
Any connected cables are added to the Cable Schedule.

5.11 Import Equipment from Excel


Equipment details can be imported from an Excel spreadsheet. There are three separate
import options, one for each of the following:
• Major Equipment
• Components
• Terminals
Note: New major equipment can be imported, and major equipment currently in the
database can be updated by the import.
However, existing components and terminals cannot be updated by the import. The
import can only import new components and terminals.

The Excel Spreadsheet


The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading.
The Excel file must include:
• A column containing the Equipment Number.
• For major equipment it must also include Area Path, Area Number and Equipment
Type columns.
• For components in must also include Parent Equipment Number, DIN Rail Number,
Equipment Type, Catalogue Number and Sequence columns.
• For terminals it must also include Parent Equipment Number, Marking and Sequence
columns.
Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.
While processing records to be imported, if a record already exists in the database AVEVA
Instrumentation will show the differences between the imported data and the AVEVA
Instrumentation data, allowing the user to accept/reject the proposed changes on a record
by record (and field by field) basis. If the record does not exist in AVEVA Instrumentation
and the user accepts the importation of the record, AVEVA Instrumentation will create a new
record for that drawing or catalogue item.
The Import Procedure
Open the Equipment View or the Equipment List. From the Import section of the Manage
tab, click From Excel.Then select as required either the Major, Components or Terminals
option from the window that is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The Equipment Import wizard window is then displayed, for example:

Click Browse and select the Excel file from which data is to be imported.
Below the Browse button, a list of fields that must be mapped, and an image of an example
spreadsheet are displayed. This will vary depending on the type of import selected, as
described above.
Click Next >.
The next window shows all the columns in the Excel spreadsheet to be imported. Select an
existing Field Mapping (if one for this Import type exists) from saved mappings drop down
or use the automatic mappings created by AVEVA Instrumentation and make changes to
these mappings (if required).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the first
row in the Excel worksheet against fields names in AVEVA Instrumentation Database

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

(if not found then field Captions - as set in the Grid Manager). If a match is found
then AVEVA Instrumentation automatically adds the Field Name to the mapping list.
The user can select a different field from the mapping list if required.

Define a New Mapping Definition


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

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

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

Import the Data


Once the mappings have been set up, click Next >.
A list of equipment in the spreadsheet that will not be imported because they are invalid in
some way in then displayed, along with the reason that they are invalid:

Click Next >.


A list of equipment which can be imported is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To import an equipment item, check its Select checkbox. Check the Select all checkbox to
check all the Select checkboxes.
Click Next >.
AVEVA Instrumentation will display the Import Options window from which the user may
choose to import reports one by one or in a batch. The batch option processes all records
together then displays a differences report enabling users to accept or reject each change.
The one by one option displays a differences report for each record one at a time.

Click on the required option. If field mappings are being tested, it is recommended that the
Process each Record and Show Differences one by one option is selected. AVEVA
Instrumentation will then process the data and show any differences in the Import
Differences window:
The Import Differences window shows the differences between AVEVA Instrumentation
data and proposed (imported Excel) data. If the one by one option was selected, the
difference for a single record are listed. If the batch option was selected, differences for all
records are displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

To accept the changes either, select individual field data by clicking the Accept checkbox for
each.
Or select the Accept All checkbox at the top of this window (all individual records will be
auto-selected).
To save the checked (accepted) data to the catalogue click Save.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next record, if there is one.

Note: To cancel all further importing click Stop Import.

After the differences have been displayed, the selected list of valid equipment is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

Click Close the exit the import wizard.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5.12 Termination Reports


In Wiring Manager, reports on equipment termination reports can be produced. These can
be printed out or saved in PDF format for electronic transfer. These reports are non-CAD so
they do not require a CAD program to create.

Note: Instrumentation also supports the creation of Termination Diagrams in AutoCAD


DWG format from the Designer module.

To generate an equipment Termination Report:


• From the Equipment View window, right-click on the equipment node. A menu is then
displayed. From the menu, click Print Preview Terminations.
• Or, from the Equipment List window, select a single (or multiple equipment) record(s),
and click Preview Termination Report in the Printing section of the List Tools -
Equipment List tab.
• Or, from the Cable Schedule grid, select the From or To grid cell button for a cable and
select the Print Preview Terminations option from the Options window that is
displayed.
• Or, from the Major Equipment Catalogue grid, select an item from the grid view, click
Edit and select View Terminations (Print Preview) from the displayed Options
window.
The Termination Report window is then displayed, showing a print preview of the report.
For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Wiring Manager creates a single termination report for the selected equipment, using
multiple pages if necessary. New pages are created when the number of terminals exceeds
the maximum allowable for a specific page size/orientation. Wiring Manager always creates
a new page for each new DIN Rail. Terminal strips on a common DIN Rail are kept together
and a new page is not created unless all terminals will not fit on the current page.
Users can zoom in by double-clicking on the graphic or using the magnify button on the
toolbar.
Use the Setup command to change printer properties (page size, orientation etc.) for the
current document.
The Preferences command enables users to set the default page size for the entire project
(Wiring Manager defaults to A4 if not set otherwise) and set the maximum number of
terminals that Wiring Manager can draw on each page.
Click Print to print the report. Reports can also be printed using the Print Termination
Report option in the Printing section of the List Tools - Equipment List tab.
Users may export the report to PDF format using the Export to PDF command. Reports can
also be exported to PDF format using the To PDF option in the Export section of the List
Tools - Equipment List tab
Users can zoom into the document by double-clicking and pan the document by clicking on
the background and 'dragging'.

Note: Export to PDF creates a file in the project's Drawing folder with a file name of either:
The Sketch Number (as defined in the Equipment List) or if this Sketch Number is left
blank, the Equipment Number.

Title Blocks on Termination Reports


Wiring Manager supports title blocks and revisions on Termination Reports if the equipment
has a Sketch Number that is not blank/empty. Wiring Manager will create the termination
report with a title block complete with Revision history. Sketch (Document) numbers and
Revisions are added/edited from the Equipment List window.
Here is an example of a Title Block produced on the Termination Report when the
equipment has a Sketch Number:

Users can add/edit Termination Report document revisions for multiple reports. Refer to
Report Revision Entry.
This title block is 'fixed' and cannot be modified by the user in the current version of Wiring
Manager.

5.12.1 Report Revision Entry


Note: In order for a revision to be added to the termination report associated with an
equipment item, a Sketch (Document) Number must first be entered for that
equipment in the SketchDwgNo cell of the Equipment List.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Create a Revision
• To create a revision for a termination report, select the associated equipment in the
Equipment List and click Add Revision in the Actions section of the List Tools -
Equipment List tab.
• To create a revision for multiple termination reports, select the associated equipment in
the Equipment List and click Add Revision in the Actions section of the List Tools -
Equipment List tab.
When revisions are added using this method the details entered in Revision Entry
window (below) are assigned to all selected reports.
The Revision Entry window is then displayed:

Complete the fields as required.


When creating a new revision, leaving the Revision No field blank will cause
Instrumentation to use the next revision number. e.g. if the current revision is "A", then the
next is "B" or if current revision is "2", then the next is "3" etc.
The Date field defaults to the current date, but a different date may be selected if required.
The Description field contains a list of all previously created revision descriptions. Add a
new description by entering any required description. Any new descriptions will be available
for future revision entries.

Edit a Revision
• To edit the current revision for a termination report, select the associated equipment in
the Equipment List and click Edit Revision in the Actions section of the List Tools -
Equipment List tab.
• To edit the current revisions for multiple termination reports, select the associated
equipment in the Equipment List and click Edit Revision in the Actions section of the
List Tools - Equipment List tab.
When revisions are edited using this method the details entered in Revision Entry
window (below) are assigned to all selected reports.
The Revision Entry window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Edit details as required. See Create a Revision for details.

Viewing and Editing Multiple Termination Report Revisions


To view a list of all revisions of all termination reports in the Equipment List, click Revisions
in the Actions section of the List Tools - Equipment List tab.
The Revisions window is then displayed:

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5.13 Attachments (External Documents)


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

5.13.1 View the List of Attachments for an Equipment Item


The view the list of all the attachments for an item of equipment, select the equipment in the
Equipment View or Equipment List, and click Open All in the Attached Documents section
of the Tools/List Tools tab. The Attached Documents window is then displayed:

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5.13.2 Add a New Attachment


To attach a document to an equipment item, either:
• Click Attach Document in the Attached Documents section of the Tools/List Tools
tab of the Equipment View or Equipment List.
• Or open the Attached Documents window for the equipment and click New.
The Attached Document Details window is then displayed:

The file to be attached is selected by clicking the button to the right of the Document field. A
file browser window is then opened, enabling the user to navigate to the file. Select the
required file and click Open on the file browser window to close the file browser window and
return to the Attached Document Details window. The Document field will be populated
with the selected file and file path.
The user can select a document type from the Type drop-down list or manually enter a new
type. An optional description can be entered in the Description text box.
Check the Public checkbox if the attachment is to be shared with all the users on the same
project. Leave the Public checkbox box unchecked if only the current user is to have
access to the attachment.

Note: Documents can also be attached by importing attached document details for an
Excel spreadsheet. See Importing Attached Documents Data.

5.13.3 Edit Attached Document Details


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Edit the attachment details as required, as described above.

5.13.4 Delete Attached Document


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

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

5.13.5 Change Attached Document Folders


To change the folder in which the attached documents of multiple tags are located, select
the equipment in the Equipment View or Equipment List, and click Change Folder in the
Attached Documents section of the Tools/List Tools tab. The Change Folder window is
the displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

5.13.6 Importing Attached Documents Data


Attached documents data can be imported from an Excel spreadsheet.
Open the Equipment View or Equipment List. Click Attached Documents in the Import
section of the Manage tab. The Attached Document Import wizard window is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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

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

Defining a New Mapping Definition


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

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

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

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

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Click Close the exit the import wizard.

5.13.7 Export Attached Documents Data


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

Clicking Yes changes the folder path in the Attached Documents window, but the user
cannot view any attachments until the file is moved or copied to the new folder path. Click
No to cancel the folder path change.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

5.14 Equipment Catalogues


AVEVA Instrumentation includes Equipment Catalogues which used to define standard
equipment items and their terminal arrangements. These catalogue items can be used in
the creation of project equipment. The equipment catalogues are:

Major Equipment Typically Cabinets, Junction Boxes etc.

Field Devices Field Instruments/Devices.

Fieldbus Devices Fieldbus Instruments/Devices.

Devices Relays, IS Barriers/IS Isolators, Power Supplies etc.

I/O Modules Typical DCS and PLC I/O modules.

Note: Changes to catalogue item data will not be affect the properties of equipment already
created from them. Only equipment subsequently created will be affected.

Access the Equipment Catalogues


Click Select in the Grids and Schedules section of the Home tab.
A list of grids is displayed. Select the required catalogue from those listed under the
Catalogue heading:

Major Equipment Catalogue Displays the Major Equipment Catalogue list.

Field Device Catalogue Displays the Field Device Catalogue list.

Fieldbus Devices Catalogue Displays the Fieldbus Device Catalogue list.

Device Catalogue Displays the Device Catalogue list.

I/O Module Catalogue Displays the I/O Module Catalogue list.

5.14.1 Major Equipment Catalogue


Wiring Manager's Major Equipment Catalogue is used to define Cabinets, Junction Boxes
etc. and their terminal arrangements. By predefining terminal strip arrangements, users can
set project standards that can be re-used many times. This can also save time by copying
pre-built equipment that will contain all the terminals and their terminal markings/numbers
as defined in the catalogue.
To access the Major Equipment Catalogue, click Select in the Grids and Schedules
section of the Home tab.
Select Major Equipment Catalogue from the list of grids that is then displayed. The
catalogue grid is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Refer to Working with the Data Grid for information on the grid controls.

Add Major Equipment to the Catalogue


To add Equipment to the project Major Equipment Catalogue, open the Major Equipment
Catalogue and click New in the Records section of the Home tab. The Equipment
Information window is displayed:

The user must enter a Catalogue Name and select an Equipment Type from the drop-
down list. Completion of the Description field is optional.
If the item is being supplied by a Vendor, check the Vendor Supplied checkbox.
Click Save to create the new catalogue item and close the window. The new item is then
added to the grid.
Click Cancel to close the window without adding an item.

Edit Catalogue Major Equipment


To edit Equipment in the project Major Equipment Catalogue, open the Major Equipment
Catalogue and click New in the Records section of the Home tab, or double-click on the
Equipment record in the grid. The Options window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Select the required option from the dialog:

Edit Detail Displays the Equipment Layout window. Refer to Equipment


Layout for further information.

Edit Terminations Displays the Terminations window. Refer to Terminations User


Interface for further information.

View Terminations Displays the Termination Reports window. Refer to Termination


(Print Preview) Reports for further information.

5.14.2 Field Device Catalogue


Wiring Manager's Field Device Catalogue is used to define Field Devices and their terminal
arrangements. Field Devices in the catalogue can be used in Wiring Rule definitions and to
set field device terminal arrangements for any field device in the project database.
To access the Field Device Catalogue, click Select in the Grids and Schedules section of
the Home tab.
Select Field Device Catalogue from the list of grids that is then displayed. The catalogue
grid is then displayed:

Note: Only those devices with their Allow Use checkbox column checked will be available
for use when creating Field Devices.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Importing Catalogue Data


Field Devices may be imported from another Wiring Manager project. In the Import section
of the Manage tab, click From Other Project.
Refer to Importing Catalogue Items from another Project for details.

Add a Catalogue Field Device


To add a Field Device to the project Field Device Catalogue, open the Field Device
Catalogue and click New in the Records section of the Home tab. The Field Device
Definition window is displayed:

Check the Allow Use checkbox as appropriate. Only those devices with their Allow Use
checkbox checked will be available for use when creating Field Devices.
Enter a Catalogue name and description.
To define the Device Terminals, enter number of left terminals in Left Quantity, enter
number of right terminals in Right Quantity.

Note: Wiring Manager works best with field device terminals set as right-sided.

If a terminal label is required, check either the Left or Right Terminal Label checkbox. Only
one of these checkboxes can be checked at a time. A checkbox cannot be checked if there
are no terminals on that side, i.e. the Left label checkbox cannot be checked if there are no
left-hand terminals.
When the terminal quantities or terminal label settings are entered or changed, Wiring
Manager refreshes the graphical representation of the device as shown in the example
below:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Define the Device Terminal Markings and Label


Click in first terminal and enter the default terminal marking value. Repeat for all terminals.

Note: The catalogue field device cannot be saved unless all terminals are marked.

If required, enter a default label in the label box in the same way, and the default
descriptions of the terminals in the description boxes next to each terminal.

Note: The <Tab> key can be used to jump between terminal and description boxes.

Example:

These default terminal markings and labels can be replaced with “actual” values when
specifying the details of devices using the catalogue definition.

Share Catalogue Field Device with Electrical


If the catalogue Field Device is to be shared with AVEVA Electrical, click Share the Device
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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

afterwards (using the Project tab > Edit Project option). Refer to the Installation
User Guide for details.

Note: Field Devices shared with AVEVA Electrical can be viewed in AVEVA Electrical but
not edited.

Edit a Catalogue Field Device


To edit a Field Device, open the Field Device Catalogue and click Edit in the Records
section of the Home tab, or double-click on the Field Device record in the grid. The Field
Device Definition window is displayed. Enter or change the details as described in Add a
Catalogue Field Device.

5.14.3 Fieldbus Device Catalogue


Wiring Manager's Fieldbus Device Catalogue is used to define Fieldbus Devices.
To access the Fieldbus Device Catalogue, click Select in the Grids and Schedules section
of the Home tab.
Select Fieldbus Device Catalogue from the list of grids that is then displayed. The
catalogue grid is then displayed:

Importing Catalogue Data


Fieldbus Devices may be imported from another Wiring Manager project. In the Import
section of the Manage tab, click From Other Project.
Refer to Importing Catalogue Items from another Project for details.

Add a Catalogue Fieldbus Device


To add a Field Device to the project Fieldbus Device Catalogue, open the Fieldbus Device
Catalogue and click New in the Records section of the Home tab. The Fieldbus Device
Definition window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Complete Device Type, Manufacturer, Model No, Description and a Description on


Drawing fields.
The Description on Drawing field can be used to change the default drawing description to
the value entered in this field. Using the <Enter> key will add a line-break in the drawing to
create multiple lines of text. Up to three lines can be created for the description in both
AutoCAD termination diagrams created in Wiring Manager Designer and Termination PDF
reports created in Wiring Manager. If this field is left empty the default description will be
used, which is the Manufacturer and Model No. separated a space.
The user must enter the No. of Points (Channels) together with the Terminal per points
required. A graphical representation is displayed, showing the No. of Points (Channels)
and the Terminal per Point selected. The user can then enter a marking into each of the
displayed boxes.

Note: If any terminals are left unmarked, a warning regarding this will be received when
Save is selected. The device may still be saved however.

If required, enter default descriptions of the terminals in the description boxes next to each
terminal.

Note: The <Tab> key can be used to jump between terminals and description boxes.

Example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

The user must now enter the No. of INPUT Terminals and the No. of OUTPUT Terminals
required. These terminals are then added to the graphical representation, allowing the user
to enter a marking into each of the boxes, plus descriptions if required.
Example:

Note: Users can set a Terminal to be a 'Plug and Socket' or 'Normal' terminal by right-
clicking and setting the Terminal Type.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Define the Device Internal Connections


To enable Wiring Manager to trace signal through a device, users should define its internal
logical connections. To define the devices internal logical connections, first save the new
device and then select Edit. Wiring Manager does not allow the internal connections to be
saved until terminals have first been saved to the database.

Important: Changing the internal connections changes all the devices in the project that
use the current device being edited.

Define internal connections as follows. Hold the Ctrl key down and click on a terminal. Next,
select another terminal on the other side of the device in the same way. Selected terminals
are highlighted in red.
Click + Internal Connection. A connection is then formed between the two terminals.
Wiring Manager will indicate connections with black lines between them as in the example
below:

To remove a connection, select the terminals at each end of the connection as described
above, and click - Internal Connections.

Edit a Catalogue Fieldbus Device


To edit a Fieldbus Device, open the Fieldbus Device Catalogue and click Edit in the
Records section of the Home tab, or double-click on the Field Device record in the grid. The
Fieldbus Device Definition window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Change the details of the device as required. See Add a Catalogue Fieldbus Device for
details.
To redefine the Points (Channels) or INPUT/OUTPUT Terminals, enter the number
required in the appropriate box. Changing any of the values forces Wiring Manager to
refresh the graphic representation.
To edit the terminal markings, select a terminal in the graphic and enter the new value.

Note: The <Tab> key can be used to jump between terminals.

Important: Changing the Points (Channels) or INPUT/OUTPUT Terminals values or


terminal markings changes all the devices in the project that use the current
Fieldbus Device.

5.14.4 Device Catalogue


Wiring Manager's Device Catalogue is used to define Devices and their terminal
arrangements.
To access the Device Catalogue, click Select in the Grids and Schedules section of the
Home tab.
Select Device Catalogue from the list of grids that is then displayed. The catalogue grid is
then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Only those devices with their Allow Use checkbox column checked will be available
for use when creating Devices.

Importing Catalogue Data


Devices may be imported from another Wiring Manager project. In the Import section of the
Manage tab, click From Other Project.
Refer to Importing Catalogue Items from another Project for details.

Add a Catalogue Device


To add a Device to the project Device Catalogue, open the Device Catalogue and click New
in the Records section of the Home tab. The Device Definition window is displayed:

Check the Allow Use checkbox as appropriate. Only those devices with their Allow Use
checkbox checked will be available for use when creating Devices.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Enter a Device Type, manufacturer, model number and description.


To define the Device Terminals, enter number of left terminals in Left Quantity. Enter
number of right terminals in Right Quantity.
Entering or changing either of the terminal quantities makes Wiring Manager refresh the
graphic representation, as shown below:

The Description on Drawing field can be used to change the default drawing description to
the value entered in this field. Using the <Enter> key will add a line-break in the drawing to
create multiple lines of text. Up to three lines can be created for the description in both
AutoCAD termination diagrams created in Wiring Manager Designer and Termination PDF
reports created in Wiring Manager. If this field is left empty the default description will be
used, which is the Manufacturer and Model No. separated a space.
To define the Device Terminal Markings, click in first terminal, enter the terminal marking
value and repeat for all terminals.

Note: If any terminals are left unmarked, a warning regarding this will be received when OK
is selected. The device may still be saved however.

If required, enter default descriptions of the terminals in the description boxes next to each
terminal.

Note: The <Tab> key can be used to jump between terminals and description boxes.

Example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Users can set a Terminal to be a 'Plug and Socket' or 'Normal' terminal by right-
clicking and setting the Terminal Type.

Define the Device Internal Connections


To enable Wiring Manager to trace signal through a device, users should define its internal
logical connections. To define the devices internal logical connections, first save the new
device and then select Edit. Wiring Manager does not allow the internal connections to be
saved until terminals have first been saved to the database.

Important: Changing the internal connections changes all the devices in the project that
use the current device being edited.

Define internal connections as follows. Hold the Ctrl key down and click on a terminal. Next,
select another terminal on the other side of the device in the same way. Selected terminals
are highlighted in red.
Click + Internal Connection. A connection is then formed between the two terminals.
Wiring Manager will indicate connections with black lines between them as in the example
below:

To remove a connection, select the terminals at each end of the connection as described
above, and click - Internal Connections.

Share Catalogue Device with Electrical


If the catalogue Device is to be shared with AVEVA Electrical, click Share the Device 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.

Note: Devices shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

Edit a Catalogue Device


To edit a Device, open the Device Catalogue and click Edit in the Records section of the
Home tab, or double-click on the Device record in the grid. The Device Definition window
is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Change the details of the device as required. See Add a Catalogue Device for details.
To redefine the Device Terminals, enter the number of left terminals in Left Quantity, enter
the number of right terminals in Right Quantity. Changing either of the terminal quantities
makes Wiring Manager refresh the graphic representation.
To edit terminal markings, select a terminal in the graphic and enter the new value.

Note: The <Tab> key can be used to jump between terminals.

Important: Changing the number of terminals or the terminal markings changes all devices
in the project that use the current Catalogue Device.

5.14.5 I/O Module Catalogue


Wiring Manager's I/O Module Catalogue is used to define I/O Modules (or FTAs) and their
terminal arrangements:
To access the I/O Module Catalogue, click Select in the Grids and Schedules section of
the Home tab.
Select I/O Module Catalogue from the list of grids that is then displayed. The catalogue grid
is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: Only those modules with their Allow Use checkbox column checked will be available
for use when creating I/O Modules.

Importing Catalogue Data


I/O Modules may be imported from another Wiring Manager project. In the Import section of
the Manage tab, click From Other Project.
Refer to Importing Catalogue Items from another Project for details.

Add a Catalogue I/O Module


To add an I/O Module to the project I/O Module Catalogue, open the I/O Module Catalogue
and click New in the Records section of the Home tab. The I/O Module Definition window
is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Check the Allow Use checkbox as appropriate. Only those modules with their Allow Use
checkbox checked will be available for use when creating I/O Modules.
Enter an I/O Type, manufacturer, model number and description.
The Description on Drawing field can be used to change the default drawing description to
the value entered in this field. Using the <Enter> key will add a line-break in the drawing to
create multiple lines of text. Up to three lines can be created for the description in both
AutoCAD termination diagrams created in Wiring Manager Designer and Termination PDF
reports created in Wiring Manager. If this field is left empty the default description will be
used, which is the Manufacturer and Model No. separated a space.

Define the I/O Module Points


Enter the number of points in the No. of Points (Channels) field. Enter the number of
terminals per point in the Terminals per Point field.
Changing either of the Point quantities makes Wiring Manager refresh the graphic
representation, as shown below:

Define the I/O Module Terminal Markings


Click in the first terminal and enter the terminal marking value. Repeat for all terminals.

Note: If any terminals are left unmarked, a warning regarding this will be received when OK
is selected. The device may still be saved however.

If required, enter default descriptions of the terminals in the description boxes next to each
terminal.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note: The <Tab> key can be used to jump between terminals and description boxes.

Example:

Note: Users can set a Terminal to be a 'Plug and Socket' or 'Normal' terminal by right-
clicking and setting the Terminal Type. This may be useful to show a Plug and Socket
connection to a DCS or PLC system. Plug and Socket terminals are shown on Wiring
Manager termination reports and Wiring Manager Designer's AutoCAD termination
drawings.

Wiring Manager also enables additional terminals to be defined, such as those requiring a
power supply, earth, field bus termination etc. To add additional terminals, enter the required
number of additional terminals in the Additional Terminals section. Additional Terminals
are always added to the right side of the I/O module.

Share Catalogue I/O Module with Electrical


If the catalogue I/O Module is to be shared with AVEVA Electrical, click Share IOModule
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.

Note: I/O Modules shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

Edit a Catalogue I/O Module


To edit an I/O Module, open the I/O Module Catalogue and click Edit in the Records section
of the Home tab, or double-click on the I/O Module record in the grid. The I/O Module
Definition window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Change the details of the device as required. See Add a Catalogue I/O Module for details.

Redefine the I/O Module Points


Enter the number of points in the No. of Points (Channels) field. Enter the number of
terminals per point in the Terminals per Point field.
Changing either of the Point quantities makes Wiring Manager refresh the graphic
representation
To edit terminal markings select a terminal in the graphic and enter the new value.

Note: Users may use the <Tab> key to jump between terminals and use the scroll bar to
access terminals if they are not viewable.

Important: Changing the number of terminals and/or terminal markings will update all I/O
modules used throughout the project using the current Catalogue I/O module's
new definition.

5.14.6 Importing Catalogue Items from another Project


Items for the following catalogues can be imported from another AVEVA Instrumentation
project in a multi-project environment:
• Field Device
• Fieldbus Device
• Device
• I/O Module
• Cable

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Equipment

Note that only new items, i.e. items not in the current catalogue, can be imported using this
procedure. Existing catalogue items cannot be updated or overwritten by an import.
With the appropriate Catalogue open, click From Other Project in the Import section of the
Manage tab. The Select Project window is then displayed. In this window, select the project
from which the catalogue instruments are to be imported.
The following message is then displayed:

Click Yes to proceed with the import.


The import then takes place. A message is displayed when the import is complete. The
imported items are added to the catalogue grid.
A window is then displayed listing any items that were not imported because they already
exist in the current project:

Click OK to close the window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

6 Cables

All project cables can be viewed, added and edited using the Cable Schedule grid. See
Create a New Project Cable, Select Catalogue Cable, Select Cable Ends, Copying Cables,
Edit Project Cable Data and Delete Cables.
Project cables are all based on a catalogue of cable definitions created for the project. See
Cable Catalogue for details. See also Change Cable Definitions.
Wiring Manager also includes facilities to assign cable glands and cable gland adaptors
(see Assign Cable Glands and Assign Cable Gland Adaptors) which are also based on
catalogues items (see Cable Glands and Cable Gland Adapters Catalogues).
Facilities are also provided to merge cables (see Merge Cables), drum cables (see Cable
Drums), and import cable details from external sources (see Import Cables from Excel and
AVEVA Cable Design Data Interface).

6.1 Cable Schedule


The Cable Schedule is used to add/edit and view all project cables and allows definition of
cable type from the Cable Catalogue. Users may also edit specific cable data such as Cable
Number, Length and assign From and To equipment etc.
In AVEVA Instrumentation, all project cables must be based on a catalogue cable. This
ensures the project cable properties (size, number of cores, type etc.) are consistent with a
'real' cable. Users can reassign another catalogue cable to any project cable at any time.
This changes the project cable to have the properties (size, number of cores, core markings,
type etc.) of the newly assigned catalogue cable, keeping current terminations for the
original cable.
To open the Cable Schedule, click Select in the Grids and Schedules section of the Home
tab.
Select Cable Schedule from the list of grids that is then displayed. The Cable Schedule grid
is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

By default all cables for the project are shown in the grid. Users may use the Filter by Area
list in the List Tools tab to filter the Cable Schedule by plant area.
All fields except those with a yellow background can be edited directly within the grid.
For information on Grid functionality refer to Working with the Data Grid.

Cable Schedule Layout


The Cable Schedule grid layout can be set by the user using the Wiring Manager Grid
Manager utility (select Manager in the Grids and Schedules section of the Home tab). The
Grid Manager allows users to define Views, that is, which fields should be viewable in the
Cable Schedule grid, their default position (column order), column size, default sort order
and whether a data filter is applied (e.g. Show only 'New' cables). New Grid Views can be
saved for use by individuals or for entire project teams and existing Views selected. Refer to
Grid Manager for more information.

Accessing Cable Terminations Data


Clicking on the From or To cell buttons that appear when the mouse is hovered over that
cell displays the Options window.

The options are as follows:


• Edit Detail: Displays the Equipment Layout window, used to design and view the
component layout of the equipment at the selected cable end. See Equipment Layout.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

• Edit Terminations: Displays the Terminations window, used to edit terminations of


the equipment at the selected cable end. See Terminations User Interface.
• View Terminations (Print Preview): Displays the Terminations Report print preview
window. See Termination Reports.
• Change 'To' / 'From' Equipment: Used to change a cable destination (either 'To' or
'From' depending on which cell is selected). See Select Cable Ends.

Select Cable Gland and Cable Gland Adapters


Clicking on the Gland (From) or Gland (To) cell buttons that appear when the mouse is
hovered over that cell displays the Select Cable Gland window. See Assign Cable Glands.
Clicking on the Adapter (From) or Adapter (To) cell buttons that appear when the mouse is
hovered over that cell displays the Select Cable Gland Adapter window. See Assign Cable
Gland Adaptors.

Drum Cables
A cable may be added to a drum by clicking the button that is displayed in the Drum No cell
when the mouse is hovered over it. The Select Cable Drum window is displayed. See
Assign Cables to Drums from the Cable Schedule.

Cables Shared with AVEVA Electrical


Cables created in AVEVA Instrumentation can be shared with AVEVA Electrical and vice
versa.
If the Show cables from both Instrumentation and Electrical checkbox on the Options
window is checked (this is the default setting), cables from Electrical shared with
Instrumentation will be listed in the Cable Schedule. They will be “greyed out”.
Whether or not a cable is shared, and if so, which application it was created in is displayed
in the Discipline column:
• If a cable is not shared, the discipline will be “Instrumentation”.
• If a cable is shared and was created in Instrumentation the discipline will be
“Inst(Shared)”.
• If a cable is shared and was created in Electrical the discipline will be “Elect(Shared)”.

A shared cable may be viewed in either application but may only be edited in the application
in which it was created.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Sizing, Drumming, Routing Status and Frozen Indicators


The default grid includes columns containing checkbox indicating:
• Whether or not cables have been sized (in AVEVA Electrical, where that is applicable).
• Whether or not cables have been drummed.
• Whether or not cables have been drummed and the drum is locked. Refer to Cable
Drums for further information on drumming.
• Cable Routed Status, e.g. Routed, Un-Routed, Check Route, etc.
• If a cable is routed, the nodes its route passes through. Routing and routing status
information is passed to and from E3D via the Cable Design Data interface. Refer to
AVEVA Cable Design Data Interface for further information.
• Whether or not cables have been frozen (meaning they cannot be edited). Refer to
Freeze a Cable for further information.

Cable Schedule - List Tools Options


The following options are located on the List Tools - Cable Schedule 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

Filter by Area Used to filter the grid to display only those cables that have a
source and/or destination in the area selected from the drop-down
list.

Auto Ferrule Used to automatically add ferrule numbers to the wire ends of
selected Cables selected in accordance with pre-defined numbering rules.
Accesses a sub-menu from where the left, right or both ends of the
cables can be selected for numbering. Refer to Update Ferrule
Numbers using Ferrule Rules for further information.

Auto Cable Displays the Auto-Cable Drumming Options window, used to


Drum selected assign cables to cable drums using an algorithm to minimise any
Cables unused cable based on each cable's length and the catalogue
drum length. Refer to Auto-Cable Drum for further information.

Bulk Update Used to bulk edit the numbers of all parent and child cables in the
Child Cable No cable schedule. Refer to Bulk Edit Parent and Child Cable
Numbers for further information.

Change Label Used to change the symbol used to represent individual cable
Symbol labels on enhanced cable block diagrams. Refer to Change
Enhanced Cable Block Diagram Cable Label Symbols for further
information.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Bulk Update Used to bulk update the installation method of cables imported
Installation from ETAP (in AVEVA Electrical). Refer to Bulk Update Cable
Method Installation Method for further information.

Tools Section

Change Enables the changing of Catalogue Numbers for selected cables.


Catalogue No. All selected cables have their properties (including number of
for selected cores and their markings etc.) changed to be identical to the new
Cables Catalogue No selected. Refer to Select Catalogue Cable.

Merge Cables Displays a window that enables merging of two cables into one.
Cables must have same source (From) and destinations (To) in the
cable schedule and must have the same basic core groupings type
(cores, pairs, triads or quads). Refer to Merge Cables.

Update Estimate Used to update the estimate lengths of cables as entered in


Length Instrumentation with the design lengths imported from AVEVA
Cable Design. Refer to Update Estimated Cable Lengths with
Design Lengths for details.

Bulk Cable Used to freeze multiple cables selected in the grid. Refer to Bulk
Freeze Freeze and Unfreeze Cables for details.

Bulk Cable Used to unfreeze multiple cables selected in the grid. Refer to Bulk
Unfreeze Freeze and Unfreeze Cables for details.

6.2 Create a New Project Cable


To add a new Cable to the project, open the Cable Schedule grid and click New in the
Records section of the Home tab.
The Cable Details window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Cables can also be created by:


• Selecting the Add New Cable toolbar option in the Terminations window. Refer to Tab
Commands.
• Using facilities provided by the Cable Block Diagrams application. Refer to Create a
New Project Cable (basic cable block diagrams) or Create a New Project Cable
(enhanced cable block diagrams).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

• Field cables can be created by assigning fields devices to Junction Boxes. Refer to
Assign Field Devices to Junction Boxes.
Note: Catalogue specific data (fields shown with a yellow background above) cannot be
changed in this window. This data is specific to the catalogue cable that has been
chosen.

Note: Cable length units are set for the current project using the Options window.

Enter the cable number. At a minimum, a catalogue cable must also be specified (see
below).
Enter other data, such the cable source and destination and the estimated length of the
cable as required.

Note: The actual design length of the cable can be imported from AVEVA Cable Design.
The design length can then be used to update the estimated length if required. See
below for more details.

Cable Destinations
Select the equipment at each end of the cable by clicking on the small button at the right
side of the From and To fields. The Select Equipment window is then displayed. See
Select Cable Ends.

Cable Definition from the Cable Catalogue


To select a Cable Catalogue, click on the small button at the right side of the Catalogue No:
field to display the Select a Cable from Catalogue window (see Select Catalogue Cable).
After selection of a catalogue cable, the Catalogue data is copied into the catalogue specific
data fields (shown with a yellow background) in the Cable Details window.

Cable Gland Selection


To select a cable gland double-click in either the From or To Glands fields in the Cable
Details window. This displays the Select Cable Gland window, listing of all glands that can
fit the current catalogue cable based on cable Outside Diameter and gland minimum and
maximum diameter. See Assign Cable Glands.

Cable Gland Adapter Selection


To select a cable gland adapter double-click in either the From or To Adapter fields in the
Cable Details window. This displays the Select Cable Gland Adapter window which lists of
all gland adapters that can fit the current cable gland based on gland connection thread.
See Assign Cable Gland Adaptors.

AVEVA Cable Design Interface


Cable design data, including the design length of cables in AVEVA Cable Design, can be
imported and displayed this section. Refer to AVEVA Cable Design Data Interface.
Once the import has taken place, the Design Length and Cable Free Length fields are
completed and the Route Path field may be updated as appropriate.

Note: Once imported, the design length can be used to update the estimated length of the
cable if required. Refer to Update Estimated Cable Lengths with Design Lengths for
details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

If the cable is routed in E3D, details of the nodes the cable route passes through can be
viewed by clicking Route Path. The Cable Route Node List window is then displayed:

Create Multiple Cables


The window can be used to create multiple cables, for example to represent a single power
multi-core cable, e.g. three single core cables instead of one three-core cable, or multiple
multi-core cables representing a main cable and its protective and neutral cables.
When a catalogue cable is selected, additional fields are displayed in the window:

Select the number of additional cables to be created from the Number of Cables list. When
the new cable is saved, that number of additional “child” cables, identical to the parent cable
are created automatically.
If child cables have been specified, when the cable is saved, the Child Cable Numbering
Options window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The Apply change to child cables checkbox is only relevant when editing existing parent
cables and is disabled when creating new cables. Refer to Edit Project Cable Data for
details.
If the Add suffix to parent checkbox is checked (the default setting), the number of the
parent cable will automatically be suffixed with “1”. The numbers of child cables will be the
number of the parent cable suffixed with “2”, “3” etc.
If the checkbox is not checked, a suffix is not added. The first child cable will instead be the
parent cable number suffixed with “1”, and additional child cables suffixed with“2”, “3” etc.
If there is to be a delimiter between the cable number and the suffix, select or enter it in the
Choose Delimiter to suffix field.
The Existing Cable Number displays the parent cable number as entered in the Cable
Details window. It may be edited in this field is required.
The New Cable Number field displays what the parent cable number will be once any
changes specified in the Child Cable Numbering Options window are applied.
Click OK when the required cable number options have been specified. The parent and
child cables are then created and numbered as specified.

Note: The numbers of all parent and child cables in the cable schedule can subsequently
be bulk edited. Refer to Bulk Edit Parent and Child Cable Numbers for details.

Other Data
Other cable data can be entered on the Other Data tab.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Sizing data is not relevant to AVEVA Instrumentation.

Cable Core Data


The cable's cores (and their core types) can be viewed (once a catalogue cable has been
selected) on the View Cores tab.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: Deleting a cable automatically disconnects all its cores.

Freeze a Cable
If a cable is “frozen” it cannot be edited either in AVEVA Instrumentation, or in E3D (Cable
Design). Its routing status is set to “Frozen”.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To freeze a cable check the Frozen checkbox.

Note: Cables can also be frozen (and unfrozen) in bulk. Refer to Bulk Freeze and Unfreeze
Cables for details.

Note: Cables on locked drums (refer to Cable Drums for details) cannot be frozen or
unfrozen.

If a cable is frozen, when a user opens the Cable Details window for that cable, a message
is first displayed warning that the cable is frozen and cannot be edited. The window then
opens, but the OK and Apply buttons are disabled meaning that no changes can be saved.
To unfreeze a cable, uncheck the Frozen checkbox. The OK and Apply buttons are then
enabled.

6.3 Select Catalogue Cable


By basing all cables on standard predefined catalogue cables Wiring Manager is enforces
data integrity by ensuring all cables using the same catalogue number are identical in
physical properties such as number or cores, core markings, screen/shield configuration,
diameter etc.
The Select a Cable from Catalogue window is used to select a catalogue cable definition
for any project cable. It is accessed by clicking the button in the Catalogue No: field on the
Cable Details window, or by selecting Change Catalogue No. for selected Cables in the
Tools section of the List Tools - Cable Schedule tab.

Note: Only those cables in the Cable Catalogue that have been marked with 'Allow Use'
are shown in this selection list. 'Allow Use' pre-filters the catalogue cables that can
be used for the current project. Refer to Cable Catalogue for more information.

Select a Cable from the Cable Catalogue


Either, double-click on the desired cable, or click on the desired cable record and click
Select.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Once the cable is selected, all cores with their predefined markings are created in the
database by copying the catalogue cable definition from the Cable Catalogue.
Users may filter the cable catalogue by using any combination of column filters: Class,
Manufacturer, Type, No. of cores, core size, armoured, Shields/Screen requirements etc..
Wiring Manager will remember the last selection throughout the current Wiring Manager
session.

6.4 Select Cable Ends


To define an end (from or to / source or destination) for a cable, in the Cable Detail window,
click on the button in the From or To field.
Or, in the Cable Schedule grid, click on the buttons that are displayed when the mouse is
hovered over the From or To cells, and select the Change ‘From/To’ Equipment option
from the Options window that is then displayed.

The Select Equipment window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To select an equipment tag, double-click on the required tag, or click on it and then click
Select. The window is then closed and the number of the specified equipment is displayed
in the cell.

Note: The maximum number of cables that may be connected to an equipment item (or
equipment catalogue item) may (optionally) be specified on the More Information
window accessed from the Equipment Layout window. If the user attempts to
connect a cable when the maximum number of cables has already been connected
to an equipment item, a message is displayed to inform the user of this. For example:

To create a new equipment tag, select New. The Equipment Information window is then
displayed. Create the new equipment as described in Create New Equipment. The new
equipment is then added to the list in the Select Equipment window.
To exit the window without selecting destination equipment, or to de-select destination
equipment previously selected so that the other end of the cable is no longer connected,
click Not Connected.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

6.4.1 Create New Equipment


When selecting equipment for cable ends, new equipment can be created by clicking the
New button on the Select Equipment window.
The Equipment Information window is then displayed:

Specify the Plant Area No and Equipment Type.


If Field Device is selected from the Equipment Type list, click the button next to the list,
which then becomes enabled. The Equipment Tag window is then displayed. Complete it
as described in Add Field Devices.
If any other equipment type is selected, enter the equipment number in the Equipment No.
field.
All other fields are optional. On saving, Wiring Manager will check that the Equipment No. is
unique for the project.
Many of the fields in these windows may be completed by copying data from the Major
Equipment Catalogue. This facility is accessed using the From Catalogue button, as
described below.
The Termination Drawing Required checkbox enables the equipment to be registered with
the AVEVA Instrumentation Designer's Drawing List, so that a CAD termination drawing can
be created for the equipment's terminations.
The Signal Class Applies and Signal Service Applies checkboxes are for reference
purposes only. There is no limit to the cables or field devices that can be assigned or
terminated to/at the equipment. They can be used, for example, to help the designer or
engineer flag analog signals to be used in the equipment.
If the equipment is to be shared with AVEVA Electrical, click Share the Equipment with
Electrical.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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.

Note: Equipment shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.

Click Save to save the new equipment tag.

Copying Equipment from the Major Equipment Catalogue


Prior to saving, a standard equipment configuration can be copied to the equipment from
those defined in the Major Equipment Catalogue.
Click the From Catalogue button. The Select Equipment window is then displayed:

To select a catalogue equipment, double-click on the equipment record or select the


equipment record and click Select.
New equipment created from catalogue equipment will contain the terminal strips and
terminals (including terminal markings) of the selected catalogue equipment. (after the Save
button is clicked in the original Equipment detail window).

6.5 Copying Cables


Any existing cable can be copied by selecting the cable to copy in the Cable Schedule then
clicking the pull-down menu button next to the New button on the Home tab, and clicking on
the Copy Selected command. The Cable Details window is then displayed, completed with
details of the copied cable. Change the Cable Number (which must be unique in the

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

project), and other details as required (see Edit Project Cable Data).
Cables (and their terminations) may also be copied using the Copy (with 'From' cables)
option on the Equipment View right-click menu. See Copy Equipment with Cables and
Terminations for details.
If a parent cable is copied a message asking whether or not its child cables are also to be
copied is displayed, for example:

Click Yes if copies of the child cables are also required or No if only the parent cable is to be
copied.

6.6 Edit Project Cable Data


To edit an existing cable, open the Cable Schedule and then select the cable record and
click Edit in the Records section of the Home tab, or double-click on the cable record.
The Cable Details window is then displayed.

Note: If more than one cable is selected when the Edit option is clicked, Wiring Manager
asks if a 'Bulk Edit' is required. This enables the editing of multiple cables at a time.
See Bulk Edit Cables.

Note: Cable details can also be accessed for editing from the Cable Block Diagrams
application.

Note: If a cable is on a locked drum (refer to Cable Drums for details), it cannot be edited.
The OK and Apply buttons are disabled on Cable Details window the meaning that
no changes can be saved.

Note: If a cable is frozen, when a user opens the Cable Details window for that cable, a
message is first displayed warning that the cable is frozen and cannot be edited. The
window then opens, but the OK and Apply buttons are disabled meaning that no
changes can be saved.
To unfreeze a cable, uncheck the Frozen checkbox. The OK and Apply buttons are
then enabled.
Cables on locked drums (see above) cannot be frozen or unfrozen.

Note: If a “child” cable is selected for editing (see Create Multiple Cables), the following
message is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Yes to open the Cable Details window for the parent cable.
Click No to open the Cable Details window for the child cable. Child cable details can
be viewed but not edited.
Note: The numbers of all parent and child cables in the cable schedule can be bulk edited.
Refer to Bulk Edit Parent and Child Cable Numbers for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

For information on the implications of changing a cables catalogue cable, see below.
For information on the implications of changing the cable number of “parent” cable, i.e. a
cable with “child cables”, see below.
For details of how to complete or amend other cable details, refer to Create a New Project
Cable.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To view a cable's terminations, click View Terminations. A preview terminations report for
the cable is then displayed. Refer to Termination Reports for details.

Change a Cable's Catalogue Cable


Users can change a project cables definition by selecting a new catalogue cable from the
Cable Catalogue. If a cable has its catalogue cable changed, when saved the cable's cores
are automatically updated:
• All existing core are re-aligned to the new cables core type and core markings.
• Any additional cores are added to the cable (e.g. change from a 1 pair to a 2 pair) and
all core terminations are retained.
• Any surplus cores are removed (e.g. change a 12 pair to a 8 pair). All terminations are
retained, except for cores that are being removed.
• If the cable type changes (e.g. change a 2 core + E to 1 pair OAS), cores are aligned
based on core type (valid core types in Wiring Manager are C - cored, E - Earth, OAS -
Overall Screen or Shield, S - Group or Individual Screen or Shield). For the example
given: old core 1 becomes new core 1 since core types are the same and termination is
retained, old core 2 becomes new core 2 and termination is retained. The Earth core is
deleted, since it does not match the core type of OAS. A new core is added for the
OAS.
Note: If a catalogue definition is changed in the Cable Catalogue all the project instances
are changed to the new definition.

Change the Cable Number of a “Parent” Cable


If the cable number of a parent cable is changed, when the cable is saved the Child Cable
Numbering Options window is displayed:

If the changes made to the parent cable number are also to be applied to the child cable
numbers, check the Apply change to child cables checkbox.
For details of the other options in this window, refer to Create a New Project Cable.

6.6.1 Bulk Edit Cables


Some data for multiple cables can be edited at the same time.
In the Cable Schedule grid, select the multiple cable records, then click Edit in the Records
section of the Home tab. A message is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: Frozen cables, and cables on locked drums cannot be edited. Changes will not be
saved to such cables. A message is displayed to inform users of this.

Click Yes.
If a “child” cable is selected for editing (see Create Multiple Cables), a message is displayed
to inform the user of this and the procedure is cancelled.
Otherwise the Multi Field Edit (Bulk Edit) window is then displayed:

Check the Select checkbox for all columns to be edited.


Enter the new values required in the Value columns.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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

6.6.2 Bulk Edit Parent and Child Cable Numbers


The cable numbers of child cables and their parent cables can be edited in bulk. Suffixes
can be added to child cable numbers, and optionally to the numbers of their parent cables.
With the Cable Schedule grid open, select Bulk Update Child Cable No in the Actions
section of the List Tools - Cable Schedule tab.
The Bulk Update Child Cable Numbers window is then displayed:

The window lists all the parent cables in the grid. If a parent cable number and the numbers
of its child cables are to be edited, check its Select checkbox.
If the suffix is to be added to parent cable number as well as the child numbers, check the
appropriate Add Suffix To Parent checkbox.
If a delimiter is required between the numbers and the suffix, enter it in the Choose
Delimiter To Suffix field.
Click OK.The windows then exits and the renumbering takes place.
If the Add Suffix To Parent checkbox was checked, the number of the parent cable will be
suffixed with “1”. The numbers of child cables will be the number of the parent cable suffixed
with “2”, “3” etc.
If the checkbox was not checked, a suffix is not added. The first child cable will instead be
the parent cable number suffixed with “1”, and additional child cables suffixed with“2”, “3”
etc.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

6.6.3 Bulk Update Cable Installation Method


The installation methods of cables imported from ETAP (using AVEVA Electrical) can be
changed in bulk.
Select the cables in the Cable Schedule grid, then select Bulk Update Installation Method
in the Actions section of the List Tools - Cable Schedule tab.
The Bulk Update Installation Method window is then displayed:

The left-hand panel displays the selected ETAP sourced cables grouped under their current
installation methods and sizing standards. Only cables imported from ETAP will be listed. If
other cables were selected in the grid, they will not be listed.
The right-hand panel displays all the available installation methods grouped by sizing
standard.
To change the installation method of a cable, drag it from the left-hand panel and drop it on
the required method in the right-hand panel.
The new method must be of the same sizing standard. Otherwise the following message is
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

If a valid installation method is selected, the listing of cables and their method in the left-
hand panel is updated to reflect this change. Cables that have had their installation method
changed are listed in italics.
Multiple cables with the same current installation method can be selected at the same time
by Shift-clicking or Ctrl-clicking, and then dragged and dropped onto a different installation
method as described above.
Repeat the above procedure for each cable that requires a different installation method.
Click OK to save the changes and close the window.

6.7 Delete Cables


Delete cables by selecting them from the Cable Schedule grid, then click Delete in the
Records section of the Home tab. Multiple cables may be selected for deletion.
If a single cable is selected:
• If that cable is frozen or on a locked drum, a message is displayed to inform the user
that the cable cannot be deleted.
• If the cable can be deleted, a message is then displayed requesting that the deletion of
the selected cable(s) be confirm. Click Yes to continue.
If multiple cables are selected, a message is displayed requested that the user confirm that
these cables are to be deleted. Click Yes to continue.
A message is displayed to inform the user that frozen cables and cables on locked drums
cannot be deleted. Click OK. The cables that can be deleted are then deleted.

Note: Deleting a cable automatically disconnects all its cores.

A child cable (see Create Multiple Cables) cannot be deleted without also deleting its parent
cable and vice versa. If a parent of child cable is selected for deletion a message is
displayed to inform the user of this:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Yes to delete the entire group of cables, or No to cancel the deletion.
To remove a child cable without deleting the parent cable, reduce the number of child cables
that the parent cable has in the Number of Cables field of the Cable Details window.

6.8 Change Cable Definitions


In Wiring Manager, all project cables are based on a cable catalogue definition. This
ensures that project cable properties (size, number of cores, core markings, type etc.) are
consistent with a 'real' cable.
Users can reassign another catalogue cable to any project cable at any time. This changes
the project cable to have the properties (size, number of cores, core markings, type etc.) of
the newly assigned catalogue cable, keeping current terminations for the original cable.
After a cable has been created (and/or terminated), users may change a cable's definition
on a cable by cable basis by using the Cable Details window. However, in case multiple
cables need to be changed then Wiring Manager provides a facility for a 'batch' update of
cable definitions.
To change the assigned cable catalogue for multiple cables, from the Cable Schedule grid,
select each cable record that is to be updated, then select Change Catalogue No. for
selected Cables in the Tools section of the List Tools - Cable Schedule tab.
This displays the Select a Cable from Catalogue window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: Only those cables in the Cable Catalogue that have been marked with 'Allow Use'
are shown in this selection list. 'Allow Use' pre-filters the catalogue cables that can
be used for the current project. Refer to Cable Catalogue for more information.

To select a new cable type from the Cable Catalogue, either double-click on the desired
cable or select the desired catalogue cable record and click Select.
The new Catalogue Cable definition will be applied to the selected cables in the Cable
Schedule.

Note: Frozen cables, and cables on locked drums cannot be edited. Changes will not be
saved to such cables. A message is displayed to inform users of this.

Selecting a new Catalogue definition will automatically update the Cable Schedule and each
cables terminations (if any) including changing core markings:
• All existing core are re-aligned to the new cables core type and core markings.
• Any additional cores are added to the cable (e.g. change from a 1 pair to a 2 pair) and
all core terminations are retained.
• Any surplus cores are removed (e.g. change a 12 pair to a 8 pair). All terminations are
retained, except for cores that are being removed.
• If the cable type changes (e.g. change a 2 core + E to 1 pair OAS), cores are aligned
based on core type (valid core types in Wiring Manager are C - cored, E - Earth, OAS -
Overall Screen or Shield, S - Group or Individual Screen or Shield). For the example
given: old core 1 becomes new core 1 since core types are the same and termination is
retained, old core 2 becomes new core 2 and termination is retained. The Earth core is
deleted, since it doesn't match the core type of OAS. A new core is added for the OAS.
Note: If a catalogue definition is changed in the Cable Catalogue all the project instances
are changed to the new definition automatically ensuring design integrity.

6.9 Assign Cable Glands


To assign a cable gland to a project cable, either double-click in the From or To Glands
fields in the Cable Details window, or in the Cable Schedule grid, click the buttons that are
displayed when the mouse is hovered over those fields.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The Select Cable Gland window is then displayed.

The window displays a list of all glands that can fit the current catalogue cable based on
cable Outside Diameter and gland minimum and maximum diameter (a catalogue cable
must therefore be assigned before glands are assigned).
The current cable details are shown in the top text boxes (yellow background).
Wiring Manager filters the cable glands by checking whether the cable outside diameter
(Cable OD) defined in the cable catalogue fits within the minimum and maximum OD values
in the gland catalogue properties. Wiring Manager also checks the 'Armoured' flag of the
cable type with that of the gland (i.e. Armoured cables use Armoured glands and vice
versa).

Note: Cable Glands are added to a project and edited using the Cable Gland Catalogue
grid. Only glands from the Cable Gland Catalogue with 'Allow Use' set will be listed.

To select a Cable Gland, double-click on the cable gland record. or select the cable gland
record, then click Select.
To assign a selected Cable Gland to all cables with the same Cable Catalogue Number,
check the Apply to All cables with this Catalogue Number checkbox before selecting the
required gland.

6.10 Assign Cable Gland Adaptors


To assign a cable gland adaptor to a project cable, either double-click in the From or To
Adapter fields in the Cable Details window, or in the Cable Schedule grid, click the buttons
that are displayed when the mouse is hovered over those fields.
The Select Cable Gland Adapter window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

This displays a list of all gland adapters that can fit the current cable gland based on gland
connection thread (a cable gland must therefore be assigned before adapters are
assigned).
The current gland details are shown in the top text boxes (yellow background).

Note: Cable Gland Adaptors are added to a project and edited using the Cable Gland
Adapter Catalogue grid. Only gland adaptors from the Cable Gland Adaptor
Catalogue with 'Allow Use' set are listed.

To select a Cable Gland Adaptor, double-click on the adaptor record, or select the adaptor
record, then click Select.
To assign a selected Cable Gland to all glands with the same Gland Catalogue Number,
check the Apply to All cables with this Catalogue Number checkbox before selecting the
required adapter.

6.11 Merge Cables


Multiple cables can be merged into one.
Only cables that have same source (From) and destinations (To) in the cable schedule and
have the same basic core groupings type (cores, pairs, triads or quads) can be merged.
To merge cables, open the Cable Schedule grid and from the List Tools - Cable Schedule
tab, click Merge Cables in the Tools section.
If there are no cables suitable for merging in the grid, the following message is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

If there are cables that can be merged, the Merge Cables window is displayed:

The window lists all the source (From) and destinations (To) combinations of cables that can
be merged.
Click on the + symbol next to a source and destination row. The cables that can be merged
that share that source and destination combination are then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: Cables that are frozen or that are on a locked drum are not listed.

To select cables for merging, click their Select checkboxes. At least two cables that share a
source and destination combination must be selected.
When all required selections have taken place, click Merge.
All selected cables that share a source and destination combination are then merged.
The number of a merged cable will be that of the first selected cable within a source and
destination combination. For example, if the two cables listed in the screen example above
are merged, the merged cable number will be FD-11. Cable FD-12 will be deleted.

6.12 Import Cables from Excel


Wiring Manager supports importing of Cables into the Wiring Manager Cable Schedule from
an Excel spreadsheet. New cables can be imported, and existing cables updated in this
way.

Note: Cables that are frozen or that are on a locked drum cannot be updated.

To import Cables the Excel file must contain the following information at a minimum: Cable
No, Cable Catalogue No and 'From' and 'To' end equipment tags.
Since Wiring Manager Cables have several user properties (including user defined property
fields) users can also import additional data such as Length, Remarks, Notes into those
cable property fields by including that data in the Excel file being imported.

Important: Cables cannot be imported unless the Cable Catalogue Number (its catalogue
definition) already exists in the Wiring Manager Cable Catalogue since the
catalogue defines physical properties such as the core arrangement (number of

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

cores, pairs etc. including shielding, core size, core markings/colours etc.). In
addition a cable cannot be imported if its 'From' and 'To' end Equipment
Numbers/Tag Nos do not exist in the Wiring Manager Equipment List.

Prior to importing, the Excel Worksheet must be in a simple tabular format (columns and
rows) and the first row should contain unique column names (headings) so that Wiring
Manager can identify the column's data to enable 'mapping' to Wiring Manager database
fields. The column names are user definable but must not be duplicated. Wiring Manager
will only import column data that contains a heading, furthermore, the Excel file must contain
the following mandatory columns/data: Cable No, Cable Catalogue No, From and To.
Once an Excel Worksheet is formatted accordingly and selected for import, users must
'map' each Excel column name (heading) to an Wiring Manager database field using the
Wiring Manager import utility. Then data can be imported into Wiring Manager. The import
utility will check if mandatory columns exists in the Excel file and Mappings. While
processing cables to be imported, if a Cable No. already exists in the database Wiring
Manager will show the differences between the imported data and the Wiring Manager data,
allowing the user to accept/reject the proposed changes on a record by record (and field by
field) basis. If the Cable does not exist in Wiring Manager and the user accepts to import,
Wiring Manager will create a new cable in the cable schedule including all its Catalogue
properties including core configuration and core markings/colours based on the Catalogue
No specified in the Excel data.

Import Excel Cable Schedule Data


Open the Cable Schedule and click From Excel in the Import section of the Manage tab.
This displays the Cable Schedule Import window as shown below:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Browse and locate the Excel Workbook file.


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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

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

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

Define a New Mapping Definition


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Once the name and description for the mapping has been entered, click Save and the
mappings will be saved and added to the Saved Mappings drop down.
Data can also be imported by just clicking on the Import button. However it may save time
to save the mappings if an import with those mappings is to be performed again.

Import the Data


Once the mappings have been set up, click Next >.
The import wizard will perform data validation for the cables/data found in the Excel file. If
there are any issues with the data validation, for example a Catalogue Number in the Excel
data does not exist in Wiring Manager, then the next wizard screen will show a list of issues.
If there are no issues, the wizard will show a list of valid cables ready for import:

Select the cables to be imported by clicking their Select checkboxes (Use the Select all
checkbox if required), click Next.
The import wizard will perform data validation for the cable ends ('From' and 'To') as defined
in the Excel file. If there are any issues with the data validation, for example an Equipment
Number in the Excel data does not exist in Wiring Manager, then the next wizard screen will
show a list of issues. If there are no issues the wizard will show a list of valid cables ready
for import once again.
Click Import.
The import wizard will then add any new Cables to the project, and update any existing
cables as required.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

6.13 AVEVA Cable Design Data Interface


The design length of cables can be imported from AVEVA Cable Design (from E3D
projects), for comparison purposes with the lengths of cables as recorded in Wiring
Manager. The design lengths can be used to update the estimate lengths of cables if
required (see Update Estimated Cable Lengths with Design Lengths).

Note: Cables lengths and other cable data can also be transferred from E3D using the
AVEVA Integration and the Compare/Update Facility. Refer to the AVEV
Instrumentation Common Functionality guide for details of this facility.

Route data is also transferred between E3D and Instrumentation: cable start and end data is
exported to E3D. From this the route of a cable can be established in E3D. This route data,
i.e. the cable way node points that a cable passes through is transferred back to
Instrumentation for information purposes.
As well as length and route data, cable status data is also passed between E3D and
Instrumentation, in both directions. The status of a cable indicates whether or not a cable
has been routed, drummed, drummed and locked, frozen, and whether the route needs to
be checked.
The full list of route statuses is as follows:
• 0 - Un-routed
• 1 - Routed
• 2 - Routing Failed
• 3 - Partially Routed
• 4 - Partially Failed
• 5 - Manually Routed
• 6 - Drummed
• 7 - Drummed Locked
• 8 - Check Route
• 9 - Cable Frozen
Design data can either be transferred for individual cables, or in bulk for multiple cables.

Note: Cables that are frozen or that are on a locked drum cannot be updated.

6.13.1 Cable Design Import Configuration


Before design data can be imported, the source of the import, whether or not the imported
lengths are to include excesses, and the route node delimiter must be specified.
On the Project tab, click Setup, then AVEVA Cable Design Import Configuration. The
AVEVA Cable Design Import window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Select the version of AVEVA Cable Design from which data is to be imported.
Select the delimiter used to separate route nodes when route data is displayed in
Instrumentation, e.g. “NewLine” or a character.
If cable excesses are to be excluded from imports, click the Total Length of Cable
Excluding Excesses button. If excesses are to be included, click the Total Length of
Cable button.
Click OK.

6.13.2 Import the Design Data for Multiple Cables


Open the Cable Schedule grid and click AVEVA Cable Design Import in the Integration
section of the Manage tab.
If the user has not previously logged-on to a AVEVA Cable Design database during the
current session, the AVEVA Cable Design Login window is then displayed:

Enter the identifiers of the project and project database from which lengths are to be
imported, and a valid username and password. Click OK to connect to the selected
database.
Only those databases that are of the AVEVA Cable Design version selected in the
configuration dialog may be connected to. Refer to Cable Design Import Configuration.
If the user has previously logged-on to a AVEVA Cable Design database during the current
session, the dialog is not displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The cable data in the database is then examined and compared to that in the AVEVA
Instrumentation database.
A progress bar is then displayed, followed by the results of this process:

This window shows:


• No of Cables: Which shows the number of cables in the E3D project.
• Matched AVEVA Application Cables: Shows the number of AVEVA Instrumentation
cables available in Cable Design.
• Cable Data Changed: Shows the number AVEVA Instrumentation cables available in
Cable Design that have changed.
• Cable Data Unchanged: Shows the number AVEVA Instrumentation cables available
in Cable Design that not have changed.
Cable design data may now be imported one by one or in a batch. The batch option
processes all records together then displays a differences report enabling the user to accept
or reject each change for each cable. The one by one option displays a differences report
for each cable record, one at a time.
Click either Process one by one or Batch process all as required.
AVEVA Instrumentation then process the data and show any differences in the Import
Cable Lengths Differences window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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.

If the one by one option was selected, the differences for a single cable are listed. If the
batch option was selected, differences for all cables are displayed.
The left-hand pane lists the cable or cables and displays the cable number in AVEVA
Instrumentation, the cable number in AVEVA Cable Design, the cable design length of each
cable, the route nodes and the route status.
The right-hand pane displays the differences between cable data in AVEVA Instrumentation
and AVEVA Cable Design for the cable currently selected in the left-hand pane.
To accept the changes either select individual field data by clicking Accept checkbox for
each, or select the Accept All checkbox at the top of this window (all individual records will
be autoselected).
To import the checked (accepted) data, click Save.
If the one by one import option was selected, the window then displays the differences for
the next cable record, if there is one.
To cancel any import for the current tag record, click Close.
If the one by one import option was selected, the window then displays the differences for
the next cable record, if there is one.

Note: To cancel all further importing click Stop Import.

After the import is complete, a log of the imported document details is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Close the exit the import wizard.


The design lengths of the cables are then displayed in the Design Length field on the Other
Data tab of the Cable Details window.

6.13.3 Import the Design Data of Single Cables


To import the design length and other design data for a single cable, from the Cable
Schedule, select the cable record then, click Edit or double-click on it. The Cable Details
window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To import the design data of the cable from AVEVA Cable Design, click the button next to the
Design Length field.
If the user has not previously logged-on to a AVEVA Cable Design database during the
current session, the AVEVA Cable Design Login window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Enter the identifiers of the project and project database from which the data is to be
imported, and a valid username and password. Click OK to connect to the selected
database.
Only those databases that are of the AVEVA Cable Design version selected in the
configuration dialog may be connected to. Refer to Cable Design Import Configuration.
If the user has previously logged-on to a AVEVA Cable Design database during the current
session, the window is not displayed.
If the cable data in AVEVA Cable Design does not match that in AVEVA Instrumentation, the
differences are displayed in the Import Cable Lengths Differences window:

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

The left-hand pane displays the cable number in AVEVA Instrumentation, the cable number
in AVEVA Cable Design and the cable design length of the cable.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The right-hand pane displays the differences between cable data in AVEVA Instrumentation
and AVEVA Cable Design.
To accept the changes click either the Accept checkbox, or select the Accept All checkbox
at the top of this window.
To import the data, click Save.
The import then takes place.
If there are no difference between the cable data in AVEVA Instrumentation and AVEVA
Cable Design the Import Cable Lengths Differences window is not displayed and the
import takes place immediately.
Once the import is complete, the design length of the cable is displayed in the Design
Length field.

6.13.4 Update Estimated Cable Lengths with Design Lengths


The estimate lengths of cables as entered in Instrumentation can be updated with the
design lengths imported from AVEVA Cable Design (as described in AVEVA Cable Design
Data Interface).
Click Update Estimated Length from the Tools section of the List Tools - Cable Schedule
tab. The Update Estimated Length window is then displayed

The window lists all cables that have been routed and have different estimated and design
lengths. These lengths are displayed in the window.
Select which cables to update by checking the appropriate Select checkboxes.
Once the cables have been selected, click Update Length. The estimated lengths of the
selected cables are then changed to their design lengths.

6.14 Bulk Freeze and Unfreeze Cables


If a cable is “frozen” it cannot be edited either in AVEVA Instrumentation, or in E3D (Cable
Design). Its routing status is set to “Frozen”.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

If a cable is frozen, when a user opens the Cable Details window for that cable, a message
is first displayed warning that the cable is frozen and cannot be edited. The window then
opens, but the OK and Apply buttons are disabled meaning that no changes can be saved.
Cables can also be frozen (and unfrozen) in individually. Refer to Freeze a Cable for details.
Cables can also be frozen and unfrozen in bulk, i.e. multiple cables can be frozen or
unfrozen at the same time.
To freeze multiple cables, select the cables in question in the Cable Schedule grid, then
click Bulk Cable Freeze from the Tools section of the List Tools - Cable Schedule tab.
To unfreeze multiple cables, select the cables in question in the Cable Schedule grid, then
click Bulk Cable Unfreeze from the Tools section of the List Tools - Cable Schedule tab.
Cables that are on a locked drum (refer to Cable Drums for details) cannot be frozen or
unfrozen. A message will be displayed to inform the user of this:

The selected cables (other than those on locked drums) are then frozen or unfrozen as
appropriate.

6.15 Change Enhanced Cable Block Diagram Cable Label


Symbols
The symbols used to represent cable labels displayed on enhanced Cable Block Diagrams
may be changed on an individual basis.
In the Cable Schedule, in the Actions section of the List Tools tab, click Change Label
Symbol.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The Symbol List window is then displayed:

The window displays all the different project symbols for cable labels (see Add or Edit Cable
Block Diagram Symbols). The Default Symbol checkbox indicates the default symbol set
for the type of item.
Select a different symbol either by double-clicking on it or clicking on it and clicking Select.
A message then confirms that the symbol for the item has been changed, and the window
exits.

6.16 Find Cable Cores Not Terminated


To get a list of all cable cores that are not yet terminated, click Fixed Reports on the Home
tab then select the Cable Cores Not Terminated option from the menu that is then
displayed. The Show Cable Cores Not Terminated window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Initially no data is displayed.


To view the cable cores not terminated, select a plant area from the Plant Area list, then
select a cable end from the At Cable End list:
To ignore Overall screens/shields from the Ignore OAS checkbox:
To ignore All screens/shields from the Ignore All Screens/Shields checkbox:

Note: These two options excludes respective screens and shields from the list.

Click Get Cables to populate the window with the list of cable cores that are not yet
terminated:

Click on the 'From' or 'To' cell command button that is displayed when the mouse cursor is
hovered over one of these cells (see above). The Terminations window is then displayed,
which is used for editing terminations. See Terminations User Interface.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

6.17 Cable Catalogue


The Cable Catalogue is used to view all catalogue cables and allows definition of
manufacturers cable properties such as catalogue number, manufacturer, cable type (cores,
pairs, triads), number of cores, pairs or triads, core markings, core size, whether the cable
has screens/shields, earth core, armoured etc., its outer diameter, weight, conductivity etc.
In AVEVA Instrumentation all project cables must be based on a catalogue cable. This
ensures that project cable properties (size, number of cores, type etc.) consistent with a
'real' cable. User can reassign another catalogue cable to any project cable at any time. This
changes the project cable to have the properties (size, number of cores, type, core markings
etc.) of the newly assigned catalogue cable, keeping current terminations for the original
cable.
To open the Cable Catalogue, click Select in the Grids and Schedules section of the
Home tab.
Select Cables from under the Catalogue heading in the list of grids that is then displayed.
The Cable Catalogue grid is then displayed:

Note: Only those cables with their AllowUse checkbox checked will be available for use
when working in the project Cable Schedule. Although the cable catalogue can hold
thousands of standard cables from various manufacturers, 'Allow' filters only specific
cables for use on the project.

For information on grid functionality refer to Working with the Data Grid topic.

6.17.1 Add Cables to the Catalogue


To add a new Cable to the project Cable Catalogue, open the Cable Catalogue grid and
click New from the Records section of the Home tab.

Note: Wiring Manager also provides facilities for importing of Catalogue Cables from
another project. Refer to Importing Catalogue Items from another Project.

The Catalogue Cable Details window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Check the Allow use on Project checkbox if the catalogue cable is to be available for use
in the project, i.e listed in the Cable Schedule etc. The checkbox is checked by default.

Note: Only those cables with their Allow use on Project checkbox checked will be
available for use when working in the project Cable Schedule. Although the cable
catalogue can hold thousands of standard cables from various manufacturers, 'Allow'
filters only specific cables for use on the project.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Cable Data Tab

Class Used to help segregate cables in the Catalogue. Valid values


include Instrument, Control, Power, Thermocouple etc.

Manufacturer/ These are used to define exact catalogue details for purchasing.
Catalogue No Catalogue number is mandatory and must be unique in the current
project.

User Code Used to enter a user part number as an alternative to the Catalogue
No for reports etc.

Cores The Cores section fields are used the define the cores/wires for a
catalogue cable.

Group Type Used to define the core grouping (Pair = 2 cores per group, Core = 1
core per group, Triad = 3 cores per group etc.).
Cannot be changed for existing cables.

No. of Cores Used to enter the total number of cores, pairs, triads etc. in this
catalogue cable.

Note: The number of cores entered may not exceed the number of
core group type markings specified in the Options window.

Core Size Used to define the core or conductor size (e.g. 1.5mm² or 12 AWG
etc.) - do not enter the units here.

Units Used to enter the core size units (mm² or AWG) - the units picklist is
populated from unique units previously saved to the catalogue.

Screens/Shields This section is used to define the screens or shields used for signal
protection for multi-core cables.

OAS/Coll/SH This checkbox is used to specify whether or not the entire cable a
single Overall Screen/Shield (Collective Outer Screen).

Group/Indiv This checkbox is used to specify whether or not each group (i.e.
Pair, Triad etc.) has a group screen/shield (i.e. Individually
screened).

Armoured This checkbox is used to specify whether or not steel wire


armouring is used for this catalogue cable.

Earth Core This checkbox is used to specify whether or not an additional earth
core should be included in the cable in addition to cores/shields
defined.

Earth Core Size Used to define the earth core size.

Earth Core Units Used to define the earth core size units (mm² or AWG).

Voltage Range Used to enter the insulation voltage range.

Minimum Used to enter minimum voltage.

Maximum Used to enter maximum voltage.

Insulation Type Used to select the type of insulation.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Insulation Used to enter the insulation temperature.


Temperature

Insulation Level Used to enter the insulation level.

Colour Used to enter the outer sheath colour.

Description Used to enter a user definable text description.

Share the This checkbox is used to specify whether or not the catalogue cable
Catalogue Cable is to be shared with AVEVA Electrical.
with Electrical
Note: Unless sharing with AVEVA Electrical is enabled for the
project the checkbox will be disabled. Sharing with AVEVA
Electrical may be enabled during project setup, or afterwards
(using the Project tab > Edit Project option). Refer to the
Installation User Guide for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Design Data Tab

Additional catalogue data may be entered on this tab to aid design selection.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Notable fields on this tab are:

Outside Diameter This field is used by Wiring Manager to auto-select cable glands
from the Cable Gland Catalogue.

Drum Length This field is used by Wiring Manager when auto-cable drumming.
Wiring Manager will use this value as its default drum length.
See Auto-Cable Drum.

Enhance Cable These fields are used to specify the appearance of cables using
Block Diagram the cable catalogue in Enhanced Cable Block Diagrams (see
fields Create or Edit Content of an Enhanced Cable Block Diagram).
The AutoCAD Export Linetype field list consists of the line
types defined in line type seed file selected in the Cable Line
Style Reference File (.dwg) field of the Enhanced Cable Block
Diagram Options window (Export tab). This list will be empty if no
file has been selected.

All other fields are for user reference only and are currently not used for any purpose except
reporting.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

User Fields

The 30 fields on this tab are used to entered any additional data regarding the catalogue
cable as required by the user or project.

Add a New Catalogue Cable


Enter values for all fields in the window, then click Save.
Wiring Manager will create the cable cores/wires based on the information provided using
default core markings. Users can then modify the core markings for this cable by clicking on

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

the View Cores tab. Refer to Change Cable Core Markings.

6.17.2 Edit Catalogue Cables


To edit a Catalogue Cable in the project, select the catalogue record from the Cable
Catalogue, then click Edit in the Records section of the Home tab, or double-click on the
catalogue cable record.
The Catalogue Cable Details window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

See Create a New Project Cable for details of the fields in this window.

To edit an existing Catalogue Cable


Change values any of the fields in the window as described above. Then click Save.
Wiring Manager will update the cable cores/wires based on the information provided using
core markings shown in the View Cores tab. Users can modify the core markings for this
cable by clicking on the View Cores tab. Refer to Change Cable Core Markings.

Important: Any changes that are made to the catalogue cable are also saved to any project
cables using this catalogue cable. By changing core markings, adding/removing
cores, screens/shields and/or earth cores of the catalogue cable all project
cables (using this catalogue cable) are updated to reflect the new catalogue
cable definition.

For example, changing marking '1W' to '1WH' will change the marking in project cable
instances that use this catalogue cable for every cable in the project. Or changing the
Manufacturer, Catalogue Number or other property will also change all details in the Cable
Schedule that use this Catalogue Cable.
Any additional cores will not be terminated; users will need to terminate those (if required).
Any cores removed will be disconnected prior to deletion. This is a very powerful feature of
Wiring Manager and users should take care when using it, as a single change here can
effect the whole project.

Note: The Group configuration (Pair, Triad etc.) of a cable cannot be changed once it has
been created. Users will have to create a new catalogue cable if the group type
needs to change. This does not effect project cables, where a project cable's
configuration can be changed by selecting a new catalogue cable from the Cable
Catalogue. This limitation effects editing Catalogue Cable definitions only.

6.17.3 Change Cable Core Markings


To enter or edit the cable core markings of a catalogue cable, select the catalogue record
from the Cable Catalogue, then click Edit in the Records section of the Home tab, or
double-click on the catalogue cable record.

Note: Changing the core markings of a catalogue cable will result in the core markings for
every cable in the project that is based on this catalogue cable being changed as
well.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Only data in the Marking and CoreType columns may be edited.

Note: The core type is used by Wiring Manager when creating reports and terminations
OAS = Overall screen, S = screen/shield, E = Earth wire, C = Core (i.e. normal wire -
any core that is not a shield or earth wire).

Important: Wiring Manager uses a relational database to store information then any
change to core markings for a catalogue cable effect all project cables that use
this catalogue cable. For example, changing marking '1W' to '1WH' will change

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

the first core in project cable instances that use this catalogue cable for every
cable in the project.

Note: The default cable core colours/markings and core group type markings are set for
the project using the Cable Schedule Options window. These preferences are
applied to new catalogue cable creation only.

6.17.4 Importing Catalogue Cables


Importing Catalogue Cables from another Project
Catalogue cables can be imported from another AVEVA Instrumentation project. The
procedure is identical to that for importing Fieldbus Device, Device and I/O Module
catalogue items. Refer to Importing Catalogue Items from another Project.
Importing Catalogue Cables from Excel
Catalogue cables can be imported from an Excel spreadsheet.
The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading.
The Excel file must contain an identity column containing the Catalogue Number or
Catalogue Id of each cable. It must also include Group Type, Number of Groups, Group
Screen Required, Overall Screen Required and Earth Core columns.
Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.
While processing records to be imported, if a record already exists in the database AVEVA
Instrumentation will show the differences between the imported data and the AVEVA
Instrumentation data, allowing the user to accept/reject the proposed changes on a record
by record (and field by field) basis. If the record does not exist in AVEVA Instrumentation
and the user accepts the importation of the record, AVEVA Instrumentation will create a new
record for that drawing or catalogue item.
Open the Cable Catalogue. Select From Excel in the Import section of the Manage tab.
The Cable Catalogue Import window is then opened:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Browse and select the Excel file from which data is to be imported. Click Next >.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Defining a New Mapping Definition


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

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

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

Importing the Data


Once the mappings have been set up, click Next >.
A list of catalogue items in the spreadsheet that will not be imported because they are
invalid in some way in then displayed, along with the reason that they are invalid:

Click Next >.


A list of catalogue items which can be imported is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To import a catalogue cable, check its Select checkbox. Check the Select all checkbox to
check all the Select checkboxes.
Click Next >.
The selected list of valid catalogue cables is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Close the exit the import wizard.

6.18 Cable Glands and Cable Gland Adapters Catalogues


The cable glands and cable gland adaptors that are assigned to cables are stored in project
catalogues. For details, refer to:
• Cable Gland Catalogue
• Cable Gland Adapter Catalogue

6.18.1 Cable Gland Catalogue


The Cable Gland Catalogue is used to view and edit all catalogue Cable Glands and allows
definition of manufacturers gland properties such as catalogue number, manufacturer,
material, thread, minimum and maximum size, whether suitable for armoured cables etc.
To open the Cable Gland Catalogue, click Select in the Grids and Schedules section of the
Home tab.
Select Cable Glands from the list of grids that is then displayed. The Cable Gland
Catalogue grid is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: Only those cable glands with their Allow column checkbox checked will be available
for use when working in the project. Although the cable gland catalogue can hold
thousands of standard glands from various manufacturers, 'Allow' filters only specific
glands for use on the project.

For information on Grid functionality refer to Working with the Data Grid.
To create a new catalogue cable gland, open the Cable Gland Catalogue grid and click New
from the Records section of the Home tab.
The Cable Gland Detail window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Enter the required details are click OK or Apply.


Make sure the Allow use on Project checkbox is checked if the gland is to be available for
selection in the project.
The Share the Cable Gland Details with AVEVA Electrical checkbox is used to specify
whether or not the catalogue cable gland is to be shared with AVEVA 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.

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

To edit cable gland details, open the Cable Gland Catalogue grid, select the gland record
from the grid and either click Edit from the Records section of the Home tab, or double-
click on the record.
The Cable Gland Detail window is then displayed. Edit the details are required.

6.18.2 Cable Gland Adapter Catalogue


The Cable Gland Adapter Catalogue is used to view and edit all catalogue Cable Gland
Adapters and allows definition of manufacturers adapter properties such as catalogue
number, thread, material etc.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To open the Cable Gland Adapter Catalogue, click Select in the Grids and Schedules
section of the Home tab.
Select Cable Gland Adapters from the list of grids that is then displayed. The Cable Gland
Adapter Catalogue grid is then displayed:

Note: Only those cable gland adapters with their Allow column checkbox will be available
for use when working in the project. Although the cable gland adapter catalogue can
hold thousands of standard adapters from various manufacturers, 'Allow' filters only
specific adapters for use on the project.

For information on Grid functionality refer to Working with the Data Grid.
To create a new catalogue cable gland adapter, open the Cable Gland Adapter Catalogue
grid and click New from the Records section of the Home tab.
The Gland Adapter Detail window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Enter the required details are click OK or Apply.


Make sure the Allow use on Project checkbox is checked if the gland adapter is to be
available for selection in the project.
The Share the Cable Gland Adapter with AVEVA Electrical checkbox is used to specify
whether or not the catalogue cable gland adapter is to be shared with AVEVA 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.

Note: Cable gland adapters can also be imported from Excel. For a description of this
functionality, refer to the Common Functionality User Guide.

To edit cable gland adapter details, open the Cable Gland Adapter Catalogue grid, select
the adapter record from the grid and either click Edit from the Records section of the Home
tab, or double-click on the record.
The Gland Adapter Detail window is then displayed. Edit the details are required.

6.19 Cable Drums


Wiring Manager supports cable drumming (the assignment of cables to cable drums).
Project cable drums can be created, edited and viewed from the Cable Drum Schedule.
Cables can be created and edited “manually” (see Create Cable Drums Manually), or by
importing them from an Excel spreadsheet (see Importing Cables Drums from Excel). As
part of these processes, cables can be assigned to the drums.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Wiring Manager also includes an auto-drumming facility (see Auto-Cable Drum). Using this
facility, cables can be automatically assigned to drums using an algorithm to minimise any
unused cable based on each cable's length and the catalogue drum length. New drums may
be created as part of this process if they are required.
Individual cables may also be assigned to existing drums from the Cable Schedule. See
Assign Cables to Drums from the Cable Schedule.

6.19.1 Cable Drum Schedule


To view the project's Cable Drums, click Select in the Grids and Schedules section of the
Home tab.
Select Cable Drum Schedule from the list of grids that is then displayed. The Cable Drum
Schedule grid is then displayed:

Cable drums can be created automatically, using the Auto-Cable Drum facility, or manually
(refer to Create Cable Drums Manually).
When Wiring Manager auto-cable drums cables, it assigns unique names to the generated
drums. These can be changed in the grid.

Cable Drum Schedule - List Tools Options


The following options are located on the List Tools - Cable Drum Schedule tab:

Actions Section

Bulk Drum Lock Used to lock multiple drums selected in the grid. Refer to Bulk Lock
and Unlock Drums for details.

Bulk Drum Used to unlock multiple drums selected in the grid. Refer to Bulk
Unlock Lock and Unlock Drums for details.

6.19.2 Create Cable Drums Manually


To create a drum manually, open the Cable Drum Schedule grid and click New from the
Records section of the Home tab.
The Cable Drum Detail window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Enter a drum number, description etc.


Select a catalogue cable by clicking the button in the Catalogue No field. The Select a
Cable from Catalogue window is then displayed. Refer to Select Catalogue Cable for
details. The drum length and other details are derived from the selected catalogue cable.
Before cables can be assigned to the drum, it must first be saved. Click Apply (or click OK
to save and exit the window, if cable assignment is to take place later).
Once a drum has been saved, the View Cables button becomes available:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Note: The Last Edit field displays the date and time when the item 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 equipment data.

Assign Cables to a Drum


To assign cables to the drum, or to change the assignment of cables to drum, click View
Cables.
The Cables on Cable Drum window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To add a cable to the drum, click Add.


In the Select a Cable to add to Cable Drum window that is then displayed, double-click on
the cables to be added to the drum:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Once all the required drums have been added, click Exit to close the window. The selected
cables are listed in the Cables on Cable Drum window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Remove or Reassign Cables from a Drum


To remove a cable from the drum, select in it the Cables on Cable Drum window and press
the Delete key.
Users can manually reassign a cable to another drum (if one exists) by double-clicking on
the Cable No. This opens the Select Cable Drum window, which lists cable drums with the
same cable catalogue number.

Click on the required cable drum and click Select. Click Exit to close the window.

Lock or Unlock a Drum


When a drum is locked, it cannot be edited (except to unlock it). In addition, all the cables
assigned to drum cannot be edited either.
Drums can be locked and unlocked in bulk. Refer to Bulk Lock and Unlock Drums for
details.
o lock an individual drum, access the Cable Drum Detail window and check the Drum
Locked checkbox. Then click OK or Apply. The drum is then locked. All fields, controls etc..
in the Cable Drum Detail window (and in the grid) are disabled.
To unlock an individual drum, access the Cable Drum Detail window and check the Drum
Locked checkbox. Then click OK or Apply. The drum is then unlocked.

6.19.3 Importing Cables Drums from Excel


Cables drums can be imported from an Excel spreadsheet.
The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

The Excel file must contain an identity column containing the Drum Number of each cable
drum. It must also include the each drum’s associated cable catalogue. It may optionally
include (existing) cable numbers, if they are to be assigned to the drums using the import
(as drum numbers must be unique in the spreadsheet, only one cable may be assigned per
drum via the import).
Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.
While processing records to be imported, if a record already exists in the database AVEVA
Instrumentation will show the differences between the imported data and the AVEVA
Instrumentation data, allowing the user to accept/reject the proposed changes on a record
by record (and field by field) basis. If the record does not exist in AVEVA Instrumentation
and the user accepts the importation of the record, AVEVA Instrumentation will create a new
record for that item.
The Import Procedure
Open the Cable Drum Schedule. Select From Excel from the Import section of the Manage
tab.
The Cable Drum Schedule Import wizard window is then displayed:

Click Browse and select the Excel file from which data is to be imported. Click Next >.
The next window shows all the columns in the Excel spreadsheet to be imported. Select an
existing Field Mapping (if one for this Import type exists) from saved mappings list, or use

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

the automatic mappings created by AVEVA Instrumentation and make changes to these
mappings (if required).

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

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

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

Defining a New Mapping Definition


Sets of column-field mappings can be saved and re-used for future imports. Define the
required mappings as described above, then select the New command button. The

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Mapping Name and Description fields are then displayed and the New button is replaced
by a Save button.

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

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

Importing the Data


Once the mappings have been set up, click Next >.
A list of any issues found in the spreadsheet is then displayed:

A list of cable drums which can be imported is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To import a drum, check its Select checkbox. Check the Select all checkbox to check all the
Select checkboxes.
Click Next >.
The selected list of valid drums is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Click Import to proceed with the import. The import then takes place. After the import is
complete, the following is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

A log of the import is automatically generated in .csv format and opened. For example:

Click Close the exit the import wizard.

6.19.4 Auto-Cable Drum


Wiring Manager supports auto-cable drumming: the assignment of cables to cable drums
using an algorithm to minimise any unused cable based on each cable's length and the
catalogue drum length.

Note: Cables can also be added to drums when cables drums are being created or edited
(see Create Cable Drums Manually), or manually from the Cable Schedule (see
Assign Cables to Drums from the Cable Schedule).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

From the Cable Schedule grid, select the cables to be drummed.


Click Auto-Cable Drum selected Cables in the Actions section of the List Tools - Cable
Schedule tab.
Only cables with a status of New or Replace will be auto-drummed. Also, cables marked as
Vendor Supplied, or with a length of 0 will not be auto-drummed. A message is displayed to
remind users of this:

Click OK. The Auto-Cable Drumming Options window is then displayed:

The available options are:


• Allow cables already Drummed to be Reassigned: if this option is selected, Wiring
Manager may 'move' cables between drums to help minimise cable wastage.
• Allow Wiring Manager to create new Cable Drums (if needed): if this option is
selected, Wiring Manager may create enough new drums to assign all cables. If no
drums have been created then this option must be selected.
Select the required options and click Auto Drum.
Wiring Manager then analyses the selected cables and any existing drum assignments,
creates the minimum number of drums and then assigns each selected cable to a drum in
such a way as to minimise any unused cabling on each drum. New drums are added to the
Cable Drum Schedule.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

Auto remove Cables from Cable Drums


The Auto Drumming facility can also be used to remove multiple cables from a drum. Select
cables to be removed in the Cable Schedule grid, and access the Auto-Cable Drumming
Options window as described above.
Click Remove All. A message is then displayed requesting confirmation. Click OK. The
selected cables are then removed from any drums they were assigned.

Note: Cables can also be removed from drums manually. See Cable Drum Schedule.

6.19.5 Assign Cables to Drums from the Cable Schedule


Users can manually assign individual cables to drums from the Cable Schedule.
Click the button that appears in the Drum No cell for a cable when the mouse is hovered
over that cell.
This opens the Select Cable Drum window, which lists cable drums with the same cable
catalogue number.

Click on the required cable drum and click Select. Click Exit to close the window.

6.19.6 Bulk Lock and Unlock Drums


When a drum is locked, it cannot be edited (except to unlock it). In addition, all the cables
assigned to drum cannot be edited either.
Drums can be locked and unlocked individually. Refer to Lock or Unlock a Drum for details.
Drums can also be locked and unlocked in bulk, i.e. multiple drums can be locked or
unlocked at the same time.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

To lock multiple drums, select the drums in question in the Cable Drum Schedule grid, then
click Bulk Drum Lock from the Tools section of the List Tools - Cable Drum Schedule
tab.
To unlock multiple drums, select the drums in question in the Cable Drum Schedule grid,
then click Bulk Drum Unlock from the Tools section of the List Tools - Cable Drum
Schedule tab.
The selected drums are then locked or unlocked as appropriate.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cables

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

7 Terminations

Wiring Manager's Terminations window is used to create terminations and edit existing
terminations (connect/disconnect). The user can also edit terminal arrangements, terminal
markings, define terminal types, add wires, automatically add cross-patch wires, add links
and wires between terminals.
Terminations and signals may also be imported from Excel. Various reporting facilities for
terminations are available.
Continue at:
• Access the Terminations Window
• Terminations User Interface
• Create and Edit Terminations using the Terminations Window
• I/O Tag Allocations
• Import Terminations from Excel
• Import Signals from Excel
• Termination Reports
• Enhanced Termination Reports

7.1 Access the Terminations Window


Users can access the Terminations window from many places in Wiring Manager.
• In the Equipment View, double-click on any equipment node (with terminals strips, DIN
Rails, terminals, devices etc.). This displays the Terminations window showing all
terminal strips, DIN Rails, terminals, devices etc.
• In the Equipment View, double-click on any Terminal Strip or DIN Rail node. This
displays the Terminations window showing just the selected Terminal Strip or Din Rails
terminal arrangement.
• In the Cable Schedule list, click on the button that is displayed when the mouse is
hovered over the From or To cells and select the Edit Terminations from the
displayed Options window. This displays the Terminations window showing all
terminal strips, DIN Rails, terminals, devices etc.
• In the Cable Block Diagrams application, right-click on any equipment node and select
Edit Terminations from the pop-up menu.
• From the Major Equipment Catalogue, by selecting an item from the Major Equipment
Catalogue grid view, clicking Edit and selecting Edit Terminations from the displayed
Options window.
• From the Equipment Layout window, by right-clicking on a component and selecting
Edit Terminations from the menu that is then displayed, or clicking the Edit
Terminations button to edit the terminations of the equipment.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

If no terminals have been added to the equipment, a message will be displayed to inform the
user of this.
Otherwise, the Terminations window is then displayed. Refer to Terminations User
Interface for further details.

7.2 Terminations User Interface


The Terminations window may be accessed in several ways. Refer to Access the
Terminations Window.
The Terminations window is used create terminations and edit existing terminations. Users
can also edit terminal arrangements, terminal markings, terminal descriptions, define
terminal types, add wires, automatically add cross-patch wires, add links and looping wires
between terminals.

For details of the Terminations window user interface continue at:


• Main Graphics Area
• Cables to Terminate
• Cores to Terminate
• Tab Commands
• Terminals Pop-up Menu
• Terminal Descriptions Pop-up Menu
• Wire Pop-up Menu
• Devices and Wires

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

For how to use the Terminations window, refer to Create and Edit Terminations using the
Terminations Window.

7.2.1 Main Graphics Area


In the centre of the Terminations window the terminal strip is displayed, with lines
representing wires or cores on each side. Cable cores are displayed in black, wires are
displayed in blue.
Terminal markings/numbers are normally coloured black, unless they have a signal/wire
number assigned. If a terminal has a signal number it will be coloured blue.

Note: In Wiring Manager, all signal or wire numbers must belong to an equipment terminal.
Typically all field devices will have a signal or wire number added to each terminal. In
fact, signal numbers are added automatically to all field devices created with Wiring
Manager Wiring Rules.

On each wire’s outside edge the Cable Number of the core (if it is a cable core) or the wire
destination (if it is a wire) is displayed. In the centre of each wire there is more text
displaying two values. The left value is the core marking (if it is a cable core) and the right
value is the wire number or wire ferrule number (if ferrule numbers are set be displayed -
see Show Ferrule Numbers Checkbox). For wires there is a single value: the wire number.

Note: Whether or not ferrule numbers are generated for newly connected screens and
earth cores is controlled by the Generate Ferrule data for Cable Screens and/or
the Generate Ferrule data for Cable Earth Cores checkboxes on the General Tab
of the Options window.

For more information on how devices and wires are depicted in the window, refer to Devices
and Wires.

7.2.2 Cables to Terminate


This section of the Terminations window lists all project cables that are connected at the
current Equipment and that also have cores that are not terminated at this end.

Note: Cable numbers only appear in this list if the 'From' or 'To' ends in the Cable Schedule
are the current equipment number, or the current equipment is a child node of either
the 'From' or 'To' end equipment. Refer to Create Terminations across Equipment
Cabinets for more information.

7.2.3 Cores to Terminate


This section of the Terminations window lists all those cores of the currently selected cable
(from the Cables to Terminate list) that are not yet terminated. As cores are terminated, they
are removed form this list. If a core is disconnected it is added to this list ready for
termination once again. To see cores from a specific cable, click on the cable number in the
Cable to Terminate list.

Note: To add new devices and/or terminals to the current equipment use the Wiring
Manager's Equipment View window.

7.2.4 Tab Commands


The following options are available on the Wiring, Links and Tools tabs at the top of the
Terminations window:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Wiring Tab
Cables/ Add New Cable Used to create a new cable from the current
Wiring equipment. Displays the Cable Detail window
(see Create a New Project Cable). Once
saved, the new cable is added to the Cable to
Terminate list.

Cross-Patch Creates wires between terminals that have


same signal/wire numbers. Refer to Auto Cross
Patch Wiring.

Add Wiring Wizard Used to create multiple wires between


terminals using the Wiring Wizard. Refer to
Create Multiple Wires between Terminals.

Add Wire between Adds a single wire between any two selected
Selected Terminals terminals. To use this command, first select the
'From' and 'To' terminals.

Delete All Wires Deletes all wires in the current Terminations


window. This does not delete cable cores, only
internal (blue) wiring.

Show Ferrule Changes the Terminations windows display to


Numbers show each core/wire's Ferrule Number (hiding
the signal numbers). Users may toggle the
ferrule number/signal numbers on/off at any
time. Refer to Wire Numbering for more
information about signal numbers and ferrule
numbers in Wiring Manager.

Looping Add Left Looping Adds looping wires to the left side of selected
Wires Wires (Normal) terminals. Refer to Create Links and Looping
Wires.

Add Left Looping Adds long looping wires to the left side of
Wires (Long) selected terminals. Refer to Create Links and
Looping Wires.

Delete Selected Deletes a single looping wire that starts on the


Looping Wire selected terminal.

Add Right Looping Adds looping wires to the right side of selected
Wires (Normal) terminals. Refer to Create Links and Looping
Wires.

Add Right Looping Adds long looping wires to the right side of
Wires (Long) selected terminals. Refer to Create Links and
Looping Wires.

Delete All Looping Deletes all looping wires in the current window.
Wires

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Refresh Reloads the current data from the database,


saving the current terminations (and clearing
the undo list - the user will not be able to undo
any changes after refresh).

Links Tab
Add Link (Normal)
Adds links (bridges) between selected
Add Link (Left) terminals. Refer to Create Links and Looping
Wires.
Add Link (Right)

Delete Selected Deletes a single link that starts on the selected


Link Terminal.

Delete All Links Deletes all Links in the current window.

Tools Tab
Undo Undoes the last command.

Find Equipment Displays the Find Component Tag window,


used to search for a component tag number.
within the window.

Find Signal No Displays the Find Signal No. window, used to


search for a signal number within the window.

7.2.5 Terminals Pop-up Menu


Right-click on a terminal strip terminal to display the following Terminals pop-up menu:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Terminal Pop-up Menu Commands

Change Terminal Displays the Change Terminal Marking window (see Change
Marking Terminal Markings and Labels), used to change the terminal
marking (and to edit wire numbers attached to the terminal, if
any).

Link to Instrument Displays a list of tags in the Select a Tag to Link to Terminal
Tag window. See Link Instrument Tag to Terminals.

Remove Link to Removes a link to an instrument tag.


Instrument Tag

Swap Left & Right Swaps all wires on left with wires on right for selected terminals.
Connections

Disconnect Disconnects all wires on selected terminals (either on the left side
only, tight side only or both sides depending on the sub-menu
option selected). See Disconnect Wires/Cores.

Set Terminal Type Sets the terminal type to either 'Standard' (default), 'Disconnect'
or 'Fused' depending on sub-menu option selected.

Note: The terminal graphic representation changes to show the selected terminal type.
This same graphic is used when Wiring Manager creates termination reports and
when Designer generates a CAD drawing.

Set Terminal Used to set the left, right or both sides of the selected terminal as
Reservation “reserved”, depending on the sub-menu option selected. A sub-
menu option is also available to undo the reservation. See Set
Terminals as Reserved or Spare.

Set Spare Used to set the left, right or both sides of the selected terminal as
Terminals “spare”, depending on the sub-menu option selected. A sub-menu
option is also available to undo this setting. See Set Terminals as
Reserved or Spare.

Split Terminal Splits selected terminals out of current strip into a new one. This
Strip retains all connections on both sides.

Delete Terminals Enables selected terminals to be deleted, disconnecting any


terminations as well.

Select All Selects all terminals in the terminal's terminal strip.

Select By Used to select every second, third or fourth terminal, depending


on the sub-menu option selected.

DeSelect All De-selects all terminals in terminal's terminal strip.

Field Device Terminations and Labels Pop-up Menus


If a user right-clicks on a Field Device terminal the Field Device Terminations pop-up menu
is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Change Terminal Displays the Change Terminal Marking window (see Change
Marking Terminal Markings and Labels), used to change the terminal
marking (and to edit wire numbers attached to the terminal, if any).

Link to Displays a list of tags in the Select a Tag to Link to Terminal


Instrument Tag window. See Link Instrument Tag to Terminals.

Remove Link to Removes a link to an instrument tag.


Instrument Tag

Disconnect from Disconnects wires from the selected terminal.


Selected

Disconnect All Disconnects wires from all selected terminals.


Selected

Select All Selects all the device’s terminals.


Terminals

Select By Used to select every second, third or fourth terminal, depending on


the sub-menu option selected.

DeSelect All De-selects all terminals in the terminal's terminal strip.


Terminals

If the user right-clicks on a terminal label, the same pop-up menu will be displayed, except
that the Change Terminal Marking option is replaced with the Change Terminal Label
option.

Other Terminal Menu Options


The right-click menu for Devices and I/O Modules includes the following additional option:

Edit Signal No. Opens the Change Terminal Marking window, in which the signal
number may be edited. Refer to Change Terminal Markings and
Labels.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

The right-click menu for Earth Bars and Terminal Strips includes the following additional
option:

Split Earth Bar/ Used to split the currently selected terminals off the Earth Bar or
Split Terminal Terminal Strip to create a new Earth Bar or Terminal Strip.
Strip

7.2.6 Terminal Descriptions Pop-up Menu


If the user right-clicks on a terminal description box (located next to each device terminal),
the Terminal Descriptions pop-up menu is displayed:

The Change Terminal Description command is used to add or change device terminal
descriptions. Refer to Add or Change Terminal Descriptions.

7.2.7 Wire Pop-up Menu


If the user right-clicks on a wire (at the wire number annotation) the Wire pop-up menu is
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Wire Pop-up Menu Commands

Show Other End Displays the a new Terminations window for the equipment
Terminations at the other end of the selected wire.

Show Other End Details Displays the Wire Interconnection Details window. Refer
to Trace Wire Interconnections.

Edit Ferrule Marking Displays the Edit Ferrule marking window. Refer to
Manual Ferrule Numbering.

Disconnect Wire Disconnects the selected wire.

Disconnect Cable Disconnects the selected cable.

7.2.8 Devices and Wires


This topic describes how devices and wires are depicted in the Terminations window.
For example:

This example shows two I.S. Barriers created on a DIN Rail with a terminal strip. Refer to
Add Devices (Relays, Barriers etc.) for details.
Users cannot change any equipment layout in the Terminations window. To change the
sequence of devices/terminal strips or add/delete devices, use the Equipment Layout View
window.

Core/Wire Colours
Black wires are cores from a cable.
Blue wires are wires not from a cable.

Note: Wires are normally used for internal wiring only. That is, both ends are terminated in
the same equipment or cabinet.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Note: Cables, wires, links and loop wires owned by Electrical are red. Refer to Cables and
Equipment Shared with AVEVA Electrical for more information.

Core/Wire Information
At the end of each cable core is the cable number.
At the end of each wire is the destination termination (Device tag + ':' + terminal number).
If there are wires in the current equipment that have not been terminated, the word 'Wires'
will be displayed in the 'Cable to Terminate' list. Click on 'Wires' in this list to view all
disconnected wires in the 'Cores' to Terminate' list.

7.3 Create and Edit Terminations using the Terminations


Window
For details of how to create and edit terminations using the Terminations window, and
related procedures, continue at:
• Select Terminals
• Set Terminals as Reserved or Spare
• Terminate Wires/Cores
• Cable Termination Options
• Disconnect Wires/Cores
• Add a New Project Cable
• Assign Tags to I/O Modules
• Create Multiple Wires between Terminals
• Create Links and Looping Wires
• Auto Cross Patch Wiring
• Wire Numbering
• Trace Wire Interconnections
• Create Terminations across Equipment Cabinets
• Change Terminal Markings and Labels
• Link Instrument Tag to Terminals
• Cables and Equipment Shared with AVEVA Electrical
See also:
• Import Terminations from Excel
• Import Signals from Excel

7.3.1 Select Terminals


To select a terminal click on the desired terminal. The terminal background changes to red.
Re-selecting a selected terminal de-selects the terminal. Multiple terminals may be selected
at the same time.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Select a range of terminals by pressing the Shift key and clicking the 'start' terminal, then
pressing the Shift key and clicking the 'end' terminal. All those terminals between the first
clicked and second clicked terminal will be selected (this is much like Windows range
selection methods).
The Terminals Pop-up Menu includes Select All and Select By options.

7.3.2 Set Terminals as Reserved or Spare


Terminals can be set as reserved or as spare. Both sides of a terminal can be set as
reserved or spare, or just the left or the right-hand side.
When wire terminations are made by applying wiring rules (see Assign Wiring Rules to
Tags), reserved and spare terminals are automatically skipped and are not terminated.
Terminations are instead made to the next available terminals in the strip.
Wire terminations can also be made by dragging from the Cables to Terminate or the
Cores to Terminate lists (see Terminate Wires/Cores and see Create Multiple Wires
between Terminals).
If the user drags onto a terminal strip with reserved terminals:
• In the case of cables, a message is displayed explaining that the cable cannot be
connected to a reserved terminal. The operation is then cancelled.

• In the case of cores, the user will be given the choice of “releasing” the reserved
terminal side and connecting the core to it, or of cancelling the operation entirely.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

If the user drags onto a terminal strip with spare terminals:


• In the case of a cable, the user will be given the choice of “releasing” the spare terminal
side and connecting the cable to it, or of skipping the terminal. If a terminal is skipped,
the operation will then move onto the next available terminal and attempt to connect to
that. If that terminal is also spare, the message will be displayed again, and so on until
the cable is connected or all terminals have been tried.

• In the case of cores, the user will be given the choice of “releasing” the spare terminal
side and connecting the core to it, or of cancelling the operation entirely.

Links and looping wires (see Create Links and Looping Wires) can be made to and from
spare terminals, but not reserved terminals.

Assign Reserved or Spare Status to Terminals


To set a terminals as reserved or spare, select it (see Select Terminals), then right-click on it
to display the Terminals Pop-up Menu.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

From the menu click either Set Terminal Reservation or Set Spare Terminals as required.
From the sub-menu that is then displayed, click Left Side, Right Side or Both Sides as
required.
Reserved terminal sides are coloured grey, spare terminal sides are coloured blue.

Reserved terminals can be changed to spare terminals and the other way around using the
above procedure.
To remove the reserved or spare setting from a terminal, select it, then right-click on it to
display the Terminals Pop-up Menu. From the menu, select either Set Terminal
Reservation or Set Spare Terminals as required, then click Clear from the sub-menu.
If clearing the reserved status from a terminal or changing it to spare, a warning message is
displayed. This user must click Yes to complete the procedure.

7.3.3 Terminate Wires/Cores


There are two main ways to make wire terminations:
• Drag and drop cores/wires: click on a wire or core in the Cores to Terminate list,
drag it next to a terminal and drop it (i.e. release the mouse button).
• Drag and drop cables: click on a cable number in the Cables to Terminate list, drag it
to a terminal strip and drop it (i.e. release the mouse button). When terminating a cable
Wiring Manager will display the Connect Options window (see Cable Termination
Options).
Users may also drag and drop core/wires between terminals. Click on a wire or core, drag it
next to a terminal and drop it (release the mouse button).
Wiring Manager supports up to two terminations per side per terminal. If two terminations
exist, both connections, wire/ferrule numbers and cable number (if any) are displayed next
to the terminal. Wiring Manager will not allow a third termination to be added to the same
terminal side.
For the result of attempting to connect cables or cores to a terminal strip with reserved or
spare terminals, refer Set Terminals as Reserved or Spare.

Note: Wiring Manager also supports the creation and termination of multiple wires between
selected terminals and auto cross-patch wire creation and termination. See Create
Multiple Wires between Terminals and Auto Cross Patch Wiring.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

7.3.4 Cable Termination Options


When terminating a cable from the Terminations window a user will be prompted to select a
termination options from the Connect Options window:

The options are:

Match Signal Nos


Attempts to match the signal number on opposite side of terminal strip with any signal
numbers found in the cable's 'Cores to Terminate' list. If a match is found, that core/wire will
be terminated at the terminal with the matching signal number.

Don't Match Signal Nos


Wiring Manager looks for first available terminal and connects the first core in core list to the
first available terminal found. It then looks for the next available terminal and terminates the
next core etc.
Two sub-options may be applicable:
• Terminate Shields/Screens/Earth - When checked, screens/shields/earth will be
terminated. When unchecked, they will be left disconnected.
• Skip Shield/Screen/Earth Terminals - If the Terminate Shields/Screens/Earth
option is unchecked, users are given the option to skip a terminal where a shield/
screen would have been terminated, or where the other side of a terminal has a screen/
shield terminated.
Note: In all cases, signal/wire numbers will be updated using Wiring Manager's Signal
Number Inheritance feature. If users chose not to match signal numbers, and signal
numbers on a available terminal do not match, users are warned of this, but the
termination still takes place.

7.3.5 Disconnect Wires/Cores


To disconnect a core/wire drag it to the Cores to be Terminated list and drop it there.
To disconnect multiple cores/wires, select multiple terminals, then right-click on any selected
terminal. From the menu that is then displayed (see below) select the appropriate
Disconnect option.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

7.3.6 Add a New Project Cable


Users can add new project cables directly from any equipment in the Terminations window
by selecting Add New Cable from the Wiring tab. The Cable Details window is then
displayed. Refer to Create a New Project Cable for details.

Note: When the new cable is created the cable number, it is added to the Cables to
Terminate list. However, sometimes users may need to click the Refresh toolbar
button for the cable number to appear.

7.3.7 Assign Tags to I/O Modules


To assign a tag to an I/O Module channel (or Point), first add the I/O Module to the
appropriate Cabinet (refer to Adding I/O Modules). Once the I/O Module is positioned, right-
click on any I/O Point in the Terminations window to assign tags. Refer to Assign Tags to I/
O Modules for more information.

7.3.8 Create Multiple Wires between Terminals


Users may need to create wires between component terminals (e.g. from an Terminal Strip
to an IS Barrier, or from a I/O module to a Power Supply etc.). Wiring Manager contains a
'Wiring Wizard' feature to facilitate this.

Create Multiple Wires between Terminals


From the Terminations window, from the Wiring tab, select Add Wiring Wizard. The
Wiring Wizard window (Add multiple Wires between selected Terminals) is then
displayed:

To add terminals to “from” terminals, select the terminals that to create the wires from (this
can be on any number of components) from the Terminations window (the wizard window
“floats” over the Terminations window, so that selections can still be made from that
window even when the wizard window is open).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Note: Wires will be created in the order the terminals are selected. Any wire/signal
numbers will be inherited from the “from” terminals prior to the “to” terminals
(selected later).

The following figure shows four terminals selected on a Terminal Strip:

As each terminal is selected it is added to the wizard window, as shown below:

Note: De-selecting a terminal from the Terminations window will remove the terminal from
the wizard window.

Note: To specify the wire side (left or right) on a Terminal Strip or Earth Bar, select the
terminal by clicking nearest to either the left or right side.

Once selected all the required “from” terminals have been selected, click Next. The wizard
the shows the “To” terminals list:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Select the “to” terminals from the Terminations window in the same way as the “from”
terminals. In this example four terminals have been selected on a barrier:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Once the required “to” terminals have been selected, click Next. The wizard will then show
all the selected terminals:

Note: The wizard will create wires between aligned Terminals: there must therefore always
be a matching number of terminals in each list. Terminals in either list can be
removed by selecting then pressing the <Delete> key on the keyboard. Terminals
can be re-ordered by dragging and dropping them within a list.

To create wires between the terminals, click Create.


Wiring Manager will then create all the wires between the listed terminals.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Note: If any reserved terminals were selected (see Set Terminals as Reserved or Spare), a
warning message is displayed. This user must click Yes to complete the procedure

7.3.9 Create Links and Looping Wires


Wiring Manager supports terminal 'Links' (or bridging) and terminal looping wires. For
example:

Links are hard bridges between terminals (as shown within the terminal strip above) and can
only be added to Terminal Strips.
A looping wire is an external wire looping between terminals. Looping wires can be either on
the left or right side of any component in Wiring Manager.

Note: If there any reserved terminals (see Set Terminals as Reserved or Spare), these
cannot be connected by looping wires. An error message is displayed if this is
attempted. Links to and from spare terminals may be created however.

To Add a New Link or Looping Wire


Select all the terminals within the same Terminal Strip (or Device if adding looping wires)
that requires links or loop wires.
From the Terminations window, select the Links or Wiring tab, then select required option
to add the links or wires as described below.
To create links, click Add Link (Normal), Add Link (Left) or Add Link (Right) as
appropriate.
To create looping wires, click Add Left Looping Wires (Normal), Add Left Looping Wires
(Long), Add Right Looping Wires (Normal) or Add Right Looping Wires (Long) as
required.
The two 'long' options create looping wires that are longer than the standard type.

Removing/Deleting Links and Looping Wires


To delete a link or loop wire select the top-most terminal of the link or looping wire and select
the Delete Selected Link or Delete Selected Looping Wire option from the Links or
Wiring tab.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

To delete all links or loop wires from all the items in the terminations view, select the Delete
All Links or Delete All Looping Wires option from the Links or Wiring tab.

7.3.10 Auto Cross Patch Wiring


Wiring Manager supports the automatic creation and termination of wires between terminals
carrying the same signal (wire) number. This process is called Auto Cross Patching. Cross
patch wire creation only occurs for wires where there is no termination on the other side of
its terminal, that is where a terminal is not already connected on both sides if the terminal is
a through connector. In the case of devices or I/O modules, the terminal must not already
have any prior wires terminated to be considered a candidate for cross patch wiring.
Auto Cross Patching is an ideal way to create wires between two terminal strips or between
a terminal strip and I/O as Wiring Manager will create multiple wires in one go, by searching
through all terminals and creating all possible cross patch wires where matching signals
exist.
Auto Cross Patch wiring enables users to choose the target equipment (e.g. marshalling
cabinet, I/O cabinet etc.) to cross patch to. Cross patching always occurs between the
current equipment in the Termination window and a user selected equipment tag. Users can
also choose to cross patch only within the current equipment tag.

Auto Cross Patching Procedure


From the Terminations window, select Cross Patch from the Wiring tab.
Wiring Manager will then display the Select Equipment window, listing of all equipment in
the current location:

Auto Cross Patch wiring will take place between the current equipment in the Terminations
window and the target equipment selected from the above window. The first item in this list
is always the equipment tag that is the current focus of the Terminations window.
To select the target equipment, double-click on it.
Wiring Manager will then process all possible wire terminations between every terminal in all
terminal strips, devices and I/O modules in each of the current and Target equipment. Wiring
Manager compares each terminals signal number to all others in the Target equipment. If a

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

match is found a new wire is created and terminated on both the matching terminals. This
process is repeated again until all possible wires are added.
To cancel cross patch wiring click the close button to close the window.

Wiring Manager Wiring Wizard (Manual Cross-Patch Wiring)


Sometimes users may wish to create wires between component terminals (e.g. from an
Terminal Strip to an IS Barrier, or from an I/O module to a Power Supply etc.) that do not
lend themselves to cross-patching, especially if the terminals to be connected do not have
signal/wire numbers that match. Wiring Manager contains a 'Wire Wizard' feature to
facilitate this. Refer to Create Multiple Wires between Terminals for details.

7.3.11 Wire Numbering


Refer to Wire Numbering for information regarding wire numbering concepts in Wiring
Manager.

7.3.12 Trace Wire Interconnections


From the Terminations window, right-click on any terminated wire (at the wire number
annotation). Select the Show Other End Details option from the menu that is then
displayed. The Wire Interconnection Details window is then displayed:

Cable Data Section


Shows details of the cable (only if the selected wire is a cable core).

Destination Termination Data Section


Shows the equipment, terminal strip and terminal at the other end of the selected wire is (if
the wire is actually terminated at the other end).
To view further details of the other end of the selected wire, click View Terminations. A new
Terminations window is then displayed, showing the equipment terminations at the other
end of the wire.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

7.3.13 Create Terminations across Equipment Cabinets


Wiring Manager supports the splitting a cable's end cores across equipment (that is, some
cores of the same end in terminated in Equipment 1 and others in Equipment 2). Wiring
Manager also supports the termination of wires between equipment.
By default, cable terminations can only be made at the cable's 'From' and 'To' ends as
defined in the cable schedule. However, Wiring Manager enables cores from a single cable
end to be terminated across multiple equipment tags, not just the equipment defined in the
cable's 'From' and 'To' fields.
To terminate a cable across multiple equipment, open both equipment in the Wiring
Terminations window and drag cores/wires from one window to the other, terminating using
the drag and drop method described in the Terminations User Interface.

Note: The ability to terminate cable cores across equipment cabinets is controlled by the
Allow cable core terminations across equipment cabinets checkbox on the on
the General Tab of the Options window. It is enabled by default.

Wiring Manager also enables wires to be terminated between equipment in the same way.
Once a wire has been created it can be terminated across equipment by dragging an end
from one Terminations window to a second Terminations window.

7.3.14 Change Terminal Markings and Labels


Note: Terminal Markings cannot be edited for Devices and I/O Modules for a specific
project instance as all Devices and I/O Modules are a copy of the Catalogue
definition. The only way to change terminal markings (or arrangements) for catalogue
components is to select another catalogue item or edit the catalog item in the Device
or I/O Module Catalogues. Changing a Catalogue component changes all instances
of that component in the entire project. This forces all components used to be
identical to the Catalogue definition.

To change an individual terminal marking (terminal number) for a terminal on a Terminal


Strip, Earth Bar or Field Device, or to re-sequence selected terminals in a Terminal Strip or
Earth Bar, from the Terminations window, right-click on the Terminal to be changed.
From the menu that is then displayed, select the Change Terminal Marking or Change
Signal No. option. The Change Terminal marking window is displayed, showing the
current Terminal marking:

Changing Terminal Marking


To change a terminal marking enter a new value in the Terminal Marking field and click
Save.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

If multiple terminals were selected in the Terminations window, then selecting the Apply
New Sequence to all following Terminals checkbox will re-number the selected terminals
sequentially from the entered for terminal marking. This feature only works if the new
terminal marking is numeric.

Note: If using the {SignalNo-NoPolarity} datalink as part of the Automatic Ferrule


Numbering facility, make sure to use the signal number/polarity break character as
specified in on the General Tab of the Options window, i.e. enter it before the actual
terminal marking in the Terminal Marking field.

Changing Signal Numbers


In Wiring Manager, all signal (or wire) numbers start from an equipment terminal. Typically,
all field devices would have a signal number added to each terminal. In fact, signal numbers
are added automatically to all field devices created with Wiring Manager Wiring Rules (see
Using Wiring Rules). They may also be imported/updated from Excel (see Import Signals
from Excel).
If a terminal that already contains a signal number is right-clicked on, the Change Terminal
marking window is displayed:

To change a wire number/marking enter a new value in the Terminal Marking field and click
Save.
Users can set the default signal numbers for each Field Device terminal when defining
Wiring Rules. Refer to Wiring Rule Definitions.

Manually Adding Signal Numbers


If required, users can manually assign a signal number on any terminal by double-clicking
on the Signal Number field. This removes the 'read-only' property from the signal number.
The users may then enter a different number.
Importing or updating a signal number from Excel (see Import Signals from Excel) has the
same affect.

Note: Signal/wire numbers assigned to terminals remain on their terminal regardless of


which wires are terminated. Users should only assign signal/wire numbers to
terminals that carry a permanent signal e.g. a Field Device etc. However, there are
valid situations where users may need to permanently assign a signal to terminal in a
terminal strip, such as picking up a motor run contact from an interposing relay
cabinet or from an MCC. In this case there is no 'Field Device'.

Remember that signal numbers are inherited by all wires/cable cores that are connected
directly to a terminal containing a signal number, and wires connected to a wire that has an
inherited Signal Number. Refer to Wire Numbering for more details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Changing Field Device Terminal Labels


To change a field device terminal label from the catalogue default, right-click on it and select
the Change Terminal Label option. The Change Terminal Label window is displayed,
showing the current Terminal label:

Enter the required label and click Save.

7.3.15 Add or Change Terminal Descriptions


To enter or change the description of a device terminal, right-click on a terminal description
box (located next to the terminal it describes). The Terminal Descriptions Pop-up Menu is
displayed.

Click Change Terminal Description. The Change Terminal Description window is then
displayed:

Enter or change the description and click OK. The new or changed description is then
displayed in the Terminations window. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

7.3.16 Link Instrument Tag to Terminals


Sometimes when generating Loop Check Reports or CAD Loop Diagrams in Designer the
actual instrument tag is not a field device, so Wiring Manager cannot find the terminals from
where to start displaying the terminations from. For example, a tag may be a run contact
from the MCC for a pump, or a set of interface terminals from a vendor supplied control
cabinet.
In this situation, users can create a terminal strip (or DIN Rail with devices/relays etc.), then
use Wiring Manager's Link Tag to Instrument feature to make the instrument tag's terminals
the selected terminals. Then, when Wiring Manager generates Loop Check Reports or CAD
Loop Diagrams in Designer, the 'start' terminals are those linked to using this facility.

Linking a Tag to Terminals


From the Terminations window, right-click on the terminal and select Link to Instrument
Tag from the terminals pop-up menu The Select a Tag to Link to Terminal window is then
displayed:

The example above shows all instrument tags that exist in the Engineer Instrument List that
do not have any field devices created in the Wiring Manager Equipment list for the same
tag.
To link a tag to the current terminal, either elect the required Tag Number and click Link
Tag or double-click on the Tag Number.
Once a tag has been linked to terminals the terminal number in the Terminations window
becomes bold to indicate it linked to an instrument tag.

Note: Linking tags to terminals is only required if Loop Check Reports and/or CAD Loop
Drawings need to be generated and the loop's instruments are not created as 'Field
Devices' in Wiring Manager from Wiring Rules or manually in the Equipment list.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

To Remove a Link to a Tag


From the Terminations window, right-click on the terminal that is linked, and select
Remove Link to: XXXXX from the terminals pop-up menu (where XXXXX is the actual tag
number linked).

7.3.17 Cables and Equipment Shared with AVEVA Electrical


Cables, wires, links and loop wires created in AVEVA Electrical can be shared with AVEVA
Instrumentation, and vice versa. Shared items may only be edited using the “owning”
application, i.e. the application in which they were created.
The application which owns a cable, wire, link or loop wire is indicated by its colour:
• Cables owned by Instrumentation are black
• Cables owned by Electrical are red.
• Wires, links and loop wires owned by Instrumentation are blue.
• Wires, links and loop wires owned by Electrical are red.
Other points to note:
• Cables owned by Instrumentation can be terminated on shared equipment.
• Only cables etc. owned by Instrumentation can be dragged and dropped.

7.4 I/O Tag Allocations


Tags (signals) can be assigned to I/O Modules “manually” from the Terminations window
or by importing them from an Excel spreadsheet.
Continue at:
• Assign Tags to I/O Modules
• Import I/O Allocations from Excel

7.4.1 Assign Tags to I/O Modules


Once tags/signals are assigned to I/O Modules/Channels Wiring Manager can create I/O
Allocations reports and use I/O allocation data when creating loop diagrams and loop check
reports.
When a tag is assigned to an I/O Module, Wiring Manager creates signal numbers that
match the signal numbers on the corresponding field device terminals. In this way, Wiring
Manager can create cross-patch wires from the incoming wiring to the tag's I/O channel
terminals.

Note: In order to build redundancy into the design, a single tag can be assigned to
channels on more than one I/O Module. However, you cannot assign a tag to
different channels on the same IO Module.

Important: Tags cannot be assigned to an I/O Module unless the Tag No exists in the
Engineer Instrument List and the tag has a value in the 'I/O Type' field of the
selected Control System (e.g. 'AI', 'AO', 'DI', 'DO' etc.).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Manual I/O Allocation


To manually assign a tag to an I/O Module channel (or Point), first add the I/O Module to an
appropriate Cabinet or Equipment Panel (refer to Adding I/O Modules). All I/O modules in
Wiring Manager are based on user defined catalogue definitions.

Note: I/O Module creation and channel assignment can also be done automatically by
Importing I/O Allocations from an Excel file. Refer to Import I/O Allocations from
Excel for details.

Once the I/O Module is positioned within the cabinet or panel, open the Terminations
window and scroll to the specific I/O Module.
The following example shows an I/O Module in the Terminations window:

To assign I/O to this module, right-click on any tag text box (the centre 'blank' text boxes
above). This menu is then displayed:

Click Assign Tags to I/O. The Assign Tag to I/O Point window is then displayed:

The window lists all tags not assigned to I/O points on the module.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

To assign a Tag to a specific I/O Point (Channel) click on the tag in the window and drag and
drop onto the I/O Module channel in the Terminations window. Once dropped, the selected
Tag Number will be displayed on the I/O Module. For example:

To assign more tags to I/O Points, drag and drop as required from the Assign Tag to I/O
Point window.

Unassign an a Tag form an I/O Module


To unassign any previously assigned I/O right-click on the point (i.e. on the point's Tag
Number). A message will then be displayed:

Click Yes to unassign the tag from the point/channel.

7.4.2 Import I/O Allocations from Excel


Wiring Manager supports the importing of I/O Allocations (tag to channel assignment) from
an Excel spreadsheet.

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

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

the mandatory columns/data: Cabinet Name, I/O Module Name (or Tag), I/O module
catalogue number, Channel No and Tag No.
Since Wiring Manager I/O Modules have several user-definable property fields users can
also import additional data such as Rack, Slot, System, Chassis etc. into those I/O module
property fields by including that data in the Excel file being imported.
If the I/O Module Tag/Name does not exist Wiring Manager, will automatically create an I/O
module with that Tag/Name in the Cabinet listed in the Excel workbook.
To import Excel I/O data, with any grid or view open, click I/O Allocations in the Import
section of the Manage tab.
The I/O Allocation Import window is then displayed:

Click Browse and locate the Excel Workbook file.


Click Next.
The import wizard will display the following:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

In this screen of the wizard, the user must map field in the Excel spreadsheet to AVEVA
Instrumentation fields.

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

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

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Define a New Mapping Definition


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

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

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

AVEVA Instrumentation displays a window showing all the columns in the Excel Workbook
selected earlier.
Once the mappings have been set up, click Import.
The import wizard will then perform data validation for the I/O Module data found in the
Excel file. If there are any issues with the data validation, for example a Catalogue Number
in the Excel data does not exist in the Wiring Manager I/O Module Catalog, then the next
wizard screen will show a list of issues. If there are no issues the wizard will show a list of
valid Modules ready for import:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

To import the I/O Modules and their Tag/Channel assignments select the I/O Modules to be
imported using their Select checkboxes (or use the Select all checkbox if required), then
click Next.
The import wizard will then perform data validation for the Tag numbers and Cabinets as
defined in the Excel file. If there are any issues with the data validation, for example a Tag
Number in the Excel data does not exist in Engineer Instrument List or the Equipment No for
the Cabinet does not exist in the Wiring Manager Equipment list, then the next wizard
screen will show a list of issues. If there are no issues the wizard will show a list of valid I/O
Modules ready for import once again.
Click Import.
The import wizard will create new I/O Modules in their Cabinets (if the I/O Module Tag/Name
does not already exist) and then assign tags to channels to complete the I/O Allocation.

7.5 Import Terminations from Excel


Terminations can be established by importing their details from an Excel spreadsheet.
The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading,
The Excel file must contain the following columns: Cable Number, Core Marking, Parent
Equipment Number, Equipment Number, Terminal Marking, Terminal Description, and Left
or Right.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.
While processing records to be imported, if a record already exists in the database AVEVA
Instrumentation will show the differences between the imported data and the AVEVA
Instrumentation data, allowing the user to accept/reject the proposed changes on a record
by record (and field by field) basis. If the record does not exist in AVEVA Instrumentation
and the user accepts the importation of the record, AVEVA Instrumentation will create a new
record for that drawing or catalogue item.
The Import Procedure
Open the Equipment View, Equipment List or Cable Schedule. Select Terminations from
the Import section of the Manage tab.
The Terminations Import wizard window is then displayed:

Click Browse and select the Excel file from which data is to be imported. Click Next >.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

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

Note: AVEVA Instrumentation automatically checks each Excel Column Name from the first
row in the Excel worksheet against fields names in AVEVA Instrumentation Database

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

(if not found then field Captions - as set in the Grid Manager). If a match is found
then AVEVA Instrumentation automatically adds the Field Name to the mapping list.
The user can select a different field from the mapping list if required.

Defining a New Mapping Definition


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

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

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

Importing the Data


Once the mappings have been set up, click Next >.
A list of terminations in the spreadsheet that will not be imported because they are invalid in
some way in then displayed, along with the reason that they are invalid:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click Next >.


A list of valid terminations is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click Import to proceed with the import. The import then takes place and the terminations
detailed in the spreadsheet are established. After the import is complete, a log of the
imported terminations is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click Close the exit the import wizard.

7.6 Import Signals from Excel


Signal numbers for terminal strip, device and I/O module terminals can be created or
updated by importing them from an Excel spreadsheet.
The Excel spreadsheet must be in a simple tabular format (columns and rows) and the first
row should contain unique column names (headings) so that AVEVA Instrumentation can
identify the column's data. The column names are user definable but must not be
duplicated. AVEVA Instrumentation will only import column data that contains a heading,
The Excel file must contain the following columns: Area Path, Area, Parent Equipment
Number, Terminal Number, Terminal Description, Left or Right, and Signal Number.
Once an Excel spreadsheet is selected for import, users must 'map' each Excel column
name (heading) to an AVEVA Instrumentation database field using the AVEVA
Instrumentation import utility. Data can then be imported into AVEVA Instrumentation. The
import utility will check if the identity column field exists in mappings.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Note: If a terminal is included in the spreadsheet with a blank signal number cell, this will
result in the signal number associated with that terminal (if there is one) being
deleted by the import.
If it is not intended that the signal number associated with a terminal is to be created
or changed, it should be not be included in the import source spreadsheet.

The Import Procedure


Open the Equipment View, Equipment List or Cable Schedule. Select Signals from the
Import section of the Manage tab.
The Signals Import wizard window is then displayed:

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

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

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

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

Defining a New Mapping Definition


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

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

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

Importing the Data


Once the mappings have been set up, click Next >.
A list of any issues found in the format spreadsheet is then displayed:

A list of valid signals is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click Import to proceed with the import. The import then takes place and the signals
detailed in the spreadsheet are then created or updated.
Once the import is completed, the following will be displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click OK. The log of the import is opened automatically. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

The log is in CSV format, and will be saved to the same location as the import source
spreadsheet. The log will note which signals have been created or updated (deletion is
regarded as an update here).
Where a signal has not been updated because it is the same in both Wiring Manager and
the spreadsheet, this will be indicated with “Signal is same”. If a signal cannot be created or
updated by the import because it is for an internally connected terminal, this will be indicated
with “Signal exists on internal connected terminal”.
Click Close the exit the import wizard.

7.7 Termination Reports


Wiring Manager enables users to quickly and accurately produce reports for any
equipment's terminations that can be printed out or saved in PDF format for electronic
transfer. These reports are non-CAD so they do not require a CAD program to create.

Note: The basic termination reports only show terminations for the equipment in question.
An enhanced option is also available. It displays all connected equipment and
terminations, direct and indirect. See Enhanced Termination Reports for details.

Note: AVEVA Instrumentation also supports the creation of Termination Diagrams in


AutoCAD DWG format from the Designer module.

Wiring Manager creates a single termination report for the selected Equipment Number,
using multiple pages if necessary. New pages are created when the number of terminals
exceeds the maximum allowable for a specific page size/orientation. Wiring Manager

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

always creates a new page for each new DIN Rail. Terminal strips on a common DIN Rail
are kept together and a new page is not created unless all terminals will not fit on the current
page.
An Equipment Termination report can be run in several ways:
• In the Equipment View, right-click on the required equipment node and select Print
Preview Terminations from the pop-up menu.
• In the Equipment List grid, select the required equipment and select Preview
Termination Report in the Printing section of the List Tools - Equipment List tab.
• In the Equipment List grid, click on the Equipment No cell button for the equipment,
then click View Terminations (Print Preview) on the Options window that is then
displayed.
• In the Equipment Layout window (refer to Equipment Layout), right-click on the
required equipment and select Print Preview Terminations from the pop-up menu.
• In the Cable Schedule grid, click the From or To cell button listing the equipment, then
click View Terminations (Print Preview) on the Options window that is then
displayed.
• In the Allocate Tags to Junction Box window (see Assign Field Devices to Junction
Boxes), click the Print toolbar button.
• When viewing a basic or enhanced cable block diagram (see Create or Edit Content of
a Basic Cable Block Diagram or Create or Edit Content of an Enhanced Cable Block
Diagram), by right-clicking on an equipment symbol and selecting the Termination
Report option from the menu that is then displayed.
The AVEVA Instrumentation Termination Report window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Various functions are available to the user via the File, Edit, View and Layout drop-down
menus, or by clicking the required button on the toolbar.

File Menu
Save Saves the report to the database. This option is available on
the toolbar.

Refresh Updates and reloads the Equipment data and refreshes the
window. This option is available on the toolbar.

Recreate Diagram Restores any equipment removed from the Termination


Report by the Remove from Diagram option. Recalculates
the location for all the equipment and finds any new
connected Equipment if it exists.

Export to PDF Exports the report to a .PDF format file in the project’s
Drawing folder. The filename used is either the Sketch
Number, as defined in the Equipment List, or if no sketch
number exists, the Equipment number.

Export to XPS Exports the report to an .XPS format file in the project’s
Drawing folder. The filename used is either the Sketch
Number, as defined in the Equipment List, or if no sketch
number exists, the Equipment number.

Export to AutoCAD Selecting this option exports the Termination Report to


AutoCAD.

Page Setup Displays the Page Setup window, which enables the user to
change the paper size and source, the orientation and the
size of the margins.

Print Preview Displays the Print preview window, which enables the user
to view the report before sending it to a printer. This option is
available on the toolbar.

Print Displays the Print window, which enables allows the user to
customise the print. This option is available on the toolbar.

Printing Enables the user to print the report to a defined size by


selecting a percentage. After a percentage is selected, the
Print preview window is displayed, which enables the user
to view the print before sending to a printer.

Preferences Displays the Preferences window.

Exit Closes the AVEVA Instrumentation Termination Report


window.

Edit Menu
Undo Undoes the last command. This option is available on the
toolbar.

Redo Redoes the last undo. This option is available on the toolbar.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Trim Canvas Enables the user to change the size of canvas to the actually
size of the diagram.

Select All Selects all objects.

Find Equipment Displays the Find Text window allowing the user to search
for a string of characters.

Insert Note Opens a text box into which a note can be entered. The text
box can be positioned in the report by clicking on it and
dragging it to the required position.

View Menu
Show Overview Display the Overview window, which displays all the report
pages.

Predefined percentage Enables the user to select a predefined zoom percentage.

Zoom Normal Sets the report back to the default zoom.

Zoom to Fit Zooms the report to fit all the pages into the window. This
option is available on the toolbar.

Zoom In Increases the image size of the report. This option is


available on the toolbar.

Zoom Out Decreases the image size of the report. This option is
available on the toolbar.

Layout Menu
Align Horizontally Moves two or more selected nodes to the same row, aligned
with the first selected node.

Align Vertically Moves two or more selected nodes to same column, aligned
with first selected node.

Layout (Flat) Used to layout a report automatically, by positioning the


items and routing the links horizontally.

Show Ferrule Numbers Checkbox


The only option on the toolbar not available on the menus is the Show Ferrule Numbers
checkbox. If ferrule numbers are to be displayed on the report instead of signal numbers,
ensure that this checkbox is checked.
The default setting for this checkbox is specified on the Cable/Wires tab of the Preferences
window.

7.7.1 Preferences
Termination Report preferences can be set from the Preferences window. To display the
Preferences window select File > Preferences.

Note: In addition to the preferences described here, the default ECBD cable label symbol
(see Add or Edit Cable Block Diagram Symbols) may be used on Termination
Reports, depending on the Wiring Manager preferences for the project. Refer to
Options for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

General Tab

The General tab is used to specify how reports are displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Cables/Wires Tab

The Cable/Wires tab is used to specify how the cables and wires will be displayed in
reports.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Printing Tab

The Printing tab is used to set the default paper size, orientation and margins, the
maximum number of terminals that can be displayed on each page and to add a header and
footer to the pages.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Export Tab

The Export tab is used to define the settings to be used when exporting the Termination
Report to AutoCAD.

Note: A user must have AutoCAD installed on their workstation to export a Termination
Report successfully.

The user can change the preferences back to the default settings by clicking Use Default.
Click OK to save the changes and close the Preferences window, or Cancel to close the
Preferences window without saving any changes.
If OK is clicked a warning message is displayed, informing the user that applying the new
settings will cause the diagram to reload.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Click Yes to continue or No to cancel the process.

7.7.2 Title Blocks on Termination Reports


Wiring Manager supports title blocks and revisions on Termination Reports for equipment
that have Sketch Numbers. Wiring Manager will create the termination report with a title
block complete with Revision history.

If equipment does not have a Sketch Number, these blocks are not displayed. Sketch
(Document) numbers and Revisions are added/edited from the Equipment List window.
Users can add/edit Termination Report document revisions for multiple reports - refer to
Report Revision Entry.
This title block is 'fixed' and cannot be modified by the user.

7.8 Enhanced Termination Reports


The basic termination reports (see Termination Reports) only show terminations for the
equipment in question. The enhanced option displays all connected equipment and
terminations, direct and indirect. It also includes a number of additional options and
facilities.
The Enhanced Termination Report window is accessed from the Equipment View grid
view. Right-click on the required equipment node and select Enhanced Termination
Report from the pop-up menu to display the AVEVA Instrumentation Enhanced
Termination Report window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

It can also be accessed when viewing a basic or enhanced cable block diagram (see Create
or Edit Content of a Basic Cable Block Diagram or Create or Edit Content of an Enhanced
Cable Block Diagram), by right-clicking on an equipment symbol and selecting the
Enhanced Termination Report option from the menu that is then displayed.
The additional options available on the Edit and Layout drop-down menus are:

File Menu
Export to Designer Creates a record of the diagram in the Drawing List in
Designer and generates an AutoCAD version of the
enhanced termination report.
Settings for the export, such as the seed file to be used, are
specified on the Export tab of the Preferences window.

Edit Menu
Insert Rev Block Used to add a revision information block to the diagram,
which the user may then type the required data into.

Insert Document No. Used to add a document number information block, which
the user may then type the required data into.

Note: Title blocks (see Title Blocks on Termination Reports) are not automatically added
to enhanced version of Termination reports as they are with the basic version.
They are added and completed manually by the user using the above two options.

Layout Menu
Layout Equipment (Flat) Used to layout diagrams automatically by positioning the
Items and routing the links horizontally.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Layout Equipment Used to layout diagram automatically by positioning the


(Tree) Items and routing the links as a tree.

Make Sub Diagram Used to select multiple items of equipment and group them
together in a sub-diagram.

Layout Sub Diagram Used to layout the item inside the sub diagrams
automatically.

Group Selected Used to select multiply items of equipment and group them
together.

Ungroup Selected Used to ungroup multiply items of equipment which were


grouped together using the Group Selected option.

The user can edit cable details by right-clicking on a cable to display a pop-up menu. From
the menu, select Edit Cable Details to display the Cable Details window. Refer to Edit
Project Cable Data for further information.
After selecting a terminal strip to highlight it, the user can right-click to display the following
additional options.

Edit Terminations Displays the Terminations window. Refer to Terminations


User Interface for further information. Any changes made in
the Terminations window will be reflected in the Enhanced
Termination Report window after the user refreshes the
window.

Termination Report Displays the Termination Reports window. Refer to


Termination Reports for further information.

Add Interconnected Clicking this option rebuilds the report and includes all the
Equipment equipment connected to a selected terminal.

Remove from Diagram Removes selected equipment from the Termination Report.
The removed equipment can be restored by selecting File >
Recreate Diagram.

7.8.1 Preferences
Enhanced Termination Report preferences can be set from the Preferences window. To
display the Preferences window select File > Preferences.
The settings for the General tab are the same as the Termination Reports window. Except
as described below, the settings on the Cables/Wires, Printing and Export tabs are also the
same. Refer to Preferences for further information.
The Enhanced Termination Report Preferences window includes an additional Rules tab.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Cables/Wires Tab

The Cable/Wires tab for Enhanced Termination Reports includes an additional option for
specifying whether or not cable types are to be shown, and their font size if they are.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Printing Tab

The Printing tab for Enhanced Termination Reports does not include an option for limiting
the number of terminals to be printed. All terminals will be printed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Export Tab

The Export tab for Enhanced Termination Reports includes additional settings to be used
when exporting the Termination Report to Designer and AutoCAD, such as the seed file to
be used.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Terminations

Rules Tab

If the user checks the Find the direct connected equipment only checkbox, the
generation of the diagram will stop after locating all the directly connected equipment. If left
unchecked the generation of the diagram will locate all the other wires from the equipment
or terminals.
Checking the Show the Equipment without wire checkbox will display all the equipment in
the diagram which does not have any wires connected to it terminals. If left unchecked this
equipment is not displayed.

Note: The primary equipment is always displayed and is not affected by this preference
setting.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

8 Wire Numbering

Wiring Manager supports two methods of wire numbering:


1. Signal Numbers - wire numbers are based on a 'source' signal.
2. Ferrule Numbers - wire numbers are different at each wire or end of each wire.
Both these methods can be used in a single Wiring Manager project. However when both
are used, Ferrule Numbers always override Signal Numbers when Wiring Manager creates
termination reports or Termination Diagram drawings (in AutoCAD using Designer) or loop
check reports (in Engineer) or Loop Diagram drawings (in AutoCAD using Designer). So
any Signal Number is always ignored in documents and reports if a Ferrule Number exists at
a specific wire end. This enables users to override Signals if required in documents.

Signal Numbers
A Signal Number originates at a terminal. All wires connected to that terminal or wires
connected to wires connected to that terminal inherit the same Signal Number.

In the above example, a Signal Number (red) has been attached to the field Device's first
terminal (+). Consequently as a wire (or cable core) is connected to that terminal, the Signal
Number is 'inherited' along all wires that are connected together in the circuit. Hence all the
wires marked with the blue arrows have their signal numbers generated from the single
Signal at field device terminal + (red arrow).
Furthermore, if the Signal at the originating terminal is changed (i.e. the Signal Number is
changed) then all Signal Numbers for all interconnected wires will also automatically change
to the new Signal Number.
This Signal Numbering system is the most commonly used in the industry and is the easiest
to apply with Wiring Manager. By default, Wiring Manager shows Signal Numbers in the
Terminations window (see Terminations User Interface) since its more likely users are
working with specific signals than Ferrule Numbers (see below).
When a field device is created using Wiring Rules (see Using Wiring Rules), Wiring
Manager will automatically create each Signal Number at each field device terminal based

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

on the Signal Number rule set for the applied Wiring Rule. Signal Numbers can also be
manually created and/or edited from the Terminations window.

Ferrule Numbers
Wiring Manager supports Ferrule Numbering. When Ferrule Numbering is used, each wire
end may have a different number, i.e each end (ferrule) of a wire is numbered instead of
there being a single number for the wire.

Note: Whether or not ferrule numbers are generated for newly connected screens and
earth cores is controlled by the Generate Ferrule data for Cable Screens and/or
the Generate Ferrule data for Cable Earth Cores checkboxes on the General Tab
of the Options window.

In Wiring Manager, a Ferrule Number is stored for each wire end. The default value is empty
(blank).

In the above example, all the Ferrule Numbers are independent and have been set to a
specific value required for the current project/plant standards.
When Ferrule Numbers are used, Wiring Manager continues to create and update Signal
Numbers as terminations are created and changed.
Ferrule Numbers always override Signal Numbers in document, as explained above.
Ferrule Numbers can be manually set or removed using the Terminations window (see
Manual Ferrule Numbering). Automatic Ferrule Rules can also be set up for the project so
they are automatically created as wire and cables are terminated (see Automatic Ferrule
Numbering.

8.1 Manual Ferrule Numbering


Note: Remember that any Ferrule Number applied to a wire end always takes preference
to any Signal Number on that wire. So termination reports, loop reports and all Wiring
Manager drawings showing this wire will display the Ferrule Number instead of the
Signal Number.

If a manual ferrule number is required to be displayed in a report or drawing, from the


Terminations window (see Terminations User Interface), right-click on the wire end (or
cable core end) to be changed. From the pop-up menu then displayed, select the Edit
Ferrule Marking option.
The Edit Ferrule Marking window is then displayed, showing the current Ferrule Number
(marking):

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

Enter the required number in the Ferrule Number field.


The Apply to Both wire ends option is used to label both ends of a wire with the same
Ferrule Number in a single edit.

Note: The Ferrule Number at the other end of the wire is not actually updated in the
database until the user clicks Save in the Terminations window.

Click Save.

Note: Once a Ferrule Number has been added to the wire end it remains on that wire end
until it is edited again or it is overwritten by another Ferrule Number if Automatic
Ferrule Numbering Rules are applied. Currently, as a safeguard, Wiring Manager
also automatically sets Ferrule Numbers to nothing (blank) when wires containing
Ferrule Numbers are disconnected.

8.2 Automatic Ferrule Numbering


Some projects and/or plants may require a different wire Ferrule Number at every (or almost
every) wire end. Normally this could require many hundreds of design man-hours entering
these Ferrule Numbers. However, Wiring Manager includes a 'Ferrule Numbering Rule'
feature that enables users to define rules for automatic Ferrule numbering.

Note: For this feature to be used, the Use Auto Ferrule Numbering Rules option must be
checked in the Wiring Manager's Options window.

Ferrule Numbering Rules can derive data from the following:


From the current wire termination:
• Equipment No
• Terminal Strip No (or Device tag)
• Terminal Marking (Terminal No)
From the other end of the current wire termination:
• Equipment No
• Terminal Strip No (or Device tag)
• Terminal Marking (Terminal No)
If the wire is part of a cable (a cable core), from the:
• Cable Number
• Core Marking
• Core Group No (e.g. the Pair Number)

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

Ferrule Numbering Rules enable any of these values to be applied to create a Ferrule
Number. For example, a common Ferrule Numbering system is to form Ferrule Numbers
from Terminal Numbers (where the wire end is connected to) + Equipment Numbers at the
other end of wires.
Automatic Wire Ferruling can be applied by:
• Project (i.e. all wire ferrules use the same Ferrule Rule)
• Equipment Type (e.g. a Junction Box uses rule 1, a Field Device uses rule 2, DCS I/O
Module rule 3 etc.)
• Equipment instance (e.g. JB-03 uses rule 1, Gas JB-05 uses rule 2, MR-01 uses rule 3
etc.).
When Wiring Manager applies Ferrule Rules as follows:
1. Wiring Manager first checks if the specific Equipment item has a Ferrule Rule - if so it is
applied, if not it goes to step 2.
2. Wiring Manager then checks if the Equipment Type has a Ferrule Rule - if so it is
applied, if not it goes to step 3.
3. Wiring Manager then checks if a project 'Default Ferrule Rule' is set - if so it is applied,
if not automatic Ferrule Numbering is not applied.

8.2.1 Ferrule Rule Definition


To define or edit existing Auto Ferrule Rules, click Setup on the Project tab, then click
Ferrule Rules Definitions.
This displays the Ferrule Rules window:

This window shows all the Ferrule Rules for the current project.
To create a new Ferrule Rule, click New. The Ferrule Rule window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

Enter a unique name for the Rule in the Ferrule Rule Name field.
Optionally, in the Example field, enter an example of what a Ferrule Number created using
the rule will look like.
To define the way the Ferrule Numbers will be created using the rule, select the DataLink
field list:

Select the DataLinks or delimiters (/ \ - etc.) as required to make up the new Ferrule Number
Rule by click their checkboxes.
As each DataLink is selected it is added to the DataLink field. Unchecking a checkbox
removes a selected Datalink.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

In the example below the Ferrule Rule has been defined as: {EqNo-OtherEnd}/{TNo-
OtherEnd}.

If this example rule was applied to a wire at a Junction Box that is connected to terminal
number 20 in MR-1, then Wiring Manager will create the following ferrule number: 20/MR-1.
If checked, the Default checkbox makes the current rule the default for all wire terminations
in the project.
If the rule is to be applied to specific equipment types then check the Apply by Equipment
Type checkbox. This enables the pane at the bottom of the window.
To select an Equipment type, click Add. A record row is then added to the pane.
Select the required type from the list available from the Equipment Type field:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

Different Ferrule Rules can be assigned to left and right sides of internal components. From
the list available from the Side(s) field select Both (the default), Left or Right as required.
Repeat until all required equipment types have been selected.
To remove an equipment type, select it in the pane and click Remove.
To save the new rule, click Save.

Note: Refer to the Assign Ferrule Rules to Equipment for how to assign Ferrule Rules to
specific Equipment items.

To edit a Ferrule Rule, select it from the list in the Ferrule Rules window and click Edit. The
Ferrule Rule window is then displayed.
To delete a Ferrule Rule, select it from the list in the Ferrule Rules window and click Delete.
A message is then displayed requesting that the deletion be confirmed. Click Yes.

8.2.2 Assign Ferrule Rules to Equipment


To assign a Ferrule Rule to a specific Equipment tag. click Select in the Grids and
Schedules section of the Home tab.
Select Equipment Ferrule Rules from the list of grids that is then displayed. The
Equipment Ferrule Rules grid is then displayed:

Note: Ferrule Rules can also be assigned to Equipment Types when a rule is defined.
Refer to Ferrule Rule Definition.

To assign (or re-assign) Ferrule Rules, select the Equipment records to assign Ferrule
Rules to click Edit in the Records section of the Home or List Tools tabs.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

The Ferrule Rules window is displayed:

Different Ferrule Rules can be assigned to left and right sides of internal components.
Select the required Ferrule Rule(s) from the lists in the Left and Right fields.
Click Save to assign the selections.

8.2.3 Update Ferrule Numbers using Ferrule Rules


Once Ferrule Rules have been defined they can be applied to wire/cable terminations.

Note: For this feature to be used, the Use Auto Ferrule Numbering Rules option must be
checked in the Wiring Manager's Options window.

Update Ferrule Numbers by Equipment


Proceed as follows:
• In the Equipment View, right-click on the required Equipment record, click Auto
Ferrule Selected Equipment on the menu then displayed, then select the Left, Right,
or Both option as required from the sub-menu.
• Or in the Equipment Layout window (refer to Equipment Layout), right-click on the
required equipment, click Auto Ferrule Selected Equipment on the menu then
displayed, then select the Left, Right, or Both option as required from the sub-menu.
• Or in the Equipment List select the required Equipment record(s), then click Auto
Ferrule selected Equipment in the Actions section of the List Tools - Equipment
Ferrule Rules tab and select the Left, Right, or Both option as required from the drop-
down menu.
• Or in the Equipment Ferrule Rules list (see Assign Ferrule Rules to Equipment) select
the required Equipment record(s), then click Auto Ferrule selected Equipment in the
Actions section of the List Tools - Equipment List tab and select the Left, Right, or
Both option as required from the drop-down menu.
Wiring Manager will then update/create Ferrule Numbers based on the Ferrule Rules
applied to the equipment, equipment type or project for the selected equipment.

Update Ferrule Numbers by Cable


In the Cable Schedule, select the required Cable record(s), then click Auto Ferrule
selected Cables in the Actions section of the List Tools - Cable Schedule tab and select
the Left, Right, or Both option as required from the drop-down menu.
Wiring Manager will then and update/create Ferrule Numbers based on the Ferrule Rules
applied to the equipment, equipment type or project for the selected cables.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

8.3 Viewing Ferrule Markings


To view the ferrule markings/numbers for an item of equipment:
• Select the equipment in the Equipment List, and click View Ferrule Markings in the
Tools section of the List Tools - Equipment List tab.
• Or in the Equipment Layout window (refer to Equipment Layout), right-click on the
required equipment, click Ferrule No Report on the menu then displayed.
A window is then displayed, listing the markings/numbers for the equipment. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Wire Numbering

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

9 Fieldbus Segments

The Fieldbus Segments facility enables the user to create diagrams that consists of
Fieldbus Devices, Instrumentation and connecting wiring.
To access the Fieldbus Segments facility, click Select in the Grids and Schedules section
of the Home tab.
Select Fieldbus Segments from the list of grids that is then displayed. The Fieldbus
Segments grid is then displayed:

9.1 New Fieldbus Segment


To add a new Fieldbus Segment, click New in the Records section of the Home tab to
display the Fieldbus Segment Diagrams - Untitled Diagram window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Enter the Segment Details: Area, Name and Segment Description, then click Save to
create the new Fieldbus Segment.
The Fieldbus Segments grid view will now display the new Fieldbus Segment. Clicking Exit
closes the window.

9.2 Add Fieldbus Devices


Existing Fieldbus Devices can be added to a segment. Also, new Fieldbus Devices can be
created and added. Continue at:
• Add Existing Fieldbus Device
• Add New Fieldbus Device

9.2.1 Add Existing Fieldbus Device


To add an existing Fieldbus Device to the fieldbus segment, right-click in the Fieldbus
Segment Diagrams window and select Add Fieldbus Device from the pop-up menu or
select Device > Add Fieldbus Device from the main menu.
This displays the Select Fieldbus Device(s) window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

If a new device is required, click New Fieldbus Device. Refer to Add New Fieldbus Device
for details.
To select an existing device, select the area of the device from the Display by Area list (or
“All” for all areas). The window then lists the devices in the selected area(s).
Check the checkboxes of the devices to be selected, then click the Select button.
The window then closes and the selected devices are added to the segment.

9.2.2 Add New Fieldbus Device


To add a new Fieldbus Device to the fieldbus segment, right-click in the Fieldbus Segment
Diagrams window and select Create and Add Fieldbus Device from the pop-up menu or
select Device > Create and Add Fieldbus Device from the main menu.
Alternately, right-click in the Fieldbus Segment Diagrams window and select Add
Fieldbus Device from the pop-up menu or select Device > Add Fieldbus Device from the
main menu. This displays the Select Fieldbus Device(s) window (see Add Existing
Fieldbus Device). Click the New Fieldbus Device button.
The Device Information window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Complete the Device Tag/Description field and click Select from Catalogue to display the
Select a Fieldbus Device window.
The window lists the devices in the Fieldbus Device Catalogue:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Select the required Fieldbus Device from the list and click Select. The selected Fieldbus
Device will be displayed in the graphical area of the Device Information window and the
Catalogue Information section of the window will be populated.

To select the parent equipment, click the arrow button in the Parent Equipment field to
display the Select Equipment window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Select the required parent equipment from the list and click Select.
The Parent Equipment field in the Device Information window will then be populated with
the selection.
Click Save to add the Fieldbus Device to graphic view on the Fieldbus Segment Diagrams
window. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Note: The Fieldbus Devices can be re-positioned in the graphical view by clicking on them
device and dragging to the required position.

9.3 Add Instruments


To add existing Instruments to a Fieldbus Device, select the Fieldbus Device in the
graphical view on the Fieldbus Segment Diagrams window. Right-click and select Assign
Tags from the pop-up menu.

Note: New instruments can also be created and added (see below).

Alternately, right-click in the Fieldbus Segment Diagrams window and select Add
Instrument from the pop-up menu or select Instrument > Add Instrument(s) from the
main menu.
This displays the Select Instrument(s) to Allocate to Fieldbus Segment window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

The user can now select from the list the instruments that are to be added to the Fieldbus
Device. When the selection is complete, click Assign. The selected instruments will be
attached to the Fieldbus Device in numerical order and displayed in the Fieldbus
Segments Diagrams window.

Note: If more instruments are selected than there are available connection points, the extra
instruments will be displayed unattached.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

The user can select instruments which are not automatically connected to a Fieldbus Device
by right-clicking in the graphical view and selecting Add Instrument from the pop-up menu.
This displays the Select Instrument(s) to Allocate to Fieldbus Segment window.
After the user has selected the required instruments and clicked Assign, the instruments
are displayed in the graphical view unconnected, enabling the user to manually position and
connect the instruments.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

To manually connect an instrument, click the instrument and drag the cursor to the
connection point on the Fieldbus Device.

Create and Add New Instruments


To create and add a new instrument, right-click in the Fieldbus Segment Diagrams
window and select Create and Add Instrument from the pop-up menu or select
Instrument > Create and Add Instrument(s) from the main menu.
The Instrument Tag window is then displayed. Refer to the Instrument Engineering User
Guide for details.
Once the new instrument is created, it is added to the segment.

9.4 Create Segment Wiring


To create the segment wiring, select Create Segment Wiring from the Fieldbus Segment
Diagrams window toolbar.
If the default wiring rules have been set the Create Segment Wiring window is displayed.
If the default wiring rules have not been set a window will be displayed requesting the user
to choose and set the default wiring rules. Clicking OK displays the Wiring Rules tab on the
Preferences window. Select the default wiring rules and click Apply to display the Create
Segment Wiring window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

Select the required cables and click Create. The Fieldbus Segment Diagrams window
then refreshes to display the segment wiring.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Fieldbus Segments

9.5 Segment Check Reports


Click Segment Check Report on the Fieldbus Segments Diagrams window to generate a
report showing the cable, wires and terminal details for the Fieldbus Segment. For example:

The functionality of the Segment Check Report window is essentially the same as that of
the Enhanced Terminations Check Report window. For details, refer to Enhanced
Termination Reports.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10 Cable Block Diagrams

Wiring Manager includes a Cable Block Diagram application that provides interactive
access to project equipment and cabling. Users can view and edit Cable properties as if
they were using Wiring Manager's Cable Schedule data grid, view and edit Equipment,
including terminations as if they were using Wiring Manager's Equipment View.
A Cable Block Diagram gives designers a graphical view of the project's cabling and in
many situations allows easier navigation and visualisation for complex interconnections.
The Wiring Manager Cable Block Diagram application includes auto-layout capabilities and
allows printing to hard-copy. It supports saving and re-opening of diagrams, and the ability
to export to AutoCAD DWG format. The application provides full interactive access to all
underlying Wiring Manager objects for editing purposes.
There are two types of Cable Block Diagram, Basic and Enhanced. The type is selected
when a diagram is created. Basic Cable Block Diagrams are constructed from a simple set
of symbols supplied with the product. Enhanced Cable Block Diagrams are constructed
from user-defined symbols created for the project (refer to Add or Edit Cable Block Diagram
Symbols for details).

Access the Cable Block Diagram Application


To access the Cable Block Diagram facility, click Select in the Grids and Schedules
section of the Home tab.
Select Cable Block Diagrams from the list of grids that is then displayed. The Cable Block
Diagram grid is then displayed:

Cable Block Diagrams Grid Layout


The Cable Block Diagrams grid layout can be set by the user using the Grid Manager utility
(select Manager in the Grids and Schedules section of the Home tab). The Grid Manager
allows users to define Views, that is, which fields should be viewable in the grid, their default
position (column order), column size, default sort order and whether a data filter is applied

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

(e.g. Show only 'New' cables). New Grid Views can be saved for use by individuals or for
entire project teams and existing Views selected. Refer to Grid Manager for more
information.
Up to 10 user-defined fields, i.e. fields with user-defined names, may be added to the grid if
required. Refer to Options for details. Users may enter data into these fields, and the
Description field, directly. The other fields are display-only.

Cable Block Diagrams - List Tools Options


The following options are located on the List Tools - Diagrams 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 cable block diagram currently selected in the grid for
editing. Refer to Create or Edit Content of a Basic Cable Block
Diagram and Create or Edit Content of an Enhanced Cable Block
Diagram.

Drawing/Grid Section

Options Used to access a window in which aspects of the appearance and


layout of Enhanced Cable Block Diagrams (colours, line
thicknesses, spacings etc.), printing, export and grid setting
preferences can be specified. Refer to Enhanced Cable Block
Diagram Options for details.

10.1 Create a New Cable Block Diagram


To create a new cable block diagram, open the Cable Block Diagrams grid and click New in
the Records section of the Home tab.
The Cable Block Diagram Information window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Select the area that the diagram is to be associated with, and enter a unique identifier for
the new diagram in the Document No field and a description in the Description field.
If the diagram is to be a basic cable block diagram, click the Basic button, if it is to be an
enhanced cable block diagram, click the Enhanced button.
Click OK. The new diagram is then created, and a new window is displayed in which the
content can be added and edited.

Note: The cable block diagram description can subsequently be edited by changing it in the
grid. The name and diagram type cannot be edited.

Continue at:
• Create or Edit Content of a Basic Cable Block Diagram
• Create or Edit Content of an Enhanced Cable Block Diagram

10.2 Create or Edit Content of a Basic Cable Block


Diagram
The content of basic cable block diagrams is added and edited using the Cable Block
Diagram window. This is opened from the Open option in the Actions section of the
Diagrams tab, or by double-clicking on its record in the Cable Block Diagrams grid.
It is also displayed automatically when a basic diagram is first created (refer to Create a
New Cable Block Diagram).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

If there have been any changes to the items on the diagram since it was last saved, the
Refresh Summary window is displayed, listing these changes.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Cable Block Diagram Basic Operations


To move equipment around a diagram, click on the equipment tag (or near the equipment
edge) and drag the item to a new location. Wiring Manager will reposition any cables
connected to the moved equipment including the cable numbers.
Users can also move any cable number flags by dragging them. If a flag is moved off a
cable line, a line is then added between the cable the cable flag.
To remove an equipment item from the diagram, select it (click on it) and press the delete
<Del> key. To remove a cable, select the cable and press the delete <Del> key.

Note: Using the Delete key removes selected objects from the current diagram. It does not
delete the object from the project database.

Wiring Manager allows multiple selections:


• By “windowing”: select any point not on an object and drag a rectangle. Everything
within the rectangle window is selected
• By using the Layout menu option Select All.

Zooming and Panning


Use the zoom commands on the toolbar to change the zoom factor.
The Overview window (activated from the Zoom pull-down menu option) enables dynamic
zooming when a user changes the internal green window size and dynamic panning by
dragging the small green window within the Overview window:

Users may also perform a dynamic pan by clicking on the main Cable Block Diagram
window with the middle mouse button. This action displays a small dynamic pan icon. Any
movement of the mouse will dynamically pan the diagram. End dynamic panning by clicking
anywhere in the window.
Continue at:
• Add Existing Equipment and Cables to Basic Cable Block Diagrams
• Interactive Features
• Changing a Cable End (Destination)
• Add Equipment

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• Create a New Project Cable


• Assign Field Devices to Junction Boxes
• Field Device Wiring Facilities
• Cable Drawing Styles

10.2.1 Add Existing Equipment and Cables to Basic Cable Block Diagrams
From the Wiring Manager Equipment View, click on an Equipment node drag the selected
Equipment node onto the diagram and drop it on the canvas.
Wiring Manager will then add the selected equipment and optionally connected Equipment,
cables and field devices. In the example below, the centre Junction Box was 'dragged' onto
the document.

Note: Whether or not interconnected equipment etc. is added is controlled by a Options


setting. A separate option to specifically exclude field devices from being added is
also available.

In the above example Equipment node 01-JB-002 (a junction box) was dragged from the
Equipment View to the Diagram and all its connected equipment was added to the left and
right along with all the connecting cables. The cable number is shown within the flag
(rectangle) and the cable type is shown above each cable number. This also shows a 'Note'
which can be added at any time.

Note: Users can also drag Equipment from the Wiring Manager Equipment List gridview
and can drag Cables from the Wiring Manager Cable Schedule gridview.

Add other existing Equipment or add new project equipment by right-clicking on the blank
canvas and selecting the required option from the menu that is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Refer to Create a New Equipment Tag, Select Existing Equipment from a List and Add
Multiple Equipment Wizard for details of these options.

10.2.2 Interactive Features


Users can view and edit engineering data directly within a cable block diagram by right-
clicking on any object and selecting the appropriate command.
To view and edit cable properties, right-click on any cable. A menu is then displayed:

Click Cable Properties. The Cable Details window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

See Edit Project Cable Data for details.


To view and edit equipment details, right-click on any Equipment node. A menu is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Edit Detail.


The Equipment Detail window is then displayed:

Refer to Equipment Layout for information on adding/editing internal components (Terminal


Strips, Devices, I/O Modules and Earth Bars).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

To view and edit equipment/cable terminations, right-click on any Equipment node. A pop-up
menu is then displayed:

Click Edit Terminations.


The Terminations window is then displayed:

Refer to Terminations for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10.2.3 Changing a Cable End (Destination)


Any cable in the Cable Block Diagram can be reconnected to another Equipment node.
To change a cable's end to another equipment, click on the cable so it is highlighted. When
a cable is highlighted, there will be a small green diamond shape shown at each end of the
cable:

Drag the small green diamond shape to move that end of the cable to another equipment
node.
Release the mouse (dropping the end) on the equipment. Wiring Manager will then redraw
the cable to the new equipment.
Changing the a cable end using this method disconnects all cores terminated at the old
equipment and updates the cable schedule for the dragged cable end.

Note: The maximum number of cables that may be connected to an equipment item (or
equipment catalogue item) may (optionally) be specified on the More Information
window accessed from the Equipment Layout window. If the user attempts to
connect a cable when the maximum number of cables has already been connected
to an equipment item, a message is displayed to inform the user of this.

10.2.4 Add Equipment


Equipment may be added to a diagram by:
• Dragging and dropping existing equipment from the Wiring Manager Equipment View
or Equipment List grid. Refer to Drag and Drop.
• Dragging and dropping an existing cable from Cable Schedule grid. Connected
equipment is added as well. Refer to Create a New Cable by Dragging.
• Adding existing interconnected equipment by right-clicking on any equipment node
within a diagram and selecting the Add Interconnected Equipment menu option.
Refer to Add Interconnected Equipment.
• Creating a new equipment tag. Refer to Create a New Equipment Tag.
• Selecting from a list of existing equipment. Refer to Select Existing Equipment from a
List.
• Using the Add Multiple Equipment wizard. Refer to Add Multiple Equipment Wizard.

Drag and Drop


To add existing equipment and cables to the Cable Block Diagram by dragging and
dropping:
• In the Equipment View, click on an Equipment node, drag the selected Equipment node
onto the diagram and drop it on the canvas.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• Or, in the Equipment List, click on an Equipment record, drag the selected Equipment
record (select just to the left of the 'Pin' icon) onto the Diagram and drop it on the
canvas.
• Or, in the Cable Schedule, click on an Cable record drag the selected Cable record
(select just to the left of the 'Pin' icon) onto the Diagram and drop it on the canvas.
Wiring Manager will then add the selected equipment or cable, and depending on the
preferences set, all connected Equipment and cables as shown in this example:

In the above example Equipment node 01-JB-002 (a junction box) was dragged from the
Equipment View to the Diagram and all its interconnected equipment was added to the left
and right along with all interconnecting cables. The cable number is shown within the flag
(rectangle) and the cable type is shown above each cable number.

Note: Whether or not interconnected equipment etc. is added is controlled by a Options


setting. A separate option to specifically exclude field devices from being added is
also available.

Add Interconnected Equipment


To add existing equipment and cables to the Cable Block Diagram based on
interconnectivity, right-click on any Equipment node. A pop-up menu is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Add Interconnected Equipment.


Wiring Manager automatically adds all equipment and cables from the selected equipment
that are not already shown in the Diagram.

Note: Connected equipment, cables and field devices can be added using this option
regardless of the Auto Add Interconnected Equip and Exclude Field Devices
Options settings.

Create a New Equipment Tag


To create a new equipment tag:
• Open the Equipment menu and click Create New.
• Or, right-click on the drawing canvas (not on any existing entity), and from the pop-up
menu select Add New Equipment.
The Equipment Information window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

After entering the new tag's data (see Create New Equipment for details), click Save to
create the equipment. Wiring Manager will place the new equipment on the diagram.

Note: To see the new equipment tag in the Equipment View, select Refresh from the
Records section of the Home tab.

Select Existing Equipment from a List


Right-click on the drawing canvas (not on any existing entity) and from the pop-up menu
select Add Existing Equipment. The Select Equipment window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

To add equipment to a diagram, check their Select checkboxes and then click the Select
button.

Add Multiple Equipment Wizard


Right-click on the drawing canvas (not on any existing entity) and from the pop-up menu
select Add Multiple Equipment. The Add Multiple New Equipment wizard window is then
displayed. For details, refer to Create or Import Multiple Major Equipment.
Equipment created or imported using the wizard is automatically added to the diagram.

10.2.5 Create a New Project Cable


New project cables can be created between any equipment in a diagram, either by:
• Using the dragging tool. Refer to Create a New Cable by Dragging.
• Selecting the source and destination equipment. Refer to Create a New Cable by
Selecting Equipment.

Create a New Cable by Dragging


A new cable can be added between equipment on a diagram by using the dragging tool.
Click in the centre of the source equipment node, then, while holding down the mouse
button “drag” the cursor towards the destination equipment node. A new cable will be
displayed “behind” the cursor while the user does this, i.e. the cursor will appear to be
dragging a cable away from the destination equipment.
When the cursor touches the destination equipment node, end the drag (i.e.stop pressing
the mouse button). The new cable will then be added and displayed between the two
equipment nodes.
A cable is not added to the cable schedule (i.e. the project database) until the user enters
and saves its properties. To do this, right-click on the cable and select the Cable Properties
option. The Cable Details window is then displayed, with the From and To equipment fields
completed. Refer to Create a New Project Cable for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Create a New Cable by Selecting Equipment


Users can also create a new cable by selecting two equipment nodes, then selecting the
Create New option from the Cables menu.
First make sure nothing is selected. Next select the 'From' equipment (click on the
equipment node). Then, holding the <Ctrl> key down, select the 'To' equipment (click the its
node).
With two nodes selected, click Cables toolbar menu and select Create New.
The Cable Details window is then displayed, with the From and To equipment fields
completed. Refer to Create a New Project Cable for details.
Enter the required cable details (including selection of a cable number and catalogue cable)
and save. The new cable is then added to the cable schedule and to the diagram.

Note: The maximum number of cables that may be connected to an equipment item (or
equipment catalogue item) may (optionally) be specified on the More Information
window accessed from the Equipment Layout window. If the user attempts to
connect a cable when the maximum number of cables has already been connected
to an equipment item, a message is displayed to inform the user of this.

10.2.6 Assign Field Devices to Junction Boxes


Field device tags may be assigned to junction boxes. As part of this procedure, a Wiring
Rule may be assigned which will result in the cables/terminations at both the field device
and junction box ends etc. being automatically created based on the selected rule.
Refer to Using Wiring Rules for more information on wiring rules.
Right-click on a Junction Box in a diagram. The following menu is displayed:

Click Junction Box Allocations.


The Allocate Tags to Junction Box window is then displayed.
For further details, see Assign Field Devices to Junction Boxes.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10.2.7 Field Device Wiring Facilities


The right-click menu for Field Devices in a diagram includes two options relating to wiring:
Show Signal Path and Show Wiring Check Report.

The Show Signal Path option highlights the path of the field device signal on a diagram
with an animated dashed line. For example:

Select the Stop Animation option from the Cables menu to stop the animation and remove
the highlighting.
The Show Wiring Check Report option displays the Wiring Check Report for the device.
For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Refer to Field Device Wiring Reports for details of these reports.

10.2.8 Cable Drawing Styles


Wiring Manager supports three drawing styles for cable:
1. Single straight lines (users can manually add 'bend points' as required).
2. Orthogonal Lines (cables are always drawn with vertical and/or horizontal segments).
3. Bezier - curved lines (cable lines are drawn single curved segments).
The following figure shows examples of these cable styles:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

The two bottom cables are 'Orthogonal' (type 2), left most is 'Straight' (type 1), top and right
are 'Bezier' - curved (type 3).
Any cable can have its style changed at any time. Right-click on them, and from the menu
then displayed, select Make Orthogonal or Make Straight as required.
The default style is set on the Visualisation tab of the Options window.

10.3 Create or Edit Content of an Enhanced Cable Block


Diagram
The content of enhanced cable block diagrams is added and edited using a window with the
same name as the diagram. This is opened from the Open option in the Actions section of
the Home tab, or by double-clicking on its record in the Cable Block Diagrams grid.
It is also displayed automatically when an enhanced diagram is first created (refer to Create
a New Cable Block Diagram).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

If an item that was on the diagram has subsequently been deleted from the database, a
message is displayed to inform the use of this. For example:

View Options
The following facilities are located at the bottom of the window:
• To zoom in and out use the Scale slider, the plus and minus buttons, or hold down the
Ctrl key and move the mouse wheel up (to zoom in) or down (to zoom out).

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• If panning is enabled by clicking the Enable Panning button (it is off by default), the
diagram can be navigated around by left-clicking and dragging the mouse in the
required direction.
• Click Scale to Fit to zoom out or in so that contents of the diagram fit the window.
• To display a small window in the bottom-right corner of the main window displaying an
overview of the diagram, click Overview. For example:

Click on a symbol or cable on the drawing to centre the main window on that drawing
element.
Click the button again to close the overview.

Select Drawing Elements


To select single item, left-click on it or its label. The selected item is surrounded by a green
box.
To select multiple items either:
• Select items by left-clicking on their symbols or text and holding down the Shift key. The
first item selected is surrounded by a green box, subsequent items by a blue box.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• Drawing a “box” around the items to be selected by left-clicking on one corner of the
box dragging the cursor, while holding down the left mouse button to the opposite
corner. A pink box is drawn around the selected area. Release the mouse button. All
items fully in the box are then selected and are surrounded by blue boxes.
• Press Ctrl+A to select everything on the drawing, or select the Select All option from
the Edit menu. All items are surrounded by blue boxes.

Move Drawing Elements


To move drawing element, select them (see above) and drag them to the required location.
Connected cables will stretch etc. to maintain connections.

Toolbar Options

Save Layout Saves changes to the drawing.

Refresh Manually refreshes the drawing with changes to the layout and to
item details that were not automatically implemented in the
drawing.
In the case of Key One Line diagrams, interconnected equipment
may also be added by refreshing the diagram. See Refresh the
Diagram.

Show Grid Used to toggle the display of the drawing grid on and off (it is on
by default).

Snap to Grid Used to toggle the snapping of drawing elements to the grid on
and off (it is on by default).

Layout Accesses a drop-down menu with two options:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Align Used to align all selected equipment


Horizontally horizontally. All selected items are aligned
(Top) with the first item selected.

Align Vertically Used to align all selected equipment


(Left) vertically. All selected items are aligned with
the first item selected.

Enable Panning Toggles panning on and off (it is off by default). When toggling is
on the diagram can be navigated around by left-clicking and
dragging the mouse in the required direction.

Print Preview Toggles the print preview of the diagram. When print preview
mode is on, previews of the pages as they would be printed are
displayed as part of the diagram (over the grid, if this is being
displayed), so that the user can see which items will appear on
which pages. For example:

Print Used to print the diagram. Opens a standard Print window.

Export Accesses a drop-down menu with two options:

Export to PDF Used to export the diagram to a PDF file.


Opens a standard Save file as window.

Export to Used to export the diagram to a DWG file.


AutoCAD Opens a standard Save file as window

Add Existing Used to select existing equipment to add to the diagram. Refer to
Equipment Select Existing Equipment from a List for details.

Close Closes the diagram window.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Menu Options

File Menu
File Saves changes to the drawing.

Export to PDF Used to export the diagram to a PDF file. Opens a standard
Save file as window.

Export to AutoCAD Used to export the diagram to a DWG file. Opens a


standard Save file as window

Print Used to print the diagram. Opens a standard Print window.

Exit Closes the diagram window.

Edit Menu
Select All Used to select all equipment and cables on the diagram.

Delete All Used to delete all equipment and cables from the diagram.
A message is displayed requesting that the deletion be
confirmed.

Note: Equipment and cables deleted from the diagram in


this way are not deleted from the project database.
See also Delete Symbols and Cables.

Find Equipment Used to find and select equipment and field devices in the
diagram. Displays the Search window:

From the field, a drop-down list of all the equipment and


field device tag numbers in the diagram is accessible.
Select the required tag number. Click Find. The item with
that tag number is then selected in the diagram.
Alternatively, enter part or all of a tag number in the field,
checking the Match Case checkbox if required. Click Find.
The first item in the diagram that matches the entered
search criteria is then selected in the diagram. Click Find
Next to select the next matching item, if there is one.
If there are no matches, a message will be displayed to
inform the user of this.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Equipment Menu
Add All Interconnected Used to the all the equipment connected to the equipment
currently in the diagram. Refer to Add Interconnected
Equipment for details.

Add Interconnected Used to add the field devices connected to selected


Field Device equipment to the diagram. Refer to Add Interconnected
Equipment for details.

Remove All Field Used to remove all field devices from the diagram (they are
Devices not deleted from the project database).

Add Existing Equipment Used to select existing equipment to add to the diagram.
Refer to Add Equipment and Cables for details.

Stop Animation Used to stop the animation that indicates field device wiring
paths. Refer to Field Device Wiring Facilities for details.

Cable Menu
Create New Used to convert connections between equipment into
project cables. Refer to Create a New Project Cable for
details.

Layout Menu
Align Horizontally (Top) Used to align all selected equipment horizontally. All
selected items are aligned with the first item selected.

Align Vertically (Left) Used to align all selected equipment vertically. All selected
items are aligned with the first item selected.

Drawing Page Right-Click Menus


Right-click on the drawing page (i.e. not on any drawing element) to display the following
options:
• Add Existing Equipment: used to select existing equipment to add to the diagram.
• Save Layout: saves the layout.
• Refresh: refreshes the diagram.
For more information see Toolbar Options.
Continue at:
• Add Equipment and Cables
• Change Symbols
• Create a New Project Cable
• Edit Symbols and Cables
• Edit Appearance of Cable Labels
• View and Edit Terminations
• View Termination Reports
• Assign Field Devices to Junction Boxes
• Field Device Wiring Facilities
• Delete Symbols and Cables

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• Refresh the Diagram

10.3.1 Add Equipment and Cables


New equipment may be added to a diagram by dragging the required symbol type from the
Symbols panel. Refer to Create a New Equipment Tag.
Existing equipment may be added to a diagram by:
• Dragging and dropping existing equipment from the Wiring Manager Equipment View
or Equipment List grid. Refer to Drag and Drop.
• Dragging and dropping an existing cable from the Cable Schedule grid. Connected
equipment is added as well. Refer to Drag and Drop.
• Adding existing interconnected equipment by right-clicking on any equipment node
within a diagram and selecting the Add Interconnected Equipment menu option.
Refer to Add Interconnected Equipment.
• Selecting from a list of existing equipment. Refer to Select Existing Equipment from a
List.
In addition to the above facilities, existing field devices can be added to the diagram using
the Add Interconnected Field Device menu option.

Create a New Equipment Tag


From the Symbols panel on the left-hand side of the window, select the symbol standard to
be used from the required symbol library, as selected from the Library list.
The symbols in the standard are then displayed in the Symbols panel. They are divided into
categories, e.g. Cabinets/Panels, Field Devices, Junction Boxes etc., which can be hidden
and revealed by clicking the arrow down next to a category title.
To add a symbol to the drawing, click on it in the Symbols panel and then drag and drop at
the required position on the drawing page.
When new equipment is added to the drawing, the Equipment Information window is
displayed (see Create New Equipment for details), in which the user must enter details of
the equipment.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

When field devices are added to a diagram, the Instrument Tag window is also displayed
(see Add Field Devices for details).

Drag and Drop


To add existing equipment and cables to the Cable Block Diagram by dragging and
dropping:
• In the Equipment View, click on an Equipment node, drag the selected Equipment node
onto the diagram and drop it into the diagram.
• Or, in the Equipment List, click on an Equipment record, drag the selected Equipment
record (select just to the left of the 'Pin' icon) onto the Diagram and drop it into the
diagram.
• Or, in the Cable Schedule, click on an Cable record drag the selected Cable record
(select just to the left of the 'Pin' icon) onto the Diagram and drop it into the diagram.
Wiring Manager will then add the selected equipment or cable, and depending on the
preferences set, all connected Equipment and cables as shown in this example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

In the above example Equipment node 01-JB-002 (a junction box) was dragged from the
Equipment View to the Diagram and all its interconnected equipment was added along with
all interconnecting cables.

Note: Whether or not interconnected equipment etc. is added is controlled by a Options


setting. A separate option to specifically exclude field devices from being added is
also available.

Add Interconnected Equipment


To add existing equipment, field devices and cables to the Cable Block Diagram based on
interconnectivity with a selected item of equipment, right-click on any Equipment symbol. A
pop-up menu is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Add Interconnected Equipment.


Wiring Manager automatically adds all equipment and cables from the selected equipment
that are not already shown in the diagram.

Note: Connected equipment, cables and field devices can be added using this option
regardless of the Auto Add Interconnected Equip and Exclude Field Devices
Options settings.

To add any existing field devices connected to a selected item of equipment, select an
equipment symbol, then from the Equipment menu, select the Add Interconnected Field
Device menu option.
To add all equipment either directly connected to the equipment already in the diagram, or
connected both directly and via other equipment, select the Add All Interconnected option
from the Equipment menu. The Auto Add Equipment window is then displayed:

Add only add equipment directly connected to the current equipment in the diagram, select
the Single Pass option and click OK.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

To add all equipment connected either directly or indirectly via other equipment, select the
Add Everything option and click OK.

Select Existing Equipment from a List


Either click the Add Existing Equipment option from the Equipment menu, or right-click
on the drawing (not on any symbol or line) and from the menu that is then displayed select
Add Existing Equipment.
The Select Equipment window is then displayed:

To add equipment to a diagram, check their Select checkboxes and then click the Select
button.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10.3.2 Change Symbols


Right-click on any symbol (including cable labels) to display the Change Symbol option.
Select this option to displayed the Symbol List window:

The window displays all the different project symbols for the selected item type (see Add or
Edit Cable Block Diagram Symbols). The Default Symbol checkbox indicates the default
symbol set for the type of item.
Select a different symbol either by double-clicking on it or clicking on it and clicking Select.
The window then exits and the symbol currently on the drawing is replaced by the selected
symbol.

Note: Changing the symbol that represents an item on one diagram does not changed that
item’s symbol on other diagrams. This means that the same item can be represented
by different symbols on the different diagrams.

Equipment symbols can also be changed using Equipment List facilities, and cable labels
using Cable Schedule facilities. Refer to Change Enhanced Cable Block Diagram
Equipment Symbols and Change Enhanced Cable Block Diagram Cable Label Symbols for
details.

10.3.3 Create a New Project Cable


New cables are created by:
• Manually connecting symbols by dragging a line between them. Refer to Manually
Connect Symbols. See also Delete Connections.
The connections must then be made into project cables by entering their details. Refer
to Change Connections into Cable and Enter Details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

• Selecting two equipment symbols and then selecting the Create New option from the
Cables menu. Create Cables by Selecting Equipment.

Manually Connect Symbols


To manually connect one symbol to another, hover the cursor over the symbol of what is to
be the ‘from’ equipment. The cursor will change to a hand symbol when it is hovered over a
connection point:

Left-click at the required connection point, and then drag the cursor towards the equipment
that the cable is to be connected to, i.e. the ‘to’ equipment. The selected symbol is
highlighted in pink. As the cursor is dragged towards the ‘to’ equipment, a blue line ending in
an arrow is drawn on the diagram from the selected equipment point to the position of the
mouse cursor.

Connect the end of the line to the ‘to’ equipment symbol. That symbol is highlighted in pink
as well.

Release the mouse button. The connection is then made, as indicated by the blue line
between the two items.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

To make the connection into a project cable, continue at Change Connections into Cable
and Enter Details.

Delete Connections
To delete a connection before it has been made into a cable, right-click on it and select
Delete from the menu that is then displayed. The connection is then deleted.

Change Connections into Cable and Enter Details


To create a cable from a connection between two items, right-click on the connection and
select Create Cable from the menu that is then displayed.
The Cable Details window is then displayed, with the From and To equipment fields
completed. Refer to Create a New Project Cable for details.
Enter the required cable details (including selection of a cable number and catalogue cable)
and save. The new cable is then added to the cable schedule and to the diagram, and
labelled using the cable label symbol set as the default for the project.
Once a connection becomes a project cable its colour changes from blue to black.

Note: Cable label symbols may be hidden, moved, rotated or changed for a other symbol if
required, as explained in Edit Appearance of Cable Labels.

Create Cables by Selecting Equipment


Users can also create a connections by selecting two equipment symbols, then selecting
the Create New option from the Cables menu.
Select the 'From' equipment (click on the equipment symbol). Then, holding the <Ctrl> key
down, select the 'To' equipment (click the its symbol).
With the two symbols selected, select the Cables menu and click Create New.
The Cable Details window is then displayed, with the From and To equipment fields
completed. Refer to Create a New Project Cable for details.
Enter the required cable details (including selection of a cable number and catalogue cable)
and save. The new cable is then added to the cable schedule and to the diagram as a red
line, and labelled using the cable label symbol set as the default for the project.

Note: Cable label symbols may be hidden, moved, rotated or changed for a other symbol if
required, as explained in Edit Appearance of Cable Labels.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10.3.4 Edit Symbols and Cables


To edit equipment or a cable, or right-click on it and select the Edit Details or Edit Cable
option from the menu that is then displayed.
The appropriate detail window for the item is then displayed.
For details, continue at:
• Equipment Layout for equipment other than field devices.
• Add Field Devices for field devices.
• Edit Project Cable Data for cables.

10.3.5 Edit Appearance of Cable Labels


Cables are labelled using the default “label symbol” specified for the project (see Add or Edit
Cable Block Diagram Symbols). Cable label symbols consist of the datalinks required to
label cables. The appearance of the actual cables themselves is pre-defined and cannot
edited.
Cable label symbols may be moved, rotated, changed for a other symbol or hidden f
required.

Change Cable Label Symbol Anchor


To change the anchor point of a cable label symbol, right-click on the label and select Label
Anchor from the menu that is then displayed. From the sub-menu, select the required
anchor point, e.g. Top Left, Top Middle, etc.:

Rotate Cable Label Symbol


To rotate a cable label symbol 90°, right-click on the label and select Rotate Label Symbol
from the menu that is then displayed. From the sub-menu, select the required direction of
rotation, clockwise or anti-clockwise.
The label is then rotated 90° in the selected direction.

Change Cable Label Symbol


Cable label symbols are changed to another cable label symbol in the same way as
equipment and field device symbols. Right-click on the label and select Change Label
Symbol from the menu that is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

The Symbol List window is then displayed. Refer to Change Symbols for details.

Hide and Show Cable Label Symbol


To hide the label of a cable, right-click on either the label or the cable and select Hide Cable
Label Symbol from the menu that is then displayed. The label is then hidden.
To show the label again, right-click on either the label or the cable and select Show Cable
Label Symbol from the menu.

10.3.6 View and Edit Terminations


To view and edit equipment/cable terminations, right-click on the equipment symbol. A pop-
up menu is then displayed:

Click Edit Terminations. The Terminations window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Refer to Terminations for details.

10.3.7 View Termination Reports


To view a report detailing the terminations of an equipment item, right-click on the
equipment symbol. A pop-up menu is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

From the menu, select either the Termination Report option, or if the enhanced version of
the report is required, the Enhanced Termination Report option.
The Termination Report or the Enhanced Termination Report window is then displayed.
For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

For further details, refer to Termination Reports and Enhanced Termination Reports.

10.3.8 Assign Field Devices to Junction Boxes


Field device tags may be assigned to junction boxes. As part of this procedure, a Wiring
Rule may be assigned which will result in the cables/terminations at both the field device
and junction box ends etc. being automatically created based on the selected rule.
Refer to Using Wiring Rules for more information on wiring rules.
Right-click on a Junction Box in a diagram. The following menu is displayed:

Click Junction Box Allocations.


The Allocate Tags to Junction Box window is then displayed.
For further details, see Assign Field Devices to Junction Boxes.

10.3.9 Field Device Wiring Facilities


The right-click menu for Field Devices in a diagram includes two options relating to wiring:
Show Signal Path and Show Wiring Check Report.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

The Show Signal Path option highlights the path of the field device signal on a diagram.
For example:

Select the Stop Animation option from the Equipment menu to stop the animation and
remove the highlighting.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

The Show Wiring Check Report option displays the Wiring Check Report for the device.
For example:

Refer to Field Device Wiring Reports for details of these reports.

10.3.10 Delete Symbols and Cables


To delete a symbol or cable, right-click on it and select the Delete Equipment or (for cables)
the Delete option from the menu that is then displayed, or select it and press the Delete key

Note: Use the second method to delete multiple items. The right-click menu will not be
displayed if multiple items are selected.

The Delete Options window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

If the symbols and/or cables are to be deleted both from the diagram and the database, click
Delete from Diagram and Database. If they are to be deleted from the diagram but the
equipment/cables they represent are to remain in the database, click Delete from Diagram
only.
Click OK to implement the selected deletion option.
Note that if both the source and destination of a cable is deleted from the diagram, the cable
will not also be deleted (unless selected for deletion as well), i.e. it will remain in the cable
schedule but with its From and To equipment fields blank.

Remove All Field Devices


All field devices can be deleted from the diagram by selecting the Remove All Field
Devices from the Equipment menu. Every field device in the diagram is then deleted from
the diagram. The field devices are not deleted from the project database.

Delete All Option


The diagram can be cleared, i.e. all equipment and cables can be deleted from it, by
selecting the Delete All option from the Edit menu. A message is displayed requesting that
the deletion be confirmed.
Equipment and cables deleted from the diagram in this way are not deleted from the project
database.

10.3.11 Refresh the Diagram


To refresh the data displayed on the diagram and optionally add new interconnected
equipment to the diagram, click the Refresh button.
The Refresh Options window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Refresh data only if only the data on the diagram is to be updated.
Click Refresh data and add interconnected if the data on the diagram is to be updated,
and interconnected equipment is to be added to the diagram.
Once the required option has been selected, click OK to refresh the diagram.

10.4 Options
User options can be set for Cable Block Diagrams. Different sets of option are available for
Basic and Enhanced diagram types.
Continue at:
• Basic Cable Block Diagram Preferences
• Enhanced Cable Block Diagram Options

10.4.1 Basic Cable Block Diagram Preferences


To set Basic Cable Block Diagram options, from the Basic Cable Block Diagrams File menu,
select Options.
The Basic Cable Block Diagram Options window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Visualisation Tab

The visualisation options effect how basic cable block diagrams are drawn.

Note: Changes to these options will not effect any object already on a diagram.

Drawing Styles
Draw Orthogonal If this checkbox is checked, cables will be drawn at right
angles (at 0 or 180 degrees only).

Curved Bends Adds a small curve to all cable corners.

Size Preferences
These setting effect the size of various components when added to a Cable Block
Diagram.

Equipment Spacing

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Vertical Spacing This setting controls the vertical spacings of automatically


added interconnections and layouts.

Horizontal Spacing This setting controls the horizontal spacings of automatically


added interconnections and layouts.

Other Settings
Auto Add If this checkbox is checked, all interconnected cables and
Interconnected Equip equipment are automatically added when existing
equipment is added (except optionally field devices - see
below).

Exclude Field Devices This option excludes field devices from being automatically
added when interconnected equipment and cables are
automatically added.

Show Instrumentation This option is disabled in Instrumentation.


Cables

Show Electrical Cables This option controls whether or not cables created in AVEVA
Electrical for the project (if the project is shared with
Electrical) can added to diagrams.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Printing Tab

Printing preferences are used to define printing settings for Cable Block Diagrams, including
Header and Footer text.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Export Tab

The Export tab is used to define Cable Block Diagram settings for exports to AutoCAD.
The default scaling and widths shown are suitable for metric AutoCAD drawings. For
imperial units (inches), dividing the above units by approximately 25 is suggested.
Tag numbers and cable numbers are created by inserting predefined AutoCAD blocks into
each AutoCAD cable block diagram on export. Users can modify the blocks by editing
CBDCableNo and CBDTagNo drawings in the project's 'block' folder shown at the bottom of
the tab.

10.4.2 Enhanced Cable Block Diagram Options


To set Enhanced Cable Block Diagram preferences select the Enhanced Cable Block
Diagram Options option in the Options section of the Diagrams tab.
The Enhanced Cable Block Diagram Options window is then displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Visualisation Tab

The visualisation preferences effect how basic cable block diagrams are drawn.

Symbol Standard Used to select the symbol library selected by default in the
diagram editor.

Drawing Styles
Draw Orthogonal If this checkbox is checked, cables will be drawn at right
angles (at 0 or 180 degrees only).

Curved Bends Adds a small curve to all cable corners.

Equipment Spacing
Vertical Spacing This setting controls the vertical spacings of automatically
added interconnections and layouts.

Horizontal Spacing This setting controls the horizontal spacings of automatically


added interconnections and layouts.

Size Preferences

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Cable No - Equipment Controls the distance between the labels of cables and
Offset equipment.

Assignment (Link)
Thickness Controls the thickness of links between symbols that have
not been converted into cables.

Diagram Grid
Controls the height and width of the cells of the diagram grid.

Other Settings
Auto Add If this checkbox is checked, all interconnected cables and
Interconnected Equip equipment are automatically added when existing
equipment is added (except optionally field devices - see
below).

Exclude Field Devices This option excludes field devices from being automatically
added when interconnected equipment and cables are
automatically added.

Show Instrumentation This option is disabled in Instrumentation.


Cables

Show Electrical Cables This option controls whether or not cables created in AVEVA
Electrical for the project (if the project is shared with
Electrical) can added to diagrams.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Printing Tab

Printing preferences are used to define printing settings for Cable Block Diagrams, including
Header and Footer text.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Export Tab

The Export tab is used to define Cable Block Diagram scaling settings for exports to
AutoCAD, i.e. the drawing and line type scaling factors.

Note: The default scalings are suitable for metric AutoCAD drawings. For imperial units
(inches), dividing the above units by approximately 25 is suggested.

The tab can also be used, if required, to select a “seed” AutoCAD drawing file in which
AutoCAD line types are defined.
Catalogue cables can then be associated with any of these line types on the Design Data
tab of the Catalogue Cable Details window (refer to Add Cables to the Catalogue for
details).
When Enhanced Cable Block Diagrams are exported to AutoCAD, the cables will be drawn
using the line type associated with the catalogue cable they are based on.
To select a seed file, click the ... button next to the Cable Line Style Reference File (.dwg)
field, and browse for the required .dwg file. The file path and name of the selected file are
then displayed in the field.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Grid Settings Tab

This tab is used to control which user-defined fields are displayed in the Cable Block
Diagrams grid (if any) and what they are to be called in the grid.
There are ten user-defined fields. By default, none of them are displayed in the Cable Block
Diagrams grid. To add a user-defined field to the grid, uncheck its Hidden checkbox. To
remove a field from the grid, re-check the checkbox.
As required, change the text in the Caption field to the required user-defined field name.
This name will be displayed in the Cable Block Diagrams grid column heading for the field if
it is added to the grid.

10.5 Add or Edit Cable Block Diagram Symbols


To view, edit and create symbols for use on cable block diagrams, Setup > Symbols > User
Defined in the Project tab. The User Defined Symbol List window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

The window displays each user-defined symbol and their object type.
If required, symbols may only be displayed from a specific library. Select the required
standard from the Library list.

Note: New libraries are created in the Enhanced CBD Symbol Detail window. Refer to
Create New Symbols for details.

If only a certain type of symbol is required to be displayed (e.g. MCCs), select it from the
Type list.
Use the scale slider at the bottom of the window or the + and - buttons at either end of this
slider to zoom in and out of this display. Click Max to increase the zoom level to the
maximum level. Click Restore to return the zoom level to the default level.
Continue at:
• Create New Symbols
• Cable Label Symbols
• Copy Symbols
• Import Symbols from another Project
• Edit Symbols
• Delete Symbols

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

10.5.1 Create New Symbols


To create a new symbol, click New. The Enhanced CBD Symbol Detail window is then
displayed:

Enter the name of the new symbol in the Name field.


Select the library to which the symbol is to be added from the Library field list.
To create a new library, enter its name in the Library field. The new library will be created
when the new symbol is saved.
Select the equipment that the symbol is to represent from the Object type list.
Once an object type has been selected, the list of datalinks relevant to the selected object
type is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

This list consists of all the fields that object type which may be selected to label the symbol,
divided into categories that can be expanded to view their contents by clicking on the
category title.
To select a datalink to label the symbol, select it from the list then drag and drop it onto the
drawing pane in the required position. For example:

Datalinks can subsequently be dragged and dropped to other positions as required.


To edit datalink text, right-click on the datalink and select the Edit Text option from the menu
that is then displayed, and enter the new datalink text:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

To delete a datalink, right-click on it and select the Delete option from the menu that is then
displayed.
To delete all datalinks, right-click on a datalink and select the Delete All option from the
menu that is then displayed.
To change the anchor point of the datalink text, right-click on it and select the Anchor option
from the menu that is then displayed, then select the Left, Centre or Right option as
required.
To change the font used for the datalink text, click Font. The Select Font window is then
displayed:

Select the required Font Family, Style, Weight, Stretch and Size and click OK.
To draw the new symbol, click Open Symbol Editor. The Symbol Editor window is then
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Used to undo changes. CTRL+Z may also be used.

Used to redo changes. CTRL+Y may also be used.

Used to import a .dwg file which can then be edited as required. Opens a
standard Windows Open window from which the required file can be selected.

Pointer control used to select, move, resize and reshape objects in the
drawing pane.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Used to place a rectangle in the drawing pane.

Used to place an ellipse in the drawing pane.

Used to place a straight line in the drawing pane.

Pencil tool, used to draw a non-straight line in the drawing pane.

Used to place text in the drawing.

Used to control the font, text size etc. of text placed in the drawing pane.
Opens the Select Font window (as described above).

Used to select the colour of objects and text placed in the drawing pane.
Opens the Select Colour window:

Used to specify the width of the lines of objects placed in the drawing pane.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Used to specify whether or not rectangles and ellipses are to be filled.

Used to specify the symbol line style. Displays the Select Line Style window:

The current position of the cursor in the drawing pane is displayed at the bottom of the
window.
Use the scale slider at the bottom of the window or the + and - buttons at either end of this
slider to zoom in and out of the drawing pane. Click Max to increase the zoom level to the
maximum level. Click Restore to return the zoom level to the default level.
Click OK to save the symbol drawing and exit the window. The symbol is then displayed in
the symbol display pane in the Enhanced CBD Symbol Detail window. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Cancel to exit the window without saving.


In the Symbol Detail window, use the scale slider at the bottom of the window or the + and
- buttons at either end of this slider to zoom in and out of the drawing pane. Click Max to
increase the zoom level to the maximum level. Click Restore to return the zoom level to the
default level.
Click Align to Top Left to move the symbol to the top-left of the symbol display pane.

10.5.2 Cable Label Symbols


In the case of cables, the Enhanced CBD Symbol Detail window is used to define the
labels of cables only, by placing the required datalinks and label symbols. The appearance
of the actual cables themselves is pre-defined and cannot edited.
If a cable label “symbol” is to be the one used in cable block diagrams, check the Default
Cable Label Symbol checkbox.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Note: The default ECBD cable label symbol may be used on Wiring Check Reports,
depending on the Wiring Manager preferences for the project. Refer to Options for
details.

If a cable label symbol has already been set as the one which will be used in diagrams, the
following message will be displayed:

To make the new cable label symbol the default for the diagrams click Yes. Otherwise click
No. The default symbol will remain unchanged.

10.5.3 Copy Symbols


New symbols can be created by copying and changing existing symbols. Select the symbol
to be copied from the User Defined Symbol List window and click Copy Selected. The
Enhanced CBD Symbol Detail window is then displayed with the symbol displayed and
with default name of “copy of <copied symbol name>”. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Edit the symbol and add and edit its details as required (see above for details) and click OK.
The Copy Selected button is disabled if the Multi-Select checkbox is checked.

10.5.4 Import Symbols from another Project


To import symbols from another project, click Import symbols from other project. The
Select an AVEVA Instrumentation Project window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Select the required project and click Select. The Symbol List From Other Project window
is then displayed:

The window lists all the user-defined symbols in the selected project.
Use the scale slider at the bottom of the window or the + and - buttons at either end of this
slider to zoom in and out of the drawing pane. Click Max to increase the zoom level to the
maximum level. Click Restore to return the zoom level to the default level.
To import a symbol, select it and click Import. To select multiple symbols, check the Multi-
Select checkbox and click Import.
If a symbol being imported has the same name as one in the current project a message is
displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

Click Yes to replace the existing symbol with the imported symbol.

10.5.5 Edit Symbols


To edit a symbol, select it from the User Defined Symbol List window and click Edit, or
double-click on it.
The Enhanced CBD Symbol Detail window is then displayed (see above). Edit the symbol
and its details as required and click OK.
The Edit button is disabled if the Multi-Select checkbox is checked.

10.5.6 Delete Symbols


To delete a symbol, select it from the User Defined Symbol List window and click Delete.
To delete multiple symbols, check the Multi-Select checkbox before clicking Delete.

Note: Be careful when deleting symbols as it is possible to delete symbols that have been
added to diagrams. No warning is issued. In such cases, the deleted symbols on
diagrams will be replaced by squares with the words “No Symbol” in them.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Cable Block Diagrams

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

11 Using Wiring Rules

AVEVA Instrumentation uses 'Wiring Rules' to automatically generate typical field


instrument wiring/cabling. Using the Wiring Rules features can save many hours otherwise
required to build devices and their associated terminal arrangements, cables, terminations
etc. in Wiring Manager.
When a Wiring Rule is applied to a field instrument, the following are defined:
• Terminal arrangements - the number of terminals, their markings, sequence.
• Default wire numbers to be used on wire terminations.
• Default cable types - type of cable (individual cores, pairs or triad etc.), whether
shielded/screened, and whether armoured etc.
• Default cable numbers - based of the instruments tag number fields from Instrument
Engineer.
• Default wire terminations at the field devices - how the cable is connected to the field
device terminals (core 1 to terminal 1, core 2 to terminal 2 etc.).
• Default wire terminations at non-field device - how the cable is connected at the other
end.
When wiring based on a Wiring Rule is created, AVEVA Instrumentation creates all the
above automatically. Prior to saving this data AVEVA Instrumentation also enables users to:
• Change the default cable number created by the Wiring Rule.
• Select equipment the cable will terminate to at the other end (from a list of Junction
Boxes, Cabinets etc.).
After accepting defaults (or making changes as required) the Field Device and terminals are
created, the cable is created and terminated at both ends (if equipment has been selected
at the other end). At the other end, AVEVA Instrumentation always uses the next available
spare terminals.
At any time after a Wiring rule is applied, the data that has been generated can be edited by:
• Re-running the Create Wiring command using same Wiring Rule - this enables users to
reassign a Cable No, reassign a Junction Box etc.
• Re-running the Create Wiring command using a new Wiring Rule - this updates
terminal arrangements, cable type, terminations and enables users to reassign a Cable
No, reassign a Junction Box etc.
• Edit the cable details/type using the Cable Schedule user interface.
• Edit terminations using the Terminations user interface.
Wiring Rules can be assigned to tags and data generated from:
• Wiring Manager's Equipment View (right-click on a Junction Box and click Junction
Box Allocations). Refer to Assign Field Devices to Junction Boxes.
• Wiring Manager's Equipment View (right-click on a Field Device and click Create
Wiring). Refer to Create Wiring for Field Devices.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

• Wiring Manager's Equipment List (right-click on a Field Device and click Create
Wiring). Refer to Create Wiring for Field Devices.
• Wiring Manager's Cable Block Diagrams interface (right-click on a Junction Box and
click Junction Box Allocations). Refer to Assign Field Devices to Junction Boxes.
• Instrument Engineer's Instrument Detail window. Refer to Instrument Engineer
documentation.
• Instrument Engineer's Loop Detail window. Refer to Instrument Engineer
documentation.
Wiring Rules can be modified or new rules created by a user. Refer to Wiring Rule
Definitions.

11.1 Assign Field Devices to Junction Boxes


Multiple field device tags may be assigned to junction boxes. As part of this procedure, a
wiring rule may be assigned which will result in the cables/terminations at both the field
device and junction box ends etc. being automatically created based on the selected rule.
Refer to Using Wiring Rules for more information on wiring rules.

Note: Junction boxes and wiring rules can also be assigned to field devices on an
individual device-by-device basis. See Create Wiring for Field Devices.

Note: The maximum number of cables that may be connected to a junction box may
(optionally) be specified on the More Information window accessed from the
Equipment Layout window. If the application of a wiring rule would result in more than
when the maximum number of cables being assigned to it, a message is displayed to
inform the user of this.

From the Wiring Manager Equipment View or from Wiring Manager Cable Block Diagrams
right-click on a Junction Box equipment node. Click Junction Box Allocations from the
menu that is then displayed.
The Allocate Tags to Junction Box window is then displayed. The window shows all tags
currently assigned to the Junction Box, plus details of the cables linking them and the
assigned wiring rule:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

This window allows users to:


• Assign tags to a Junction Box.
• Assign a Wiring Rule to each tag in this view.
Wiring rules may already be assigned to tags when they are created or subsequently
edited, however if this is not the case, or if a different rule is to be applied, this can be
done using this window (each tag selected in the window must have a Wiring Rule
assigned before the Create button is clicked).
• Auto-create terminals, field cables and field cable terminations at both field device and
Junction Box ends based on the Wiring Rule assigned to each tag.

Column Explanations

Select Used to select which tags are processed when the Create button is
clicked.

Seq Defines the sequence (order) in which tags will be assigned to


terminals.

TagNo The item tag number (these tags can only be edited in Engineer).

Code The 'Loop Code' is used by Datalinks in the Designer module to map
information into a loop drawing template when generating CAD
drawings. It is only required if users intend to generate CAD loop
drawings in Designer.

WiringConfig The name of the Wiring Rule to apply to the tag.


To select a Wiring Rule hover the mouse over this cell. A button is then
displayed. Click this button to display the Wiring Rule Definitions
window. See Assign Wiring Rules to Tags for further details.

Terminate When checked, Wiring Manager will terminate wires at the Junction Box
end of the field cable. When unchecked, Wiring Manager connects the
cable to the Junction Box but does not terminate the cores, leaving
them to be terminated manually later.

CableNo This displays the default cable number as created by the wiring rule or
the actual cable number from the Wiring Manager Cable Schedule (if
the cable has been created previously). Enter a new value if required.

Cable Type Displays shows the base cable type. The default cable type comes from
the Wiring Rule catalogue cable (if the cable is not yet created) or from
the Wiring Manager Cable Schedule (if the cable has been created
previously).
Change the cable type by clicking the button that is displayed when the
is hovered over a cell in this column. The Select a Cable from
Catalogue window is then displayed. Refer to Select Catalogue Cable
for further details.

Note: The core sequences of Wiring Rules override those of catalogue


cables. The connection order of a Wiring Rule is always
preserved even if this does not match the core sequence order
defined in the Cable Catalogue.

Toolbar Buttons

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Assign Displays the Select Instruments (s) to Allocate to Junction Box...


window, which lists all tags not yet assigned to a Junction Box. Refer to
Assign Field Devices to Junction Boxes for further details.

Unassign Unassigns selected tags from the current Junction Box.

Select All Checks the Select checkbox of every listed tag.

Print Displays the Terminations report for the Junction Box. Refer to
Termination Reports for further details.

Refresh Reloads current Junction Box tag assignments from the database.

Use Default If non-default cable numbers have been entered, clicking this button
Cables renames them to the default name. A message will be displayed asking
the user to confirm the rename of any cables with non-default names.

Command Buttons

Create Creates all selected tags wiring from the Wiring Rules and data in this
grid.

Save Saves changed data in the grid, but does not create Wiring Rule data.
This allows users to pre-assign junction boxes etc. prior to cable/device
creation and to assign Wiring Rules etc.

Cancel Exits the window without saving or creating wiring data.

11.1.1 Select Tags to Assign to Junction Boxes


On the Allocate Tags to Junction Box window (see Assign Field Devices to Junction
Boxes) click Assign. The Select Instruments (s) to Allocate to Junction Box... window is
then displayed:

By default window shows all tags in the project Instrument List that are not already assigned
to a Junction Box.
Check the Show Tags Assigned to Other Junction Boxes to show tags that have already
been assigned to other junction boxes instead.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Note: Instrument Tags can only be created and edited in the project Instrument List in the
Instrument Engineer application.

To assign a single tag, double-click on the tag record.


To assign multiple tags, check the Select checkbox, then click Assign.
The window is then exited. The selected tags are added to the list of tags in the Allocate
Tags to Junction Box window.

11.2 Create Wiring for Field Devices


To create wiring for individual field devices, in the Equipment View or the Equipment List
right-click on a Field Device and click Create Wiring. The Create Tag Wiring for window is
then displayed:

Explanation:

Tag No The instrument tag number - non editable.

Note: Although the specified Wiring Rule (in the Wiring Config field) defines the
terminal configurations of the Field Device, users can select a different
configurations clicking on the button in the Tag No field and selecting from the list
of configurations in the Select a Field Device Terminal Configuration window
that is then displayed. See Select a Field Device Terminal Configuration.

Loop Dwg Code The 'Loop Code' is used by AVEVA Instrumentation Datalinks to
map information into a loop drawing template when generating CAD
drawings. It is ONLY required if CAD loop drawings are to be
generated in Designer. This 'Loop Code' must be unique for the
current loop for CAD loop drawing creation.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Wiring Config The name of the Wiring Rule to apply to the tag. Select the rule by
clicking the button in the field. The Wiring Rule Definitions window
is then displayed (refer to Assign Wiring Rules to Tags for details).
Select the required rule from the list of rules and click OK. The
selected rule is then displayed in this field.

Junction Box This displays the name of the equipment the cable will run to.
Clicking on the button in this field will display a window used to
Assign a Junction Box.

Note: The maximum number of cables that may be connected to a


junction box may (optionally) be specified on the More
Information window accessed from the Equipment Layout
window. If the application of a wiring rule would result in
more than when the maximum number of cables being
assigned to it, a message is displayed to inform the user of
this.

Terminate When this checkbox is checked, cores will be terminated at the


Junction Box end (on the next available spare terminals). When it is
unchecked, cores will not be terminated at the Junction Box end.
The cores will need to be terminated manually, using Wiring
Manager, by dragging the cable or cores to the desired terminals.

Cable Number This shows the default cable number as created by the wiring rule
or the actual cable number from the AVEVA Instrumentation Cable
Schedule (if the cable has been created previously). Enter a new
value if required.

Cable Type This shows the base cable type. It can be changed by selecting the
cell command button that appears when the mouse is hovered over
this cell. The initial cable type comes from the Wiring Rule
catalogue cable (if the cable is not yet created) or from the Cable
Schedule (if the cable has been created previously). Clicking the
cell button displays the Select a Cable from Catalogue window
allowing a new catalogue cable to be selected. Refer to Select
Catalogue Cable for further information.

Note: The core sequences of Wiring Rules override those of


catalogue cables. The connection order of a Wiring Rule is
always preserved even if this does not match the core
sequence order defined in the Cable Catalogue.

Cable Length Enter a Cable Length here. This length is saved in Wiring
Manager's Cable Schedule.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Command Buttons:

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

Save Saves the changed data in the grid, but does not create Wiring Rule
data. This enables users to pre-assign junction boxes etc. prior to
cable/device creation.

Cancel Exits the window, not saving or creating wiring.

As soon the wiring data is created, all the information generated (or changed) may be
viewed in the Tag Wiring Check Report. Refer to Field Device Wiring Reports.
Field device terminations can also be viewed. Refer to Access the Terminations Window for
further information.

11.2.1 Select a Field Device Terminal Configuration


Although the specified Wiring Rule (in the Wiring Config field of the Create Tag Wiring for
window - see Create Wiring for Field Devices) defines the terminal configurations of the
Field Device, users can select a different configurations clicking on the button in the Tag No
field and selecting from the list of configurations in the Select a Field Device Terminal
Configuration window that is then displayed.

This window shows all Field Devices defined in the Wiring Manager Field Device Catalogue.
Users may add to this list by defining new Field Devices in the Field Device Catalogue.
Select by double-clicking on a Field Device image on the Graphic tab or its record on the
List tab or by clicking on the required image/record and then click Select.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

11.2.2 Assign a Junction Box


When selecting a Junction Box when applying Wiring Rules (see Create Wiring for Field
Devices), the following Assign <Tag Number> to... window is displayed, initially listing all
junction boxes defined in the current plant area:

Select the All Areas option to view equipment in all plant areas.
To assign a Junction Box, double-click on the required equipment tag.
Junction Boxes and other Equipment (other than field devices) can only be created in the
Wiring Manager module.

Note: In order to select another Tag as the Junction Box (cable end) connection that tag
must have previously been created by a Wiring Rule for it to appear in the List of
Equipment. For example, to connect a Field Element to a Transmitter, first the
Transmitter must be created, then the element must be assigned to the Transmitter
(e.g the Transmitter becomes the element's Junction Box).

Note: The instrument Signal Type is shown near the top of this window. This comes from
the Instrument's Signal Type field in the AVEVA Instrumentation Instrument Data
window. However any instrument may be assigned to any junction box, regardless of
signal type.

11.3 Assign Wiring Rules to Tags


Wiring rules can be applied to field devices when:
• allocating tags to junction boxes (see Assign Field Devices to Junction Boxes) by
clicking the button in the Wiring Rule field for a field device in the Allocate Tags to
Junction Box window.
• allocating wiring rules to field devices (see Create Wiring for Field Devices) by clicking
the button in the Wiring Config field in the Create Tag Wiring for window.
The Wiring Rule Definitions window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Select the required rule from the list on the left. If required, use the facilities above the list to
filter the number of rules displayed.
A graphical representation of the rule is displayed on the right. Click OK to apply the rule to
the field device.
The window then exits, and the selected rule is displayed in the Wiring Rule / Wiring
Config field of the window that the Wiring Rule Definitions window was accessed from.
The Cable Number and Cable Type fields are also completed or updated as appropriate.
See Wiring Rule Definitions for information on creating and editing wiring rule definitions.

11.4 Wiring Rule Definitions


In Wiring Manager, Wiring Rules may be created and edited. They may be used to
automatically generate field device wiring. Refer to Using Wiring Rules for more information.
From the Project tab, select Setup, then select Wiring Rule Definitions.
The Wiring Rules Definitions window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

This window contains a list of all Wiring Rules defined in the project database. Refer to Add
a New Wiring Rule Definition for how to create a new Wiring Rule.
When a rule name is clicked in the left-hand list, Wiring Manager will display a graphical
representation of the rule in the pane to the right.
If required, use the facilities above the list to filter the number of rules displayed.
Wiring Rules may be copied and edited to create new rules. This enables users to have a
duplicate rules that use different cable types, for example one for Ex 'e' (explosion proof)
cables and another for EX 'i' (intrinsically safe) cables.
Refer to Copy Existing Wiring Rules and Edit Wiring Rule Definitions for how to copy and
how to edit Wiring Rules.
Wiring Rules may also be imported from another project. Refer to Import Wiring Rule
Definitions for details.
To delete a Wiring Rule, select it from the list and click Delete.

Wiring Rules DataLinks


Field Device Tag Numbers, Cable Numbers, Wire/Signal Numbers and Junction Box
Numbers are represented in a Wiring Rule by Wiring Rule DataLinks. Each of these
property values will contain DataLinks which are translated into their appropriate project
values based on the actual tags being generated when the Wiring Rule is applied.
DataLinks are always surrounded by parenthesis such as: {TagNo-NoDelimiter}.
Users can add character values outside the parenthesis. These characters remain as they
are and are not translated (for example: the '+' and '-' text on ends of Wire Numbers).
In the example above, the Cable No will be created based on the current Tag Number but
with any delimiters removed (e.g. if Tag No is FT-600 then {TagNo-NoDelimiter} is translated

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

to FT600. Users may also add suffixes such as 'A' and 'B' to cable and other DataLinks if
required.
Cable Numbers and Wire Numbers can also be constructed from multiple DataLinks. For
example by concatenating the Tag Prefix {TAGPre}, Tag Function {TAGFNO}, Tag Loop
number {TAGLNO} and Tag Suffix {TAGSUF}.
Normally just the single DataLink {TagNo} or {TagNo-NoDelimiter} would be used. {TagNo-
NoDelimiter} is included as an option as some projects remove delimiters (often dashes '-')
from their Cable and Wire Numbers.
Example of concatenation of DataLinks for a tag number of 61-FT-600A,:
{TAGPre} = 61
{TAGFNO} = FT
{TAGLNO} = 600
{TAGSUF} = A
So:
Cable No (1) = 61FT600A
Wire No (1) = 61FT600A+
Wire No (2) = 61FT600A-
The following DataLinks can be used:

Wiring Rule Instrument Index Field - Description Example for Tag


DataLink 61-PT-600

{TAGNo} TagNo Full Tag Number 61-PT-600

{TagNo- TagNo Full Tag Number with 61PT600


NoDelimiter} delimiters removed

{TAGPre} Prefix Tag Prefix none

{TAGFNO} ISAFunc Tag Function PT

{TAGLNO} LNumber Tag 'Number' part 600

{TAGSUF} Suffix Tag Suffix none

{TAGANO} AreaNo Tag Plant Area 61

{UserField#} Various user-defined fields N/A

11.4.1 Add a New Wiring Rule Definition


Note: This procedures describes how to create completely new Wiring Rules. Wiring Rules
may also be created by copying and editing existing rules. Refer to Copy Existing
Wiring Rulesfor details.

To create a new Wiring Rule, in the Wiring Rule Definitions window, select New.
The Wiring Rule window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Enter the name of the new rule in the Wiring Rule Name field.

Note: All Wiring Rules must have unique names. The maximum length for a Wiring Rule
name is 25 characters.

Next, add the required equipment plus at least one cable, and terminate the cable's cores.

Add Cable
To add a new cable, right-click on drawing canvas. The following menu is then displayed:

Click Add Cable. The Cable window is then displayed:

Enter a DataLink or DataLinks for the cable number in the Cable No field, or select the
required combination from the drop-down list available from this field:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Alternatively click the button next to the field to display the DataLinks window:

Select DataLinks by checking their checkboxes. Select them in the order that they are
required in the cable number.
The DataLinks are displayed at the bottom of the window as the they are selected. When
the required DataLinks have been selected, click Save. The window is then closed and the
DataLinks are displayed in the Cable No field.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

To assign a cable type from the Cable Catalogue, click on the button next to the Catalogue
No field. The Select a Cable from Catalogue window is then displayed:

Double-click on the required cable or click on it and click Select. The window is then closed
and the Catalogue Number is displayed in the Cable No field. The Type is displayed under
this field.
Whenever this Wiring Rule is used in Wiring Manager, the cable created will be that chosen
from the catalogue, with its predefined cores, markings etc.

Add Equipment
To add equipment to the new rule, right-click on drawing canvas. The following menu is then
displayed:

Click Add Equipment. Two further options are then displayed:


• Field Device - used to select from the Wiring Manager Field Device catalogue.
• Junction Box - used to define a terminal strip arrangement.
When a Wiring Rule is assigned to an instrument, all the rule's field device terminals, cables
and terminations are auto-created. A Wiring Rule must always contain at least one Field
Device from the Field Device Catalogue.
If Field Device is selected, the Equipment window is displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Enter a DataLink to represent the Field Device Tag Number from the Equipment No drop-
down list.

Note: There a two different types of field device tags.


1. {TAG} will create a new field device using the current instrument tag number.
2. {TAG?} will cause Wiring Manager to prompt the user for another instrument field
device that already exists in the Wiring Manager project (and is an instrument
assigned to the current instrument tag's loop). This type of tag is not created as it
must already exist. This second option enables users to wire between two different
tags in the same loop (example: a Thermocouple to a Temperature Transmitter,
where a user would first create the Transmitter with one Wiring Rule then create the
Thermocouple with another Wiring Rule using the {TAG?} to represent the
Transmitter in the first Wiring Rule).

Select a Field Device by clicking the button next to the Type field. The Select a Field
Device Terminal Configuration window is then displayed:

This window shows all Field Devices defined in the Wiring Manager Field Device Catalogue.
Users may add to this list by defining new Field Devices in the Field Device Catalogue.
Select by double-clicking on a Field Device image on the Graphic tab or its record on the
List tab or by clicking on the required image/record and then click Select.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

If Junction Box is selected from the pop-up menu, this version of the Equipment window is
displayed:

Select a DataLink to represent the Junction Box (or Equipment) Tag Number from the
Equipment No drop-down list.

Note: A DataLink {JB1} is used to represent any existing equipment. Existing equipment is
not created but is assigned to the tag in the Wiring Rule using Junction Box
assignment.

Enter the number of terminals in the No. of Terminals field. Define just enough terminals to
enable all the field cable wiring to be terminated as required by the Wiring Rule definition.
Wiring Manager uses {JB1} tag to make the Wiring Rule find the next available spare
terminals in the Junction Box or Equipment assigned to the tag. A DataLink of type {JB}
never creates equipment (or equipment terminals), it uses the equipment assigned to the
current tag as the 'Junction Box'.

Terminate Cables
To terminate cable cores (wires in cable) to a Terminal, right-click on the cable (near the end
required to connect). This displays the following menu (in this example the 'from' or left end
was selected).

Select Connect Wire (From). A sub-menu with a list of all cores not yet terminated is
displayed. For example:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

To terminate a Core, click on the core marking then click on the Terminal required to be
terminated on.

Note: The core sequences of Wiring Rules override those of catalogue cables. The
connection order of a Wiring Rule is always preserved even if this does not match
the core sequence order defined in the Cable Catalogue.

Edit or Remove Cable and Equipment


To edit a cable or equipment, right-click on it and select the Edit option from the menu that
is then displayed. The Cable window or Equipment window is then displayed as
appropriate.
To remove a cable or equipment, right-click on it and select the Remove option from the
menu that is then displayed.

Save and Exit


Click Save to save the new rule and exit the window.
See Edit Wiring Rule Definitions for how to subsequently edit a Wiring Rule.

11.4.2 Copy Existing Wiring Rules


Existing Wiring Rules may be copied from the Wiring Rules list then edited to change the
catalogue cable used, wire/ferrule numbers and cable numbers etc.
To copy an existing Wiring Rule, from the Wiring Rule Definitions window select an
existing Wiring Rule and then click Copy.
The Copy window is then displayed:

Enter the name of the copy in the Wiring Rule Name field, and click Save.

Note: All Wiring Rules must have unique names. The current maximum length for a Wiring
Rule name is 25 characters.

The rule is then added to the list of rules in the Wiring Rule Definitions window. It may then
be edited as required (see Edit Wiring Rule Definitions).

11.4.3 Edit Wiring Rule Definitions


To open a Wiring Rule for editing, either double-click the Wiring Rule name in the Wiring
Rule Definitions window or select the rule and click Edit in the toolbar. The Wiring Rule
window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

For details of how to add and edit the details of a Wiring Rule, refer to Add a New Wiring
Rule Definition.

11.4.4 Import Wiring Rule Definitions


Wiring rule definitions can be imported from another project.
From Wiring Rule Definitions window, select Import. This displays the Select an AVEVA
Instrumentation Project window. From this window, select the project from which the
definitions are to be imported.
The Wiring Rule Definitions window is then displayed, listing the definitions in the selected
project:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

To import a definition, double-click on it. The Wiring Rule Definitions window is then closed
and the selected definition is added to the list of definitions in the “target” project.
If a definition with the same name exists in the “target” project, a message will be displayed
to inform the user of this. The definition will not be imported.

11.5 Field Device Wiring Reports


Field Device Wiring Check Reports show a graphical report of all wiring connected to field
devices. The report may be printed directly to a printer or saved as a PDF, XPS or AutoCAD
file.
To view a Field Device Wiring Check Report, in the Equipment View, right-click on the Field
Device and select the Wiring Check Report from the menu.
This option will only be available for field devices that have had wiring created for them.
The Wiring Check Report window is then displayed:

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

To view and edit the terminations of a field device or other item of equipment, right-click on it
and select Edit Terminations. The Terminations window is then displayed. Refer to
Terminations User Interface for further information.
To access a graphical report on the terminations of an equipment item, right-click on it and
select Termination Report. A Termination report is then displayed. Refer to Termination
Reports for further information.
Various functions are available to the user via the File, Edit, View and Layout drop-down
menus, or by clicking the required button on the toolbar.

File Menu
Save Saves the report to the database. This option is available on
the toolbar.

Refresh Updates and reloads the Equipment data and refreshes the
window. This option is available on the toolbar.

Recreate Diagram Not applicable to Wiring Reports.

Export to PDF Exports the report to a .PDF format file in the project’s
Drawing folder. The filename used is either the Sketch
Number, as defined in the Equipment List, or if no sketch
number exists, the Equipment number.

Export to XPS Exports the report to an .XPS format file in the project’s
Drawing folder. The filename used is either the Sketch
Number, as defined in the Equipment List, or if no sketch
number exists, the Equipment number.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Export to AutoCAD Selecting this option exports the report to AutoCAD.

Page Setup Displays the Page Setup window, which enables the user to
change the paper size and source, the orientation and the
size of the margins.

Print Preview Displays the Print preview window, which enables the user
to view the report before sending it to a printer. This option is
available on the toolbar.

Print Displays the Print window, which enables allows the user to
customise the print. This option is available on the toolbar.

Printing Enables the user to print the report to a defined size by


selecting a percentage. After a percentage is selected, the
Print preview window is displayed, which enables the user
to view the print before sending to a printer.

Preferences Displays a Preferences window.

Exit Closes the report window.

Edit Menu
Undo Undoes the last command. This option is available on the
toolbar.

Redo Redoes the last undo. This option is available on the toolbar.

Trim Canvas Enables the user to change the size of canvas to the actually
size of the diagram.

Select All Selects all objects.

Find Equipment Displays the Find Text window allowing the user to search
for a string of characters.

Insert Note Opens a text box into which a note can be entered. The text
box can be positioned in the report by clicking on it and
dragging it to the required position.

Insert Rev Used to add a revision information block to the diagram,


which the user may then type the required data into.

Insert Document No. Used to add a document number information block, which
the user may then type the required data into.

View Menu
Show Overview Display the Overview window, which displays all the report
pages.

Predefined percentage Enables the user to select a predefined zoom percentage.

Zoom Normal Sets the report back to the default zoom.

Zoom to Fit Zooms the report to fit all the pages into the window. This
option is available on the toolbar.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Zoom In Increases the image size of the report. This option is


available on the toolbar.

Zoom Out Decreases the image size of the report. This option is
available on the toolbar.

Layout Menu
Align Horizontally Moves two or more selected nodes to the same row, aligned
with the first selected node.

Align Vertically Moves two or more selected nodes to same column, aligned
with first selected node.

Layout Equipment Used to layout diagrams automatically by positioning the


(Flat) Items and routing the links horizontally.

Layout Equipment Used to layout diagram automatically by positioning the


(Tree) Items and routing the links as a tree.

Make Sub Diagram Used to select multiple items of equipment and group them
together in a sub-diagram.

Layout Sub Diagram Used to layout the item inside the sub diagrams
automatically.

Group Selected Used to select multiply items of equipment and group them
together.

Ungroup Selected Used to ungroup multiply items of equipment which were


grouped together using the Group Selected option.

Show Ferrule Numbers Checkbox


The only option on the toolbar not available on the menus is the Show Ferrule Numbers
checkbox. If ferrule numbers are to be displayed on the report instead of signal numbers,
ensure that this checkbox is checked.
The default setting for this checkbox is specified on the Cable/Wires tab of the Preferences
window.

11.5.1 Preferences
Wiring Check Report preferences can be set from the Preferences window. To display the
Preferences window select File > Preferences.

Note: In addition to the preferences described here, the default ECBD cable label symbol
(see Add or Edit Cable Block Diagram Symbols) may be used on Wiring Check
Reports, depending on the Wiring Manager preferences for the project. Refer to
Options for details.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

General Tab

The General tab is used to specify how reports are displayed.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Cables/Wires Tab

The Cable/Wires tab is used to specify how the cables and wires will be displayed in
reports.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Printing Tab

The Printing tab is used to set the default paper size, orientation and margins, the
maximum number of terminals that can be displayed on each page and to add a header and
footer to the pages.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Export Tab

The Export tab is used to define the settings to be used when exporting the report to
AutoCAD.

Note: A user must have AutoCAD installed on their workstation to export a report
successfully.

The user can change the preferences back to the default settings by clicking Use Default.
Click OK to save the changes and close the Preferences window, or Cancel to close the
Preferences window without saving any changes.
If OK is clicked a warning message is displayed, informing the user that applying the new
settings will cause the diagram to reload.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

Click Yes to continue or No to cancel the process.

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Using Wiring Rules

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


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

12 Exports

This section describes the export options available on the Manage tab.
Continue at:
• Export to Excel
• Export to XPS and PDF Files
• Export to AVEVA NET

12.1 Export to Excel


The contents of all the grids and catalogues accessible from the Select option on the Home
tab can be exported to an Excel spreadsheet with same layout of columns and rows.
Data can also be exported to an Excel spreadsheet from a number of windows that display
data in a grid.
For a description of this functionality, refer to the Common Functionality User Guide.

12.2 Export to XPS and PDF Files


The export contents of all the grids and catalogues accessible from the Select option on the
Home tab can be exported to PDF and XPS files.
For a description of this functionality, refer to the Common Functionality User Guide.

12.3 Export to AVEVA NET


AVEVA Instrumentation Wiring Manager includes facilities to export files of item data and
report PDF files for import into AVEVA NET.
The following can be exported:
• Equipment data
• Cable schedule data
• Cable drum schedule data
• Major equipment catalogue data
• Cable catalogue data
• Reports and associated item data (i.e. of the items on the reports)
The files produced by the exported can subsequently be imported into AVEVA NET Portal
(refer to AVEVA NET documentation for details).

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


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

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

Data of various types and from different sources can be exported to AVEVA NET, for
example equipment 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 … 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 … 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.
If, for every object being exported, a separate output file is to be generated, check the
Output File Per Object checkbox.
To select mapping files for the export of data and specify other settings, click Settings. The
Non-CAD Mapping Configuration window is then displayed.

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


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

The mappings between Instrumentation data and AVEVA NET Portal format data are stored
in XML files, one for each of the types of mapping:
• Object Mapping
• Class Mapping
For details of these files, refer to AVEVA NET Export Configuration Files.
Click the appropriate … button to browse for the required file.

Click the open file button to open the selected file. It will open in the default text editor,
for example Notepad.
If no file is specified in the field, a new, blank .txt file is opened. If a file that does not exist is
specified, the user will be asked if they wish to create that file at the specified location. If Yes
is clicked, a new blank .txt file is created and opened for editing.
To populate the fields with the default configuration and mapping files supplied with AVEVA
Instrumentation, click Copy Sample Files.

12.3.2 Export Data from Grids


To export data from the Equipment List, Cable Schedule, Cable Drums, Major Equipment
Catalogue, Cable Catalogue and Reports grids, select the items from the grid and from the
Manage tab, click Publish to AVEVA NET in the Integration section.
The Export To AVEVA NET window is then displayed, showing the progress of the import:

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

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


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

12.3.3 Export Overview


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

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


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

13 Work Packs

Work packs can be created which consist of collections of items with shared project
management requirements or properties. For example, all the items an individual user or
group of users is concerned with may be assigned to a single work pack. Time constraints
may be assigned to work packs, for example the required start and completion dates of
items in the a work pack, so that work can be more easily prioritised.
For a description of this functionality, refer to the Common Functionality User Guide.

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


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

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


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

14 Change Reports

The following change reporting facilities are available in AVEVA Electrical:


• Audit Manager
• Database Revisions

14.1 Audit Manager


AVEVA Instrumentation has an in-built Audit Manager that enables users to view database
changes made during the project in the database audit log. The Audit Log contains a list of
new and old database field values for each AVEVA Instrumentation object and includes a
time stamp and user's name who initiated the change.
For a description of this functionality, refer to the Common Functionality User Guide.

14.2 Database Revisions


AVEVA Instrumentation allows users to make a copy of the current database state by saving
the database as a Database Revision. At any time, the current database can be compared
to a saved Database Revision. The feature can be used to track changes between key
milestones in the project, for example between data when documents were 'Issued for
Tender', 'Issued for Purchase' or 'Issued for Construction'.
For a description of this functionality, refer to the Common Functionality User Guide.

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


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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Reports

15 Reports

AVEVA Instrumentation provides facilities for creating and modifying reports. These are
available with the Reports grid.
For a description of these features, refer to the Common Functionality User Guide.
In addition, the following Wiring Manager-specific “fixed” (non-editable) reports are
accessible from the Reports grid:

I/O List Opens a grid view showing which tags are assigned to which
I/O modules/channels.

Equipment These options display previews of reports listing project


equipment, field devices and junction boxes and their details,
Field Devices in the Report window (refer to the Common Functionality
Junction Boxes User Guide for details).

Tag Linked to Opens a grid view showing which tags are linked to which
Terminals terminals.

Control System Tags Opens a grid view listing all Instrument Engineer tags not
Not Assigned assigned to an I/O Channel.

Cable Cores Not Opens a grid view listing cable cores that are not terminated.
Terminated

Wires Not Terminated Opens a grid view listing wires that are not connected at both
at Both Ends ends.

Cable Length Opens a grid view listing cables with lengths that do not match
Mismatch their design lengths (as imported from AVEVA Cable Design -
refer to 6.13: AVEVA Cable Design Data Interface for details).

Device BOM

I/O Module BOM

Cable BOM These options open grid views displaying bills of materials for
devices, I/O module, cables, cable glands and cable gland
Cable Gland BOM adaptors.

Cable Gland Adaptor


BOM

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
Reports

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
AVEVA NET Export Configuration Files

A AVEVA NET Export Configuration Files

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

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrument Wiring Manager User Guide
AVEVA NET Export Configuration Files

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


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

Index

A Catalogue Cables . . . . . . . . . . . . . 6:12, 6:46


Changing
Access Cable Core Markings . . . . . . . . . . . 6:54
Field Device . . . . . . . . . . . . . . . . . . 5:72 Terminal Markings . . . . . . . . . . . . . 7:22
Terminations . . . . . . . . . . . . . . . . . . . 7:1 Copying Cables . . . . . . . . . . . . . . . . . . 6:16
Adding Copying Cables (with Equipment) . . . . 5:36
Area, Buildings and Equipment Rooms 5:6 Copying Equipment . . . . . . . . . . . . . . . 5:36
Cabinets/Junction Boxes . . . . . . . . . 5:9 Create
Cables to Cable Catalogue . . . . . . 6:46 Links and Looping Wires . . . . . . . . 7:19
Catalogue I/O Module . . . . . . . . . . 5:84 New Equipment . . . . . . . . . . . . . . . 6:15
Devices . . . . . . . . . . . . . . . . . . . . . . 5:28 New Project Cable . . . . . . . . . . . . . . 6:5
DIN Rails . . . . . . . . . . . . . . . . . . . . 5:27 Wiring Re-running . . . . . . . . . . . . . 11:1
Earth Bars . . . . . . . . . . . . . . . . . . . 5:25 Create or Import Multiple Major Equipment 5:43
Equipment to the Catalogue . . . . . . 5:71
Field Devices . . . . . . . . . . . . . . . . . 5:11
Group Labels . . . . . . . . . . . . . . . . . 5:34
D
Terminal Strips . . . . . . . . . . . . . . . . 5:25 Defining
Assign New Mapping Definition 5:53, 5:67, 6:33,
Cable Glands . . . . . . . . . . . . . . . . . 6:26 6:59, 6:74, 7:31, 7:35, 7:40
Audit Manager . . . . . . . . . . . . . . . . . . . . 14:1 Device Catalogue . . . . . . . . . . . . . . . . . 5:79
Auto Cross Patch Wiring . . . . . . . . . . . . 7:20 DIN Rails
Automatic Ferrule Numbering . . . . . . . . . 8:3 Adding . . . . . . . . . . . . . . . . . . . . . . 5:27
AVEVA Cable Design Data Interface . . 6:35 Drums . . . . . . . . . . . . . . . . . . . . . . . . . . 6:66
AVEVA Electrical . . . . . 5:6, 5:40, 6:3, 7:26
E
C
Editing
Cable Block Diagrams . . . . . . . . . . . . . 10:1 Catalogue Cables . . . . . . . . . . . . . 6:53
Cable Cores not Terminated . . . . . . . . . 6:44 Catalogue Device . . . . . . . . . . . . . 5:82
Cable Definitions . . . . . . . . . . . . . . . . . . 6:25 Catalogue I/O Module . . . . . . . . . . 5:86
Cable Drums . . . . . . . . . . . . . . . . . . . . . 6:66 Catalogue Major Equipment . . . . . 5:71
Cable Ends Editing and Renaming Items in the Equipment
Selecting . . . . . . . . . . . . . . . . . . . . . 6:13 View . . . . . . . . . . . . . . . . . . . . 5:16
Cable Gland Adapter Catalogue . . . . . . 6:64 Equipment Catalogue . . . . . . . . . . . . . . 5:70
Cable Gland Catalogue . . . . . . . . . . . . . 6:62 Equipment List . . . . . . . . . . . . . . . . . . . 5:38

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


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

Export Barriers . . . . . . . . . . . . . . . . . . . . . 5:28


Files . . . . . . . . . . . . . . . . . . . . . . . . 12:4 Reports . . . . . . . . . . . . . . . . . . . . . . . . . 15:1
to AVEVA NET . . . . . . . . . . . . . . . . 12:1 Revision Entry . . . . . . . . . . . . . . . . . . . 5:58
to Excel . . . . . . . . . . . . . . . . . . . . . . 12:1
to XPS and PDF Files . . . . . . . . . . 12:1 S
Export to AVEVA NET . . . . . . . . . . . . . 12:1
Segment Check Reports . . . . . . . . . . . 9:12
F Selecting
Cable Ends . . . . . . . . . . . . . . . . . . 6:13
Ferrule Numbering Rules . . . . . . . . . . . . 8:4 Device . . . . . . . . . . . . . . . . . . . . . . 5:30
Ferrule Numbers . . . . . . . . . . . . . . . . . . . 8:2 I/O Module . . . . . . . . . . . . . . . . . . . 5:33
Field Devices Signal Numbers . . . . . . . . . . . . . . . . . . . 8:1
Assigning to Junction Boxes . . . . . 11:2
Finding and Replacing Text in a Grid . . . 2:5 T

G Terminal Descriptions . . . . . . . . . . . . . 7:24


Terminals
Grid Filters . . . . . . . . . . . . . . . . . . . . . . . 2:5 Pop-up Menu . . . . . . . . . . . . . . . . . . 7:5
Grid Manager . . . . . . . . . . . . . . . . . . . . . 2:5 Reserved . . . . . . . . . . . . . . . . . . . . 7:11
Select . . . . . . . . . . . . . . . . . . . . . . . 7:10
I Spare . . . . . . . . . . . . . . . . . . . . . . . 7:11
Terminate Wires/Cores . . . . . . . . . 7:13
I/O Module Catalogue . . . . . . . . . . . . . . 5:83 Termination
Import Cables from Excel . . . . . . . . . . . 6:30 Access . . . . . . . . . . . . . . . . . . . . . . . 7:1
Import Equipment from Excel . . . . . . . . 5:50 Termination Report . . . . . . . . . . . . . . . 5:57
Import I/O Allocations . . . . . . . . . . . . . . 7:28 Tracing Wire Interconnections . . . . . . . 7:21
Import Multiple Major Equipment . . . . . 5:43
Import Signals from Excel . . . . . . . . . . . 7:38 W
Import Terminations from Excel . . . . . . 7:32
Importing Attached Documents Data . . 5:65 Wire Interconnections . . . . . . . . . . . . . 7:21
Importing Catalogue Cables . . . . . . . . . 6:56 Wire Numbering . . . . . . . . . . . . . . . . . . . 8:1
Importing Catalogue Items from another Project Wire Pop-up Menu . . . . . . . . . . . . . . . . . 7:8
5:87 Wires/Cores
Installation Method . . . . . . . . . . . . . . . . 6:23 Disconnecting . . . . . . . . . . . . . . . . 7:14
Terminating . . . . . . . . . . . . . . . . . . 7:13
L Wiring Manager Features . . . . . . . . . . . . 1:1
Wiring Rule Definitions . . . . . . . . . . . . . 11:9
Link to Instrument Tag . . . . . . . . . . . . . 7:25 Wiring Rules . . . . . . . . . . . . . . . . . . . . . 11:1
Applying . . . . . . . . . . . . . . . . . . . . . 11:1
M Running . . . . . . . . . . . . . . . . . . . . . 11:1
Work Packs . . . . . . . . . . . . . . . . . . . . . 13:1
Major Equipment Catalogue . . . . . . . . . 5:70
Merge Cables . . . . . . . . . . . . . . . . . . . . 6:28
Modifying Earth Bars . . . . . . . . . . . . . . . 5:35
Modifying Terminal Strips . . . . . . . . . . . 5:35
Multiple Devices . . . . . . . . . . . . . . . . . . 5:28

O
Options . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1

R
Relays

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


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like