AVEVA Instrumentation 12.2.SP3 Wiring Manager User Guide
AVEVA Instrumentation 12.2.SP3 Wiring Manager User Guide
AVEVA Instrumentation 12.2.SP3 Wiring Manager User Guide
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.
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
Contents Page
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
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
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
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
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15:1
AVEVA NET Export Configuration Files . . . . . . . . . . . . . . . . . . . . . .A:1
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.
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).
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.
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).
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.
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.
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.
Cable Block Diagrams describes the creation and use of cable block diagrams, that
provide interactive access to project equipment and 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.
AVEVA NET Export explains the configuration required for AVEVA NET Export.
Configuration Files
2 User Interface
When Instrument Wiring Manager starts up the AVEVA Instrumentation Wiring Manager
window is displayed showing the Home tab.
• Claims
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.
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.
Fieldbus Displays the Fieldbus Segments grid view, used to create, edit or
Segments delete Fieldbus segments. Refer to Fieldbus Segments.
Cable Gland Displays the Cable Gland Adapter Catalogue grid view.
Adapters
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.
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.
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.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.
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
Click Add Item to add another marking and enter it the Marking column. To delete a
marking, select it and click Remove Item.
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.
To add another character to this list, enter it in the Polarity Breaker Symbol field and click
the Add button.
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.
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.
This tab is used to set the colours Wiring Manager uses to show different types of internal
equipment components in the Equipment Layout window.
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.
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).
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.
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.
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.
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.
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 (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.
Expand Selected Opens all the sub-”branches” for the selected item.
Also available on the Tools - Equipment Tree tab.
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.
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.
The following options are located on the Tools - Equipment Tree 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
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.
Open for Opens a list of all documents attached to the current equipment. Refer
Selected to Attachments (External Documents) for details.
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.
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.
Note: Buildings shared with AVEVA Electrical can be viewed in AVEVA Electrical but not
edited.
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.
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.
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.
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.
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.
Note: Equipment details derived from catalogue items can subsequently be edited as
required. This will not affect the source catalogue item.
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.
This window is used to specify the tag of the new field device.
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:
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.
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.
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.
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.
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.
• 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.
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.
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.
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.
The window that is displayed when the Add (or Edit Detail) option is selected will depend of
the equipment component type:
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.
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.
Click Auto Ferrule Selected Equipment to apply a Ferrule Rule to the item. Refer to
Update Ferrule Numbers using Ferrule Rules for details.
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.
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:
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.
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.
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.
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.
• 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:
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).
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.
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.
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.
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.
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.
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.
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.
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.
This window also provides a field for entering the new Equipment Number.
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.
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.
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:
• 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.
Shared equipment may be viewed in either application but may only be edited in the
application in which it was created.
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
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.
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
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
Open for Opens a list of all documents attached to the current equipment.
Selected 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.
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.
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.
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.
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.
Select an Area number, enter a unique equipment number, and select a Major Equipment
Catalogue number.
Select an Area number and a Major Equipment Catalogue number, and specify the number
of items to be added.
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.
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.
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).
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.
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.
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.
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.
After the differences have been displayed, the selected list of valid equipment 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 equipment is displayed:
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.
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.
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:
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.
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.
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.
Note: Only the association to the attached document is deleted. Neither the tag or the
actual document file is deleted.
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.
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.
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).
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.
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:
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.
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.
Refer to Working with the Data Grid for information on the grid controls.
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.
Note: Only those devices with their Allow Use checkbox column checked will be available
for use when creating Field Devices.
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:
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.
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: Field Devices shared with AVEVA Electrical can be viewed in AVEVA Electrical but
not edited.
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:
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.
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.
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: Only those devices with their Allow Use checkbox column checked will be available
for use when creating Devices.
Check the Allow Use checkbox as appropriate. Only those devices with their Allow Use
checkbox checked will be available for use when creating Devices.
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:
Note: Users can set a Terminal to be a 'Plug and Socket' or 'Normal' terminal by right-
clicking and setting the Terminal Type.
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.
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.
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.
Important: Changing the number of terminals or the terminal markings changes all devices
in the project that use the current Catalogue Device.
Note: Only those modules with their Allow Use checkbox column checked will be available
for use when creating I/O Modules.
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.
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:
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.
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.
Change the details of the device as required. See Add a Catalogue I/O Module for details.
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.
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:
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).
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.
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.
A shared cable may be viewed in either application but may only be edited in the application
in which it was created.
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.
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.
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
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.
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.
• 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.
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.
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:
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:
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.
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”.
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.
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.
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.
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.
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.
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.
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:
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.
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.
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.
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.
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:
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.
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.
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:
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.
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:
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.
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.
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.
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.
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:
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.
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
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.
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.
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.
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.
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.
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.
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.
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:
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.
After the import is complete, a log of the imported document details is displayed:
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:
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.
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.
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.
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.
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.
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.
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.
Note: Wiring Manager also provides facilities for importing of Catalogue Cables from
another project. Refer to Importing Catalogue Items from another Project.
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.
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).
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 Units Used to define the earth core size units (mm² or AWG).
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.
Additional catalogue data may be entered on this tab to aid design selection.
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.
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.
See Create a New Project Cable for details of the fields in this window.
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.
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.
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
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.
Click Browse and select the Excel file from which data is to be imported. Click Next >.
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.
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.
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:
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:
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:
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.
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:
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.
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.
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.
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.
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.
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:
Click on the required cable drum and click Select. Click Exit to close the window.
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
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.
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.
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:
Click Import to proceed with the import. The import then takes place. After the import is
complete, the following is displayed:
A log of the import is automatically generated in .csv format and opened. For example:
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).
Note: Cables can also be removed from drums manually. See Cable Drum Schedule.
Click on the required cable drum and click Select. Click Exit to close the window.
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.
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
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.
For how to use the Terminations window, refer to Create and Edit Terminations using the
Terminations Window.
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.
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.
Note: To add new devices and/or terminals to the current equipment use the Wiring
Manager's Equipment View window.
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.
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.
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.
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
Links Tab
Add Link (Normal)
Adds links (bridges) between selected
Add Link (Left) terminals. Refer to Create Links and Looping
Wires.
Add Link (Right)
Tools Tab
Undo Undoes the last command.
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.
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.
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).
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.
Edit Signal No. Opens the Change Terminal Marking window, in which the signal
number may be edited. Refer to Change Terminal Markings and
Labels.
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
The Change Terminal Description command is used to add or change device terminal
descriptions. Refer to Add or Change Terminal Descriptions.
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.
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.
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.
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.
• 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.
• 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.
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.
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.
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.
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).
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).
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:
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:
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.
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
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 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.
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
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.
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.
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.
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.
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.
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:
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.
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.).
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.
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.
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
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:
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.
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:
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.
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 >.
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
(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.
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.
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:
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.
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).
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.
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.
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:
Click OK. The log of the import is opened automatically. For example:
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.
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.
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
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:
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.
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.
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.
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.
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.
Zoom to Fit Zooms the report to fit all the pages into the window. 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.
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.
General Tab
Cables/Wires Tab
The Cable/Wires tab is used to specify how the cables and wires will be displayed in
reports.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
8 Wire Numbering
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
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.
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.
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 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.
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:
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.
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:
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.
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.
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.
Note: For this feature to be used, the Use Auto Ferrule Numbering Rules option must be
checked in the Wiring Manager's Options window.
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:
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.
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.
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:
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.
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:
Note: The Fieldbus Devices can be re-positioned in the graphical view by clicking on them
device and dragging to the required position.
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.
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.
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.
To manually connect an instrument, click the instrument and drag the cursor to the
connection point on the Fieldbus Device.
Select the required cables and click Create. The Fieldbus Segment Diagrams window
then refreshes to display the segment wiring.
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.
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).
(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.
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
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
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.
Note: Using the Delete key removes selected objects from the current diagram. It does not
delete the object from the project database.
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
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.
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:
Refer to Create a New Equipment Tag, Select Existing Equipment from a List and Add
Multiple Equipment Wizard for details of these options.
To view and edit equipment/cable terminations, right-click on any Equipment node. A pop-up
menu is then displayed:
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.
• 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: 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.
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.
To add equipment to a diagram, check their Select checkboxes and then click the Select
button.
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.
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:
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.
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).
• 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.
• 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.
Toolbar Options
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).
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:
Add Existing Used to select existing equipment to add to the diagram. Refer to
Equipment Select Existing Equipment from a List for details.
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.
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.
Find Equipment Used to find and select equipment and field devices in the
diagram. Displays the Search window:
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.
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.
When field devices are added to a diagram, the Instrument Tag window is also displayed
(see Add Field Devices for details).
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: 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.
To add all equipment connected either directly or indirectly via other equipment, select the
Add Everything option and click OK.
To add equipment to a diagram, check their Select checkboxes and then click the Select
button.
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.
• Selecting two equipment symbols and then selecting the Create New option from the
Cables menu. Create Cables by Selecting Equipment.
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.
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.
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.
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.
The Symbol List window is then displayed. Refer to Change Symbols for details.
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:
For further details, refer to Termination Reports and Enhanced Termination Reports.
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.
The Show Wiring Check Report option displays the Wiring Check Report for the device.
For example:
Note: Use the second method to delete multiple items. The right-click menu will not be
displayed if multiple items are selected.
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.
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
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).
Size Preferences
These setting effect the size of various components when added to a Cable Block
Diagram.
Equipment Spacing
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 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.
Printing Tab
Printing preferences are used to define printing settings for Cable Block Diagrams, including
Header and Footer text.
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.
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).
Equipment Spacing
Vertical Spacing This setting controls the vertical spacings of automatically
added interconnections and layouts.
Size Preferences
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 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.
Printing Tab
Printing preferences are used to define printing settings for Cable Block Diagrams, including
Header and Footer text.
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.
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.
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
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:
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:
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.
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.
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:
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.
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.
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:
Click Yes to replace the existing symbol with the imported symbol.
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.
• 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.
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:
Column Explanations
Select Used to select which tags are processed when the Create button is
clicked.
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.
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.
Toolbar Buttons
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.
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.
Note: Instrument Tags can only be created and edited in the project Instrument List in the
Instrument Engineer application.
Explanation:
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.
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.
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.
Cable Length Enter a Cable Length here. This length is saved in Wiring
Manager's Cable Schedule.
Command Buttons:
Create Creates all selected tags, cables, termination and other wiring data
from the Wiring Rules and data in this grid.
Save Saves the changed data in the grid, but does not create Wiring Rule
data. This enables users to pre-assign junction boxes etc. prior to
cable/device creation.
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.
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.
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.
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.
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.
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:
To create a new Wiring Rule, in the Wiring Rule Definitions window, select New.
The Wiring Rule window is then displayed:
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:
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:
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.
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:
Enter a DataLink to represent the Field Device Tag Number from the Equipment No drop-
down list.
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.
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:
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.
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).
For details of how to add and edit the details of a Wiring Rule, refer to Add a New Wiring
Rule Definition.
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.
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.
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.
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.
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.
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 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.
Zoom to Fit Zooms the report to fit all the pages into the window. 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.
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.
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.
General Tab
Cables/Wires Tab
The Cable/Wires tab is used to specify how the cables and wires will be displayed in
reports.
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.
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.
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
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.
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.
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:
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.
14 Change 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.
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
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.
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.
Index
O
Options . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
R
Relays