You are on page 1of 868

SmartPlant Electrical

User's Guide

Version 2009 SP5 (6.0.5)


January 2009/June 2012
DELE2-PE-200001R-Updated

Copyright
Copyright 2002-2012 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret
law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph
Corporation.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813

Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the
licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license
for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this
software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee
permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and
delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or
redistribution.

Warranties and Liabilities


All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software or
applicable license for the software product signed by Intergraph Corporation, and nothing stated in, or implied by, this document or
its contents shall be considered or deemed a modification or amendment of such warranties. Intergraph believes the information in
this publication is accurate as of its publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms
of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL EVALUATION AS
TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.

Contents
SmartPlant Electrical Overview ............................................................................................................... 23
Working in a Multi-User Environment ................................................................................................... 24
Getting Started with SmartPlant Electrical ............................................................................................. 25
Connecting to a Plant Group ................................................................................................................. 25
Changing Plant Group Hierarchy Names ....................................................................................... 26
Apply Plant Group Hierarchy Name Changes ................................................................................ 26
Create a Plant Using Reference Data from an Existing Plant .............................................................. 27
Customizing Preferences ......................................................................................................................... 29
Customize General Preferences ........................................................................................................... 29
Customize Preferences for SLD Generation ........................................................................................ 30
Customize All Feeder Load Summary Report Preferences .................................................................. 31
Customize Delete Loads Preferences .................................................................................................. 32
Customize Delete Load Preferences for a Specific Item ...................................................................... 32
Troubleshooting Errors and Rule Inconsistencies ................................................................................ 33
Generating Error Log Files .................................................................................................................... 33
Activate Log File Generation ................................................................................................................. 33
Generate Error Log Files ...................................................................................................................... 34
Troubleshooting Rule Inconsistencies .................................................................................................. 34
Fix Inconsistencies ................................................................................................................................ 35
Troubleshoot Rule Inconsistencies ....................................................................................................... 35
Operator Descriptions and Rule Examples ........................................................................................... 35
Working with Reference Data ................................................................................................................... 37
Reference Data Explorer ...................................................................................................................... 37
Select a Set of Item Tags in the Reference Data Explorer ............................................................ 38
Shipped Reference Data ....................................................................................................................... 39
Create a Reference Item ....................................................................................................................... 40
Copy a Reference Item to the Electrical Index ..................................................................................... 40
Create a Typical Electrical Motor .......................................................................................................... 41
Create Typical I/O Signals .................................................................................................................... 42
Creating Typical Panels ........................................................................................................................ 42
Create a Typical Cabinet ................................................................................................................ 42
Create a Typical Control Station .................................................................................................... 43
Edit Typical Control Station Common Properties ........................................................................... 43
Create a Typical Local Panel ......................................................................................................... 43
Create a Typical Junction Box ........................................................................................................ 43
Create a Typical Circuit ......................................................................................................................... 44
Copy Components to a Typical Circuit ........................................................................................... 44
Copy from Typical Circuit Components .......................................................................................... 45
Create a Profile ..................................................................................................................................... 45
Edit Profile Common Properties ..................................................................................................... 46
Working with Typical Cable Block Diagrams ........................................................................................ 47
Create a Typical Cable Block Diagram .......................................................................................... 48

SmartPlant Electrical User's Guide

Contents
Using Reference Control Stations, Typical Circuits, and Reference Instruments in
Typical CBDs .................................................................................................................................. 49
Using Reference Motors with Space Heaters in Typical CBDs...................................................... 49
Using Reference Junction Boxes and Local Panels in Typical CBDs ............................................ 49
Make Non-Power Flow Associations in a Typical CBD .................................................................. 50
Hide Association Connectors ......................................................................................................... 51
Create Typical Schematic Blocks ......................................................................................................... 51
Edit Typical Schematic Block Common Properties ........................................................................ 52
Create a Typical Schematic .................................................................................................................. 53
Edit Typical Schematic Common Properties .................................................................................. 53
Create a Multi-Sheet Typical Schematic ........................................................................................ 55
Working with Lookup Tables ................................................................................................................. 56
Create Lookup Tables .................................................................................................................... 56
Edit Lookup Tables ......................................................................................................................... 56
Lookup Table Structure Example ................................................................................................... 58
Lookup Table Data Example .......................................................................................................... 58
Enable Additional Regional Standard Lookup Tables .................................................................... 59
Associate and Apply a Lookup Table to a Circuit Internal Component .......................................... 59
Automate the Sizing of Circuit Internal Components Based on Load Data ................................... 60
Reference Electrical Engineer .............................................................................................................. 61
Copy Power Network Structures from Another Plant ..................................................................... 62
Rules Governing the Copying of Power Network Structures to the Electrical
Engineer ......................................................................................................................................... 63
Rules for Copying Branches with Auxiliary Contacts ..................................................................... 64
Creating and Modifying Equipment ......................................................................................................... 65
Using Naming Conventions .................................................................................................................. 65
Electrical Index ...................................................................................................................................... 66
Customizing Folders ....................................................................................................................... 67
Select a Set of Item Tags in the Electrical Index ............................................................................ 69
Customize the Sort Sequence of Items in Tree Folders ................................................................ 70
Show Related Items in a New Electrical Index Window ................................................................. 70
Move an Item to Another Plant Group ............................................................................................ 71
Properties Window ................................................................................................................................ 72
Turn the Display of the Properties Window On or Off .................................................................... 72
Use Select Set Mode in the Properties Window ............................................................................ 72
Review and Edit Item Properties .................................................................................................... 73
Properties Window Toolbar ............................................................................................................ 73
Copy Bulk Properties ...................................................................................................................... 74
Paste Bulk Properties ..................................................................................................................... 75
Customizing Data Display in the Properties Window ..................................................................... 75
Customize Data Display in the Properties Window ........................................................................ 75
Show Brief Properties ..................................................................................................................... 76
Display Null Values in the Properties Window ............................................................................... 76
Add a Text Box for UDFs in the Properties Window ...................................................................... 76
Create a New Item in the Electrical Index ............................................................................................. 77
Create a Project Item Based on a Reference Item ............................................................................... 77
Edit Item Properties .............................................................................................................................. 78
Duplicate an Item .................................................................................................................................. 78
Rename an Item.................................................................................................................................... 79
Delete an Item ....................................................................................................................................... 79
Working with Loads ............................................................................................................................... 81
Create Load Items in Batch Mode .................................................................................................. 82

SmartPlant Electrical User's Guide

Contents
Electrical Motors ............................................................................................................................. 82
Create Static Electrical Equipment ................................................................................................. 85
Create Miscellaneous Electrical Equipment ................................................................................... 87
Managing Space Heaters and Their Power Supplies ........................................................................... 89
Suggested Workflows for Space Heaters and Auxiliary Contacts ................................................. 90
Create a Space Heater ................................................................................................................... 97
Show Space Heaters Next to the Associated Motors in SLDs ....................................................... 97
Use Symbol Assemblies for Space Heaters with Motors in SLDs ................................................. 98
Show Auxiliary Contacts Next to Disconnect Equipment in SLDs ................................................. 98
Use Symbol Assemblies for Disconnect Equipment with Auxiliary Contacts in SLDs
........................................................................................................................................................ 99
Create a Generator ............................................................................................................................... 99
Define a Neutral Earthing Connection for Generators ................................................................. 100
Create an Offsite Power Supply.......................................................................................................... 100
Create a Battery Bank ......................................................................................................................... 101
Converting Equipment ........................................................................................................................ 101
Create Converting Equipment ...................................................................................................... 102
Create a Transformer ................................................................................................................... 102
Define Transformer Connections ................................................................................................. 103
Define Transformer Tapping ........................................................................................................ 104
Define Converting Equipment as Consumers .............................................................................. 104
Power Distribution Equipment ............................................................................................................... 105
Power Distribution Boards and Buses ................................................................................................ 105
Create a Power Distribution Board (PDB) .................................................................................... 106
Create a Bus ................................................................................................................................. 106
Create a Freestanding Bus .......................................................................................................... 107
Delete a Power Distribution Board or a PDB Internal Item .......................................................... 107
Create Disconnect Electrical Equipment ............................................................................................ 108
Create an Auxiliary Contact .......................................................................................................... 109
Metering Equipment ............................................................................................................................ 110
Create Measuring Transformers .................................................................................................. 110
Create Meters ............................................................................................................................... 111
Create Relay Functions ................................................................................................................ 112
Create Protection Relays.............................................................................................................. 112
Copy Metering Equipment ............................................................................................................ 114
Designing Power Distribution Boards ................................................................................................. 114
Design a Power Distribution Board Structure ............................................................................... 115
Design a Power Distribution Board Layout................................................................................... 116
Open a PDB Layout Design for a Selected PDB ......................................................................... 117
Create a Cell ................................................................................................................................. 118
Automate Cell Size Definition ....................................................................................................... 119
Using Dual Source Power Supplies .................................................................................................... 119
Associate a Dual Power Supply with an Equipment Item ............................................................ 120
Change an Alternative Power Supply of an Equipment Item ....................................................... 120
Dissociate an Alternative Power Supply from an Equipment Item ............................................... 121
Using Transfer Switches ..................................................................................................................... 121
Create a Transfer Switch .............................................................................................................. 121
Generate an SLD for a Transfer Switch ....................................................................................... 122
Working with Circuits .......................................................................................................................... 122
Create a Circuit ............................................................................................................................. 122
Copy Circuit Components ............................................................................................................ 123
Apply Typical Circuit Data to a Project Circuit .............................................................................. 123

SmartPlant Electrical User's Guide

Contents
Create Circuit Components .......................................................................................................... 124
Change the Location of a Circuit on a Bus ................................................................................... 124
Populating Items with Data..................................................................................................................... 125
Apply Options to a Set of Tags ........................................................................................................... 126
Apply Lookup Table Data to Equipment ............................................................................................. 126
Apply a Typical Circuit to an Item ....................................................................................................... 127
Apply a Typical Control Station to an Item .......................................................................................... 128
Apply a Typical Schematic to an Item ................................................................................................. 129
Apply a Profile to an Item .................................................................................................................... 130
Apply a Set of Signals to an Item ........................................................................................................ 132
Apply a Typical Cable Block Diagram to an Electrical Item ................................................................ 133
Apply a Typical Schematic to an Instrument ....................................................................................... 134
Panel Management .................................................................................................................................. 135
Create a Cabinet ................................................................................................................................. 135
Create a Control Station ..................................................................................................................... 136
Edit Control Station Properties ............................................................................................................ 136
Create a Local Panel .......................................................................................................................... 137
Create a Junction Box ......................................................................................................................... 137
Define a Junction Box as a Consumer ............................................................................................... 137
Define a Local Panel as a Consumer ................................................................................................. 138
Create a Panel Circuit ......................................................................................................................... 138
Cable Management .................................................................................................................................. 139
Create a Reference Cable .................................................................................................................. 139
Edit Reference Cable Common Properties .................................................................................. 140
Create a Plant Cable ........................................................................................................................... 140
Edit Plant Cable Properties .......................................................................................................... 141
Delete a Cable .................................................................................................................................... 142
Deletion Rules for Cables ............................................................................................................. 142
Cable Glands ...................................................................................................................................... 143
Create Reference Glands ............................................................................................................. 143
Associate Cable Sides with Glands .............................................................................................. 143
Batch Associate Cable Sides with Glands ................................................................................... 143
Batch Dissociate Cable Sides and Glands ................................................................................... 144
Synchronize Cable Glands with Reference Cables in Batch Mode ............................................. 144
Synchronize Cable Gland Associations with a Specific Reference Cable ................................... 145
Size a Cable ........................................................................................................................................ 146
Batch Size Cables ............................................................................................................................... 147
Define Custom Basic Ampacity for Cable Sizing ................................................................................ 148
Example of a Custom Basic Ampacity Lookup Table .................................................................. 149
Use Custom Basic Ampacity to Size Cables ...................................................................................... 150
Required Data for Cable Sizing .......................................................................................................... 151
Thermal Sizing .............................................................................................................................. 151
Voltage Drop Calculations ............................................................................................................ 152
Short Circuit Sizing ....................................................................................................................... 152
Automatic Switch-On of the Sizing Required Flag ....................................................................... 153
Insert a Power Cable Between Equipment Items ............................................................................... 154
Create Parallel Cables ........................................................................................................................ 154
Replace Cables ................................................................................................................................... 155

SmartPlant Electrical User's Guide

Contents
Batch Replace Cable Side Associations ............................................................................................. 157
Single-Core Cable Assemblies ........................................................................................................... 157
Create a Single-Core Cable Assembly in the Electrical Index ..................................................... 157
Create a Single-Core Assembly Based on a Predefined Cable Assembly .................................. 159
Create a Reference Single-Core Cable Assembly ....................................................................... 160
Copy a Single-Core Cable Assembly from the Reference Data Explorer .................................... 161
Add a Single-Core Cable Assembly to a Profile ........................................................................... 162
Create a Busway ................................................................................................................................. 162
Account for the Installed Length of a Cable ........................................................................................ 163
Cable Routing .......................................................................................................................................... 165
Create a Cableway and Segments ..................................................................................................... 165
Assign Cableway Components to Segments ...................................................................................... 166
Define Routing for a Single Cable....................................................................................................... 166
Batch Route Cables ............................................................................................................................ 166
Clear Cable Routing ............................................................................................................................ 167
Set Different Cable Routes for Parallel Cables ................................................................................... 167
Select a Predefined Route for a Cable ............................................................................................... 168
Create a Predefined Cable Route ....................................................................................................... 168
Copy Cable Routing Definitions from Another Cable.......................................................................... 169
Edit Cableway Properties .................................................................................................................... 169
Segment Fill Validation ....................................................................................................................... 169
Set the Method for Segment Fill Validation ........................................................................................ 172
Set the Segment Fill Calculation Criterion .......................................................................................... 172
Cable Drums ............................................................................................................................................ 173
Create a Cable Drum .......................................................................................................................... 174
Edit Cable Drum Properties ................................................................................................................ 175
Assign Multiple Cables to a Cable Drum ............................................................................................ 175
Assign a Single Cable to a Cable Drum ............................................................................................. 176
Batch Assign Cables to Cable Drums ................................................................................................. 177
Optimization of Cable Drum Assignment ............................................................................................ 178
Batch Cable Dissociation from Drums ................................................................................................ 181
Rules Governing Cable Drum Calculations ........................................................................................ 181
Cancel Cable Assignment to a Cable Drum ....................................................................................... 182
Associating Equipment ........................................................................................................................... 183
Electrical Engineer .............................................................................................................................. 183
Find Other Parent Items in the Electrical Engineer ...................................................................... 185
Show Related Items in a New Electrical Engineer Window ......................................................... 186
Create an Electrical Association ......................................................................................................... 186
Rules for Associating Electrical Equipment .................................................................................. 187
Change an Existing Electrical Association .......................................................................................... 191
Rules for Changing Electrical Associations .................................................................................. 192
Dissociate an Item from Its Feeding Item ........................................................................................... 193
Associate Electrical Equipment with Feeders ..................................................................................... 194
Automatic Creation of Feeder Circuits ................................................................................................ 195
Associate Bus Riser Circuits with Coupler Circuits ............................................................................. 196
Associate a Control Station with an Electrical Item ............................................................................ 196
Associate a Control Station with Cables ............................................................................................. 197
Associate Cables of Control Stations with Equipment Circuits ........................................................... 197

SmartPlant Electrical User's Guide

Contents
Associate Cables of Instruments with Equipment Circuits ................................................................. 197
Associate a Power Cable with Electrical Equipment .......................................................................... 198
Associate Additional Power Cables with Electrical Equipment ........................................................... 198
Associate a Non-Power Cable with Electrical Equipment .................................................................. 199
Define Parallel Equipment .................................................................................................................. 200
Rules Governing Parallel Relations .............................................................................................. 201
Connect Equipment Items in Parallel ........................................................................................... 202
Create a Daisy-Chain Connection Pattern .......................................................................................... 202
Move Disconnect Equipment into Circuit ............................................................................................ 203
Move Disconnect Equipment out of Circuit ......................................................................................... 203
Load Association ..................................................................................................................................... 205
Associate Loads with a PDB in Batch Mode ....................................................................................... 205
Associate a Single Load with a PDB................................................................................................... 208
Display Bus Load Data ....................................................................................................................... 211
Balancing Loads.................................................................................................................................. 211
Validate Bus Loads ....................................................................................................................... 211
Balance Bus Loads ....................................................................................................................... 212
Calculating Bus Load Summaries ......................................................................................................... 214
Connectivity Between Buses .............................................................................................................. 219
Calculating Bus Loading ..................................................................................................................... 224
Bus Load Configuration Examples...................................................................................................... 228
Configurations A and B: A Single Load Connected to a Bus ....................................................... 228
Load Power Parameters ............................................................................................................... 228
Configuration C: Bus Totals with or without Converting Equipment Losses ................................ 231
Configuration D: Bus Totals Accounting for Load or Bus Coincidence Factors ........................... 233
Configuration E: A Bus with Mixed Loads .................................................................................... 234
Configuration F: Coupled Buses .................................................................................................. 236
Configuration G: Loads Powered by an Alternative Power Source ............................................. 238
Configuration H: Loads Connected in Parallel ............................................................................. 239
Configuration I: Multiple Loads Connected by a Junction Box ..................................................... 241
Configuration J: Loads Connected in a Daisy-Chain Pattern ....................................................... 243
Configuration K: A Space Heater Connected to an Auxiliary Contact ......................................... 245
Correcting Bus Power Factors Using Capacitor Banks ...................................................................... 247
Handling Special Cases of Bus Load Calculations ............................................................................. 248
Bus Load Calculation Preferences...................................................................................................... 248
Calculating Electrical Consumption After Batch Load Association ..................................................... 249
Flow of Activities for Bus Load Calculations ....................................................................................... 249
Bus, Circuit, and Converting Equipment Properties ........................................................................... 250
Bus Properties .............................................................................................................................. 250
Circuit Properties .......................................................................................................................... 252
Converting Equipment Properties ................................................................................................ 252
Calculate Bus Loads for Selected Buses or PDBs ............................................................................. 253
Calculate Bus Loads for All the Buses in the Plant............................................................................. 253
Generate an Enhanced All Feeder Load Summary Report ................................................................ 254
Drawing Templates.................................................................................................................................. 255
Create a Drawing Template ................................................................................................................ 255
Open a Drawing Template .................................................................................................................. 256
Title Block Macros ............................................................................................................................... 256

SmartPlant Electrical User's Guide

Contents
Plant Group Macros...................................................................................................................... 256
Document Property Macros .......................................................................................................... 257
Document Revision Macros ......................................................................................................... 257
Macros for Multi-Sheet Schematics.............................................................................................. 258
Enable the Renaming of Sheet Tabs in a Drawing ............................................................................. 258
Schematics ............................................................................................................................................... 259
Recommended Workflow for Generating Schematic Drawings .......................................................... 260
Working with the Elements of a Schematic Drawing .......................................................................... 261
Rename the Sheet Tabs in a Schematic Drawing .............................................................................. 262
Macro Definition Guidelines ................................................................................................................ 262
Macros Defined in Catalog Manager ............................................................................................ 263
Macro Syntax ................................................................................................................................ 263
Supported Electrical Items ........................................................................................................... 264
Sequencing Items in Block Macros ..................................................................................................... 265
Handling Load Feeders with Parallel Branches ........................................................................... 266
Handling Incomer and Feeder Circuit Internals ............................................................................ 266
Handling Converting Equipment Items ......................................................................................... 266
Handling Non-Power Related Items of Schematic Drawings ....................................................... 266
Macro Sequencing Example C ..................................................................................................... 269
Macro Sequencing Example D ..................................................................................................... 270
Macro Sequencing Example E ..................................................................................................... 271
Macro Sequencing Example F ..................................................................................................... 272
Generate a Schematic ........................................................................................................................ 273
Generate a Schematic for an Instrument ..................................................................................... 273
Generate a Multi-Item Schematic ....................................................................................................... 274
Generate a Multi-Item Schematic for a Bus ........................................................................................ 276
Set Units of Measure for Generated Schematic Drawings ................................................................. 277
Including Enhanced SmartLoop Reports with Schematics ................................................................. 277
Include Enhanced SmartLoop Reports with Schematics .................................................................... 278
Generate Schematics in Batch Mode ................................................................................................. 278
Open a Schematic Drawing ................................................................................................................ 279
Save a Schematic as an External File ................................................................................................ 279
Create Schematic Blocks in Catalog Manager ................................................................................... 279
Use a Complete Symbol File to Create Schematic Blocks in Catalog Manager ................................ 280
Create Schematic Blocks in SmartSketch .......................................................................................... 280
Guidelines for Creating Schematic Blocks in AutoCAD and MicroStation.......................................... 281
Single Line Diagrams .............................................................................................................................. 283
Working with SLD Elements ............................................................................................................... 285
Generating New Single Line Diagrams ............................................................................................... 287
Generate an SLD from the Electrical Engineer ............................................................................ 288
Generate a Single Line Diagram for a PDB ................................................................................. 289
Break Bus Symbols into Sections ................................................................................................ 290
Generate a Manual SLD ............................................................................................................... 291
Generate Multiple Single Line Diagrams for PDBs in Batch Mode .............................................. 291
Generate an SLD with a Bus Tie and Internal Components ........................................................ 292
Abort SLD Generation Process .................................................................................................... 293
Opening Existing Single Line Diagrams ............................................................................................. 293
Open an SLD Based on an Electrical Engineer Item ................................................................... 294
Open an SLD for a Power Distribution Board............................................................................... 294
Open an SLD from the Documents Folder ................................................................................... 294

SmartPlant Electrical User's Guide

Contents
Save a Single Line Diagram as an External File ................................................................................ 295
Show Control Stations in an SLD........................................................................................................ 295
Show Metering and Relaying Equipment in an SLD ........................................................................... 295
Displaying Equipment Connected in Parallel ...................................................................................... 296
Set Parallel Equipment Display Options ....................................................................................... 301
Hide PDB Sub-Items in an SLD .......................................................................................................... 302
Set the Extent of Downstream Branches ............................................................................................ 302
Placement of Circuits on Bus Sections ............................................................................................... 303
Hide Bus Feeders in an SLD .............................................................................................................. 303
Find an Electrical Item in an SLD........................................................................................................ 304
Insert a Legend in an Existing SLD..................................................................................................... 304
Use Custom Symbols in SLDs ............................................................................................................ 305
Customize a PDB Border (Frame) on an SLD .................................................................................... 305
PDB Frames Examples in SLDs .................................................................................................. 306
Remove an Item from an SLD ............................................................................................................ 307
Creating and Using Symbol Assemblies for SLD Diagrams ............................................................... 308
Create and Use a Symbol Assembly............................................................................................ 309
Gapping Lines ..................................................................................................................................... 309
Perform Line Gapping in Your Drawing Now ...................................................................................... 310
Guidelines for Creating SLD Symbols in Catalog Manager ................................................................ 310
General Guidelines ....................................................................................................................... 310
Connect Points ............................................................................................................................. 310
Origin Point ................................................................................................................................... 311
Special Symbols ........................................................................................................................... 311
Place Symbol Connect Points............................................................................................................. 313
Manipulating Smart Labels ................................................................................................................. 314
Create a Mirror Image of a Smart Label ............................................................................................. 314
Rotate a Smart Label .......................................................................................................................... 314
Align Smart Labels .............................................................................................................................. 315
Rename the Sheet Tabs in an SLD Drawing ...................................................................................... 315
Cable Block Diagrams............................................................................................................................. 317
Creating Cable Block Diagrams .......................................................................................................... 317
Create a Blank Project CBD ......................................................................................................... 318
Create a Project CBD Based on a Typical Cable Block Diagram ................................................ 318
Open an Existing Cable Block Diagram .............................................................................................. 319
Rename the Sheet Tabs in a CBD Drawing ....................................................................................... 320
Working with Smart Data and Auxiliary Graphics in a CBD ............................................................... 320
Place and Connect Items in a Cable Block Diagram .......................................................................... 324
Use Reference Items in a Cable Block Diagram ................................................................................ 325
Use a Reference Circuit in a Cable Block Diagram ............................................................................ 326
Mark Auxiliary Graphics on a Cable Block Diagram ........................................................................... 326
Remove Items from a Cable Block Diagram ....................................................................................... 327
Use Custom Symbols in Cable Block Diagrams ................................................................................. 327
Rules for Connecting to Circuit Symbols ............................................................................................ 328
Resolve Symbol Inconsistencies ........................................................................................................ 328
Hide Cable Types................................................................................................................................ 329
Define a Focal Item for a Cable Block Diagram .................................................................................. 329
Display a Filter Settings Notation in a CBD ........................................................................................ 330
Wiring in SmartPlant Electrical .............................................................................................................. 331
Create a Terminal Strip in the Electrical Index ................................................................................... 331

10

SmartPlant Electrical User's Guide

Contents
Create a Terminal in the Electrical Index ............................................................................................ 332
Define a Reference Terminal Strip Configuration ............................................................................... 332
Apply a Reference Terminal Strip Configuration to a Terminal Strip .................................................. 333
Define a Terminal Strip Configuration for a Single Terminal Strip ...................................................... 333
Wiring Project Items ............................................................................................................................ 334
Define a Connection Type ............................................................................................................ 335
Wire Project Items Using the Custom Connection Method .......................................................... 336
Wire Project Items Using the Continuous Connection Method .................................................... 337
Connect Project Cables in Batch Mode........................................................................................ 339
Connect a Cable Set .................................................................................................................... 340
Connect a Single Conductor ........................................................................................................ 340
Connect a Jumper ........................................................................................................................ 341
Disconnect a Cable, Cable Set, or Conductor in a Wiring Drawing ............................................. 341
Remove Items from a Wiring Drawing .......................................................................................... 342
Customize a Jumper Symbol ....................................................................................................... 342
Open an Existing Wiring Drawing ................................................................................................. 342
Working with Signals .............................................................................................................................. 344
Create a Signal ................................................................................................................................... 344
Associate I/O Signals .......................................................................................................................... 345
Dissociate I/O Signals ......................................................................................................................... 345
Customizing Symbols ............................................................................................................................. 347
Associate a Custom Symbol with Item Tags ...................................................................................... 347
Dissociate a Custom Symbol from an Item Tag ................................................................................. 348
Annotations and Redlining ..................................................................................................................... 349
Insert Annotation Text ......................................................................................................................... 349
Insert Annotation Symbols .................................................................................................................. 350
Edit Annotation Text ............................................................................................................................ 350
Delete Annotations .............................................................................................................................. 351
Insert Redlining Text ........................................................................................................................... 351
Insert Redlining Graphical Elements................................................................................................... 352
Edit Redlining Text .............................................................................................................................. 352
Delete Redlining .................................................................................................................................. 353
Drawing Items .......................................................................................................................................... 355
Find a Drawing Item in the Electrical Index or Electrical Engineer ..................................................... 355
View Associated Drawings of an Item ................................................................................................ 355
Show Related Items ............................................................................................................................ 356
Viewing Drawings................................................................................................................................ 356
Gapping Lines ..................................................................................................................................... 357
Perform Line Gapping in Your Drawing Now ............................................................................... 357
Aligning Drawing Objects .................................................................................................................... 357
Align Drawing Objects .................................................................................................................. 359
Align Command ............................................................................................................................ 360
Manipulating Drawing Items................................................................................................................ 360
Move a Drawing Item.................................................................................................................... 360
Mirror an Item About an Existing Mirror Axis or Linear Element .................................................. 361
Mirror an Item About a Mirror Axis That You Define .................................................................... 361
Mirror Ribbon ................................................................................................................................ 362

SmartPlant Electrical User's Guide

11

Contents
Rotate an Item About an Axis You Define .................................................................................... 362
Rotate Ribbon ............................................................................................................................... 362
Manipulating Smart Labels ................................................................................................................. 363
Create a Mirror Image of a Smart Label ....................................................................................... 364
Rotate a Smart Label.................................................................................................................... 364
Align Smart Labels ....................................................................................................................... 364
Working with Documents ....................................................................................................................... 365
Internal Documents in SmartPlant Electrical ...................................................................................... 365
Add a Document Revision ............................................................................................................ 365
Manage Global Revisions ............................................................................................................ 366
Compare an Archived Document with a Current Document ........................................................ 367
Batch Compare Documents ......................................................................................................... 368
External Documents ............................................................................................................................ 369
Define an External Document Reference ..................................................................................... 369
Associate External Documents with Electrical Items ................................................................... 370
Dissociate an External Document ................................................................................................ 370
Dissociate an External Document from Multiple Electrical Items in Batch Mode ......................... 371
Open an External Document ........................................................................................................ 371
Inserting External Graphics Files into SmartPlant Electrical Templates ............................................. 372
Insert an External Graphics File into a SmartPlant Electrical Template ...................................... 372
Tabular Editor .......................................................................................................................................... 373
Display the Tabular Editor ................................................................................................................... 374
Define a New Tabular Editor View ...................................................................................................... 374
Define a Filter for a Tabular Editor View ............................................................................................. 375
Define a New Layout for a Tabular Editor View .................................................................................. 375
Shipped Default Layouts .............................................................................................................. 376
Modify the Table Properties of an Existing Tabular Editor View ......................................................... 376
Save a Tabular Editor Layout ............................................................................................................. 377
Delete a Tabular Editor Layout ........................................................................................................... 377
Update Tabular Editor Data ................................................................................................................ 377
Search for Tags from the Tabular Editor ............................................................................................ 378
Use AutoFilter in the Tabular Editor .................................................................................................... 378
Copy Data from the Tabular Editor to an External File ....................................................................... 378
Print Tabular Editor Content ............................................................................................................... 379
Reports in SmartPlant Electrical ............................................................................................................ 381
Create a New Customized Report ...................................................................................................... 381
Generate a Report for Selected Items ................................................................................................ 382
Shipped Reports ................................................................................................................................. 382
All Feeder Load Summary (Enhanced) Report ............................................................................ 389
Customizing the Enhanced All Feeder Load Summary Report.................................................... 390
Registering Reports ............................................................................................................................ 391
Register a Report ......................................................................................................................... 391
Include Revision Data in Registered Reports .............................................................................. 391
Save Free Text in Registered Reports ......................................................................................... 393
Associate an Electrical Item with a Registered Report ................................................................ 394
Creating and Editing Report Templates .............................................................................................. 395
Display the Properties of a Report Template ............................................................................... 395
Create a New Blank Report Template .......................................................................................... 395

12

SmartPlant Electrical User's Guide

Contents
Create a Report Template Based on an Existing Template ......................................................... 396
Edit a Report Template................................................................................................................. 396
Define Report Headers ................................................................................................................. 397
Define the Contents of Your Report Template ............................................................................. 398
Define the Layout of a Tabular Format Report Template ............................................................. 400
Define the Layout of a Fixed Format Report Template ................................................................ 402
Define the Layout of a Composite Format Report Template........................................................ 402
Delete a Report Template ............................................................................................................ 403
Using KKS Naming Conventions in SmartPlant Electrical ................................................................. 405
Create a KKS Plant Using a Default DDT File .................................................................................... 407
Creating a KKS Plant Using a Supplied DDT File .............................................................................. 409
Propagation of KKS Names in SmartPlant Electrical.......................................................................... 416
SmartPlant Application Interfaces ......................................................................................................... 423
SmartPlant Instrumentation Interface ................................................................................................. 423
Prerequisites for Working with the SmartPlant Instrumentation Interface .................................... 424
Mapping Plant Groups to SmartPlant Instrumentation ................................................................. 425
Map Plant Groups to SmartPlant Instrumentation ........................................................................ 425
Retrieve Data from the SmartPlant Instrumentation Interface ..................................................... 426
Importing Cables from SmartPlant Instrumentation ............................................................................ 427
Synchronizing SmartPlant Instrumentation and SmartPlant Electrical Reference
Cables........................................................................................................................................... 427
Exporting SmartPlant Instrumentation Cables ............................................................................. 430
Importing Cables to SmartPlant Electrical .................................................................................... 430
Importing the To and From Objects.............................................................................................. 431
Workflow for Importing SmartPlant Instrumentation Cables ........................................................ 431
ETAP - SmartPlant Electrical Bidirectional Interface ........................................................................... 433
ETAP - SmartPlant Electrical Mapped Items ...................................................................................... 433
Preliminary Settings for ETAP ............................................................................................................ 436
Define the ETAP Project Name .................................................................................................... 436
Map ETAP File Location ............................................................................................................... 436
Import ETAP Mapping Data ......................................................................................................... 437
Set the ETAP-SPEL Reference Cable Exchange File Location .................................................. 437
Export SmartPlant Electrical Reference Cables (Power Cables) ................................................. 437
Export SmartPlant Electrical Reference Cables (Cable Specifications) ...................................... 439
Import ETAP Library Cables ......................................................................................................... 440
Publish a Single SLD Drawing to ETAP (Partial Publishing) .............................................................. 441
Publish All Plant SLDs to ETAP (Full Publishing) ............................................................................... 441
Retrieve ETAP Project Data ............................................................................................................... 442
Publishing Data for Interfaces................................................................................................................ 443
Publish Data from SmartPlant Electrical ............................................................................................. 443
Publish Equipment from SmartPlant Electrical ................................................................................... 445
Publishing Data to an External Analyzing Tool ................................................................................... 447
Project Management in SmartPlant Electrical ...................................................................................... 449
Scoping the Project ............................................................................................................................. 450
Understanding Statuses ...................................................................................................................... 450

SmartPlant Electrical User's Guide

13

Contents
Rules for Changing Statuses .............................................................................................................. 451
Modify Project Status .......................................................................................................................... 452
Scoping Items ..................................................................................................................................... 453
Select a Project ............................................................................................................................ 453
Rules for Scoping Items ............................................................................................................... 454
Add Items to the Project Management Table in As-Built.............................................................. 456
Scope Items .................................................................................................................................. 456
Use the Buffer to Scope Items ..................................................................................................... 457
Claiming Items .................................................................................................................................... 457
Add Items to the Project Management Table in a Project ............................................................ 458
Claim Items ................................................................................................................................... 458
Set Claim Mode ............................................................................................................................ 459
Release Claim .............................................................................................................................. 459
Mark Selected Items as Completed ............................................................................................. 460
Clear Mark as Completed ............................................................................................................. 460
Complete a Project ....................................................................................................................... 461
Return a Project to the Active Status ........................................................................................... 461
Release from Merge ..................................................................................................................... 461
Merging Items into As-Built ................................................................................................................. 462
Compare a Document in a Project with a Document in As-Built .................................................. 462
Rules Governing Revisions for Documents Merged Back into As-Built ....................................... 463
Run a Test Merge ......................................................................................................................... 464
Merge All Project Items into As-Built (Full Merge) ....................................................................... 464
Merge Selected Project Items into As-Built (Partial Merge) ......................................................... 465
Miscellaneous Options ........................................................................................................................ 465
Filter the Project Management Table Display .............................................................................. 466
Select a Display Option ................................................................................................................ 466
Generate an Excel Report ............................................................................................................ 467
Working with Off-Site Projects in SmartPlant Electrical ..................................................................... 469
Intercompany Collaboration Prerequisites for SmartPlant Electrical .................................................. 469
Types of Information Handled by Off-Site Projects............................................................................. 470
Scope of Allowed Activities ................................................................................................................. 471
Out of Scope Items ....................................................................................................................... 471
Flowchart for SmartPlant Electrical Off-Site Projects ......................................................................... 472
SmartPlant Electrical Off-Site Projects Workflow ............................................................................... 472
Scope Host Data and Transfer to Off-Site Plant .......................................................................... 474
Transfer Data from the Off-Site Plant to the Host ........................................................................ 482
Rescope and Synchronize Updated As-Built Data ....................................................................... 487
SmartPlant Electrical EPC Greenfield Plant Workflow ....................................................................... 492
Save a Plant Structure.................................................................................................................. 493
Create a Reference Data Package .............................................................................................. 493
Update Reference Data from a Package ..................................................................................... 494
Load a Plant as a Project ............................................................................................................. 495
SmartPlant Electrical Off-Site Projects Reference .............................................................................. 497
Save Project as Offsite Command (File Menu) ............................................................................ 497
Save Project as Offsite Dialog Box .............................................................................................. 498
Save Project for Reload Command (File Menu) .......................................................................... 499
Save Project for Reload Dialog Box ............................................................................................. 499
Save Plant for Merge in Host Command (File Menu) .................................................................. 500
Save Plant for Merge in Host Dialog Box ..................................................................................... 500
Load Offsite Plant Structure Command (File Menu) .................................................................... 501
Load Offsite Plant Structure Wizard ............................................................................................. 501

14

SmartPlant Electrical User's Guide

Contents
Load Plant as Project Command (File Menu) .............................................................................. 512
Load Plant as Project Dialog Box ................................................................................................. 513
Load Standalone Project Command (File Menu) ......................................................................... 514
Load Standalone Project Wizard .................................................................................................. 514
Working with SmartPlant Integration .................................................................................................... 517
Tool Requirements for Integrating SmartPlant Electrical .................................................................... 518
Working with SmartPlant Instrumentation .................................................................................... 518
Working with SmartPlant 3D ........................................................................................................ 519
Working with SmartPlant P&ID ..................................................................................................... 520
Using Projects in an Integrated Environment ............................................................................... 520
Access the SmartPlant Foundation Web Client .................................................................................. 520
Schema Mapping ................................................................................................................................ 521
General Information About Schema Mapping .............................................................................. 521
Mapping Rules and Limitations .................................................................................................... 522
Objects and Relationships ............................................................................................................ 523
Tool Schema Data Model Diagram .............................................................................................. 529
SmartPlant Electrical Mapping Examples .................................................................................... 530
Publish Operation Description ...................................................................................................... 540
Retrieve Operation Description .................................................................................................... 541
Publishing Documents ........................................................................................................................ 543
Prerequisites for Publishing .......................................................................................................... 544
Publish Documents from SmartPlant Electrical ............................................................................ 545
Publish Workflows ........................................................................................................................ 547
Find Documents to Publish from SmartPlant Electrical ................................................................ 548
Retrieving Documents ......................................................................................................................... 549
Retrieve Documents to SmartPlant Electrical .............................................................................. 552
Using the To Do List ........................................................................................................................... 553
Open the To Do List ..................................................................................................................... 553
Modify To Do List Task Properties ............................................................................................... 554
Run Tasks from the To Do List ..................................................................................................... 554
Filter To Do List Tasks.................................................................................................................. 554
Sort To Do List Tasks ................................................................................................................... 555
Defer Tasks from the To Do List .................................................................................................. 555
Remove Tasks from the To Do List .............................................................................................. 555
Display Deleted To Do List Tasks ................................................................................................ 555
Ignore To Do List Tasks ............................................................................................................... 556
Ignore Task Properties ................................................................................................................. 556
Display Ignored To Do List Tasks ................................................................................................ 556
Update the To Do List Display ...................................................................................................... 556
Compare a Document with a Published Version ................................................................................ 557
Menu Commands ................................................................................................................................ 559
Publish Plant Groups Command (SmartPlant Menu) ................................................................... 559
Publish Command (SmartPlant Menu) ......................................................................................... 559
Find Documents to Publish Command (SmartPlant Menu) ......................................................... 559
Retrieve Command (SmartPlant Menu) ....................................................................................... 559
Compare with Published Version Command (SmartPlant Menu) ................................................ 560
Publish to External Analyzing Tool Command (SmartPlant Menu) .............................................. 560
To Do List Command (SmartPlant Menu) .................................................................................... 560
Browser Command (SmartPlant Menu) ....................................................................................... 560
Upgrade Schema Command (SmartPlant Menu) ........................................................................ 560
Windows and Dialog Boxes ................................................................................................................ 561
To Do List Dialog Box ................................................................................................................... 561

SmartPlant Electrical User's Guide

15

Contents
Task Properties Dialog Box .......................................................................................................... 563
Appendix .................................................................................................................................................. 567
SmartPlant Electrical Data Model ....................................................................................................... 567
Customizing Your Data ....................................................................................................................... 567
Electrical Calculations ......................................................................................................................... 569
Calculations for Motors ................................................................................................................. 569
Calculations for Static Loads ........................................................................................................ 571
Earth Loop Impedance Calculation .............................................................................................. 573
Custom Validations and Calculations ................................................................................................. 574
Implement Validation .................................................................................................................... 574
Implement Calculation .................................................................................................................. 576
Validation Code Example ............................................................................................................. 577
Item Type Validation Example ...................................................................................................... 577
Switching the Plant Operational Mode ................................................................................................ 579
Custom Common Properties Forms ................................................................................................... 580
Create a Custom Common Properties Form ................................................................................ 580
Define Custom Forms in SmartPlant Electrical ............................................................................ 582
Select Common Properties Form Dialog Box .............................................................................. 584
Typical Cable Block Diagram Utility Dialog Box ................................................................................. 584
Menu Commands..................................................................................................................................... 587
New > Item Command (File Menu) ..................................................................................................... 587
New > SLD Command (File Menu) ..................................................................................................... 587
New > Template Command (File Menu) ............................................................................................. 587
New > Custom Folder (File Menu) ...................................................................................................... 587
Open > Plant Group Command (File Menu) ....................................................................................... 587
Open > Drawing Command (File Menu) ............................................................................................. 587
Open > PDB Layout Command (File Menu) ....................................................................................... 588
Open > SLD Command (File Menu) ................................................................................................... 588
Open > Template Command (File Menu) ........................................................................................... 588
Open > Log Files Command (File Menu) ............................................................................................ 588
Close Command (File Menu) .............................................................................................................. 588
Save Command (File Menu) ............................................................................................................... 588
Save As Command (File Menu) .......................................................................................................... 588
Preferences Command (File Menu) .................................................................................................... 588
Print Command (File Menu) ................................................................................................................ 589
Sheet Setup Command (File Menu..................................................................................................... 589
Properties Command (File Menu) ....................................................................................................... 589
Exit Command (File Menu) ................................................................................................................. 589
Undo Command (Edit Menu) .............................................................................................................. 589
Redo Command (Edit Menu) .............................................................................................................. 589
Cut Command (Edit Menu) ................................................................................................................. 589
Copy Command (Edit Menu) .............................................................................................................. 590
Paste Command (Edit Menu) .............................................................................................................. 590
Delete Command (Edit Menu) ............................................................................................................ 590
Select All Command (Edit Menu) ........................................................................................................ 590
Duplicate Command (Edit Menu) ........................................................................................................ 590
Rename Command (Edit Menu) ......................................................................................................... 590
Align Command (Edit Menu) ............................................................................................................... 590
Nudge Command (Edit Menu) ............................................................................................................ 591
Move Command (Edit Menu) .............................................................................................................. 591

16

SmartPlant Electrical User's Guide

Contents
Rotate Command (Edit Menu) ............................................................................................................ 591
Mirror Command (Edit Menu) ............................................................................................................. 591
Fit to Page Command (Edit Menu) ..................................................................................................... 591
Activate Connection Mode Command (Edit Menu) ............................................................................. 591
Activate Association Mode Command (Edit Menu) ............................................................................ 591
Show/Hide Association Connectors Command (Edit Menu) .............................................................. 592
Activate Jumper Mode Command (Edit Menu) ................................................................................... 592
Disconnect (Edit Menu) ....................................................................................................................... 592
Change Branch Orientation Command (Edit Menu) ........................................................................... 592
Remove (Edit Menu) ........................................................................................................................... 592
Redlining Command (Edit Menu) ........................................................................................................ 592
Move Cell Command (Edit Menu) ....................................................................................................... 592
Remove Cell Command (Edit Menu) .................................................................................................. 593
Insert > Image Command (Edit Menu) ................................................................................................ 593
Insert > Symbol Command (Edit Menu) .............................................................................................. 593
Insert > Text Command (Edit Menu) ................................................................................................... 593
Insert > Legend Command (Edit Menu) .............................................................................................. 593
Insert > Line Command (Edit Menu) ................................................................................................... 593
Insert > Circle Command (Edit Menu) ................................................................................................ 593
Insert > Rectangle Command (Edit Menu) ......................................................................................... 594
Insert > Curve Command (Edit Menu) ................................................................................................ 594
Text Command (Edit Menu) ................................................................................................................ 594
Document Properties Command (Edit Menu) ..................................................................................... 594
Common Properties Command (Edit Menu) ....................................................................................... 594
Table Properties Command (Edit Menu) ............................................................................................ 594
Transformer Connections and Tapping Command (Edit Menu) ......................................................... 595
Previous Zoom Level Command (View Menu) ................................................................................... 595
Refresh Command (View Menu) ......................................................................................................... 595
Show Selected Electrical Branches Only Command (View Menu) ..................................................... 595
Show in New Window Command (View Menu) .................................................................................. 595
Show Items of All Plant Groups Command (View Menu) ................................................................... 596
Show Related Items (View Menu) ....................................................................................................... 596
Add Filter Command (View Menu) ...................................................................................................... 596
Save Settings Command (View Menu) ............................................................................................... 596
Zoom Area Command (View Menu) ................................................................................................... 596
Zoom In Command (View Menu) ........................................................................................................ 596
Zoom Out Command (View Menu) ..................................................................................................... 596
Fit Command (View Menu .................................................................................................................. 597
Pan Command (View Menu) ............................................................................................................... 597
Show Grid Command (View Menu) .................................................................................................... 597
Snap to Grid Command (View Menu) ................................................................................................. 597
Show Auxiliary Graphics Symbology .................................................................................................. 597
Display > Properties Window Command (View Menu) ....................................................................... 597
Display >Working Area Command (View Menu) ................................................................................ 597
Display >Item Status in Project Command (View Menu) .................................................................... 597
Toolbars Command (View Menu) ....................................................................................................... 597
Design PDB Layout Command (Actions Menu) .................................................................................. 598
Batch Load Association Command (Actions Menu) ........................................................................... 598
Total Bus Load Validation Command (Actions Menu) ........................................................................ 598
Calculate Bus Loads > Selected PDBs or Buses Command (Actions Menu) .................................... 598
Calculate Bus Loads > All Plant Buses Command (Actions Menu).................................................... 598
Associate Bus with PDB Command (Actions Menu) .......................................................................... 598
Dissociate Bus from PDB Command (Actions Menu)......................................................................... 598

SmartPlant Electrical User's Guide

17

Contents
Generate SLD for PDB Command (Actions Menu) ............................................................................ 599
Generate Schematic Command (Actions Menu) ................................................................................ 599
Define Document Reference Command (Actions Menu) ................................................................... 599
Associate Documents Command (Actions Menu) .............................................................................. 599
Global Revisions Command (Actions Menu) ...................................................................................... 599
Compare Documents Command (Actions Menu) ............................................................................... 599
Resolve Symbol Inconsistencies Command (Actions Menu) ............................................................. 599
Associate Custom Symbols Command .............................................................................................. 600
Dissociate Command (Actions Menu) ................................................................................................ 600
Move Items Command (Actions Menu) .............................................................................................. 600
Switch Plant Operational Mode Command (Actions Menu) ............................................................... 600
Cables > Batch Size Cables Command (Actions Menu) .................................................................... 600
Cables > Replace Cables Command (Actions Menu) ........................................................................ 600
Cables > Apply Reference Data to Cables Command (Actions Menu) .............................................. 601
Cables > Assign Drums to Cables Command (Actions Menu) ........................................................... 601
Cables > Predefined Routes Command (Actions Menu) .................................................................... 601
Cables > Batch Cable Routing Command (Actions Menu) ................................................................. 601
Cables > Define Color Pattern Command (Actions Menu) ................................................................. 601
Cables > Refresh Load Data for Power Cables Command (Actions Menu) ....................................... 601
Cables > Associate Cables with Equipment Circuits Command (Actions Menu) ............................... 601
Cables > Batch Cable Side and Gland Associations Command (Actions Menu) ............................... 602
Cables > Batch Cable Connection Command (Actions Menu) ........................................................... 602
Cables > Batch Cable Dissociation from Drums Command (Actions Menu) ...................................... 602
Cables > Insert Power Cable (Actions Menu) ..................................................................................... 602
Parallel Equipment Assistant Command (Actions Menu) ................................................................... 602
Fix Inconsistencies Command (Actions Menu) ................................................................................... 603
Copy Driver Power Absorbed (Actions Menu) .................................................................................... 603
Register Report Command (Actions Menu) ........................................................................................ 603
Gap Now Command (Tools Menu) ..................................................................................................... 603
Optimize Overlapping Connectors ...................................................................................................... 603
Apply Options Command (Tools Menu) .............................................................................................. 603
Drawing Options Command (Tools Menu) ......................................................................................... 603
Update Select Lists (Tools Menu) ....................................................................................................... 604
Apply Naming Conventions (Tools Menu) .......................................................................................... 604
ETAP Interface > Publish All (Tools Menu) ........................................................................................ 604
ETAP Interface > Retrieve (Tools Menu) ............................................................................................ 604
New Command (Reports Menu) ......................................................................................................... 604
Edit Command (Reports Menu) .......................................................................................................... 604
Delete Command (Reports Menu) ...................................................................................................... 604
Plant Reports Command (Reports Menu) .......................................................................................... 604
My Reports Command (Reports Menu) .............................................................................................. 604
New > Table Command (Window Menu) ............................................................................................ 605
New > Electrical Index Command (Window Menu) ............................................................................ 605
New > Electrical Engineer Command (Window Menu) ....................................................................... 605
New > Reference Data Explorer Command (Window Menu) ............................................................. 605
New > Reference Electrical Engineer Command (Window Menu) ..................................................... 605
New > Project Management Command (Window Menu) ................................................................... 605
SmartPlant Electrical Help Command (Help Menu) ............................................................................ 605
Printable Guides Command (Help Menu) ........................................................................................... 606
SmartPlant Electrical on the Web Command (Help Menu) ................................................................ 606
SmartPlant Electrical Web Forum Command (Help Menu) ................................................................ 606
About SmartPlant Electrical Command (Help Menu) .......................................................................... 606
Copy Command (Edit Menu - Tabular Editor) .................................................................................... 606

18

SmartPlant Electrical User's Guide

Contents
Paste Command (Edit Menu - Tabular Editor) .................................................................................... 606
Select All Command (Edit Menu - Tabular Editor) .............................................................................. 606
Tabular Editor Shortcut Menu ............................................................................................................. 607
Windows and Dialog Boxes.................................................................................................................... 609
General ............................................................................................................................................... 609
Customize Dialog Box .................................................................................................................. 609
Description Dialog Box ................................................................................................................. 610
File Properties Dialog Box (File > Properties) .............................................................................. 610
Move Items to Plant Group Dialog Box ........................................................................................ 612
New Item Dialog Box .................................................................................................................... 612
Open Plant Group Dialog Box ...................................................................................................... 612
Open Plant Structure Dialog Box ................................................................................................. 612
Preferences Dialog Box ................................................................................................................ 613
Select Filter Dialog Box ................................................................................................................ 616
Save as PDF Dialog Box .............................................................................................................. 616
Switch Plant Operational Mode Dialog Box.................................................................................. 617
Toolbars Dialog Box ..................................................................................................................... 617
Toolbars Tab (Customize Dialog Box) ......................................................................................... 618
Update Select Lists Dialog Box .................................................................................................... 618
Associations ........................................................................................................................................ 620
Associated Drawings Dialog Box ................................................................................................. 620
Cables ................................................................................................................................................. 620
Apply Reference Data to Project Cables Dialog Box ................................................................... 620
Assign Drums to Cables Wizard ................................................................................................... 621
Batch Cable Side and Gland Associations Dialog Box ................................................................ 623
Batch Size Cables Window .......................................................................................................... 624
Cable Common Properties Dialog Box......................................................................................... 624
Cable Drum Common Properties Dialog Box ............................................................................... 639
Cable Set Properties Dialog Box .................................................................................................. 641
Cable Sizing Matrix Dialog Box .................................................................................................... 641
Cable Cuts Dialog Box ................................................................................................................. 642
Compare Project and Reference Cable Data Dialog Box ............................................................ 642
Compare Project and Reference Cable Data Dialog Box ............................................................ 643
Define Color Pattern Dialog Box .................................................................................................. 644
Insert Power Cable Dialog Box .................................................................................................... 645
Reference Gland Common Properties Dialog Box ....................................................................... 645
Reference Cable Library Dialog Box ............................................................................................ 647
Replace Cables Dialog Box .......................................................................................................... 647
Select Reference Cable Dialog Box ............................................................................................. 650
Drum Sizes Dialog Box................................................................................................................. 651
Synchronize Gland Associations Dialog Box ............................................................................... 651
Single-Core Cable Assembly Common Properties Dialog Box .................................................... 652
Reference Single-Core Cable Assembly Common Properties Dialog Box .................................. 653
Cable Block Diagrams ........................................................................................................................ 655
Create New Plant Circuits Dialog Box .......................................................................................... 655
Resolve Symbol Inconsistencies Dialog Box ............................................................................... 655
Cable Routing ..................................................................................................................................... 656
Actual Routing Path Dialog Box ................................................................................................... 656
Batch Cable Routing Dialog Box .................................................................................................. 657
Cableway Common Properties Dialog Box .................................................................................. 658
Cableway Segment Common Properties Dialog Box ................................................................... 658
External Routing Path Dialog Box ................................................................................................ 662

SmartPlant Electrical User's Guide

19

Contents
Reference Cableway Component Common Properties Dialog Box ............................................. 662
Predefined Routes Dialog Box ..................................................................................................... 664
Route Properties Dialog Box ........................................................................................................ 664
Routing Path Dialog Box .............................................................................................................. 665
Custom Folders ................................................................................................................................... 666
Custom Folder Properties Dialog Box .......................................................................................... 666
Filter Properties Dialog Box .......................................................................................................... 666
New Custom Folder Dialog Box ................................................................................................... 667
Select Filter Dialog Box ................................................................................................................ 668
Electrical Equipment ........................................................................................................................... 668
Apply Options Dialog Box ............................................................................................................. 668
Batch Load Association Dialog Box ............................................................................................. 674
Battery Bank Common Properties Dialog Box ............................................................................. 680
Converting Equipment Common Properties Dialog Box .............................................................. 683
Copy Driver Power Absorbed Dialog Box .................................................................................... 689
Description Dialog Box ................................................................................................................. 690
Disconnect Electrical Equipment Common Properties Dialog Box .............................................. 690
Electrical Motor Common Properties Dialog Box ......................................................................... 691
Generator Common Properties Dialog Box .................................................................................. 701
Instrument Common Properties Dialog Box ................................................................................. 705
Item Tag Dialog Box ..................................................................................................................... 710
Metering Equipment Common Properties Dialog Box .................................................................. 711
Other Electrical Equipment Common Properties Dialog Box ....................................................... 714
Parallel Equipment Assistant Dialog Box ..................................................................................... 721
Static Load Common Properties Dialog Box ................................................................................ 722
Transformer Connections and Tapping Dialog Box ..................................................................... 729
External Documents ............................................................................................................................ 731
Associate Documents Dialog Box ................................................................................................ 731
Define Document Reference Dialog Box...................................................................................... 732
Interfaces ............................................................................................................................................ 733
Retrieve Document Dialog Box .................................................................................................... 733
Internal Documents and Revisions ..................................................................................................... 733
Batch Compare Documents Dialog Box ....................................................................................... 733
Compare Documents Dialog Box ................................................................................................. 733
Document Properties Dialog Box ................................................................................................. 734
File Properties Dialog Box ............................................................................................................ 739
Global Revisions Dialog Box ........................................................................................................ 741
New Miscellaneous Drawing Dialog Box ...................................................................................... 742
Registered Report Common Properties Dialog Box ..................................................................... 742
Panels ................................................................................................................................................. 743
Cabinet Common Properties Dialog Box...................................................................................... 743
Control Station Common Properties Dialog Box .......................................................................... 747
Project Management ........................................................................................................................... 748
Project Management Table (As-Built) .......................................................................................... 748
Project Management Table (Project) ............................................................................................ 751
Project Status Dialog Box ............................................................................................................. 754
Select Project Dialog Box ............................................................................................................. 755
Power Distribution Boards .................................................................................................................. 755
Add New Internal Item Dialog Box ............................................................................................... 755
Circuit Common Properties Dialog Box ........................................................................................ 755
Circuit Dialog Box ......................................................................................................................... 758
Cell Size Dialog Box ..................................................................................................................... 759
Power Distribution Board Structure Dialog Box ........................................................................... 759

20

SmartPlant Electrical User's Guide

Contents
Select Alternative Power Source Dialog Box ............................................................................... 761
Total Bus Load Validation Dialog Box .......................................................................................... 761
Zoom Options Dialog Box ............................................................................................................ 762
Redlining and Annotations .................................................................................................................. 762
Text Properties Dialog Box ........................................................................................................... 762
Reference Items .................................................................................................................................. 763
Associate Reference Cable Dialog Box ....................................................................................... 763
Equipment Profile Properties Dialog Box ..................................................................................... 764
Lookup Table Properties Dialog Box ............................................................................................ 767
Reference Cable Common Properties Dialog Box ....................................................................... 769
Reference Control Station Common Properties Dialog Box ........................................................ 774
Schematic Sheet Properties Dialog Box ...................................................................................... 774
Select Reference Cable Dialog Box ............................................................................................. 775
Typical Circuit Common Properties Dialog Box ........................................................................... 776
Typical Cable Block Diagram Properties ...................................................................................... 777
Typical Schematic Blocks Dialog Box .......................................................................................... 777
Typical Schematic Common Properties Dialog Box ..................................................................... 778
Reports and Report Templates ........................................................................................................... 779
Define Report Contents Dialog Box ............................................................................................. 779
Define Report Items Dialog Box ................................................................................................... 780
Delete Report Template Dialog Box ............................................................................................. 781
Edit Report Template Dialog Box ................................................................................................. 781
My Reports Dialog Box ................................................................................................................. 782
New Items Dialog Box .................................................................................................................. 782
New Report Template Dialog Box ................................................................................................ 783
Plant Reports Dialog Box ............................................................................................................. 783
Report Options Dialog Box ........................................................................................................... 784
Report Preferences Dialog Box .................................................................................................... 784
Report Properties Dialog Box ....................................................................................................... 785
Schematics.......................................................................................................................................... 785
Batch Generate Schematics Dialog Box ...................................................................................... 785
Generate Schematic Dialog Box .................................................................................................. 786
Multi-Tag Schematic Options Dialog Box ..................................................................................... 788
Options Dialog Box ....................................................................................................................... 788
Sheet Setup Dialog Box ............................................................................................................... 797
Size and Scale Tab (Sheet Setup Dialog Box) ............................................................................ 797
Single Line Diagrams .......................................................................................................................... 798
Single Line Diagram Options Dialog Box ..................................................................................... 798
Batch Options for SLDs Dialog Box ............................................................................................. 810
Open Single Line Diagram Dialog Box ......................................................................................... 811
SLD Legend Dialog Box ............................................................................................................... 811
Change Branch Orientation Dialog Box ....................................................................................... 811
Symbols .............................................................................................................................................. 812
Associate Custom Symbols Dialog Box ....................................................................................... 812
Tabular Editor...................................................................................................................................... 812
Advanced Table Properties Dialog Box ........................................................................................ 813
Custom AutoFilter Dialog Box ...................................................................................................... 815
New Filter Dialog Box ................................................................................................................... 815
Select Filter Dialog Box ................................................................................................................ 815
Table Properties Dialog Box ......................................................................................................... 816
Troubleshooting Errors and Rule Inconsistencies .............................................................................. 816
Log Files Dialog Box..................................................................................................................... 816
Fix Inconsistencies Dialog Box ..................................................................................................... 817

SmartPlant Electrical User's Guide

21

Contents
Rule Inconsistencies Dialog Box .................................................................................................. 817
Rule Properties Dialog Box .......................................................................................................... 818
Wiring .................................................................................................................................................. 821
Batch Cable Connection Dialog Box ............................................................................................ 821
Cable Connection Type Selection Dialog Box ............................................................................. 822
Connection Type Dialog Box ........................................................................................................ 822
Terminal Strip Configuration Dialog Box ...................................................................................... 823
Terminal Strip Common Properties Dialog Box ........................................................................... 824
Terminal Common Properties Dialog Box .................................................................................... 825
Toolbars and Ribbons ............................................................................................................................. 827
Actions Toolbar ................................................................................................................................... 827
Align Ribbon ........................................................................................................................................ 828
Change Toolbar .................................................................................................................................. 829
Draw Toolbar ....................................................................................................................................... 830
Edit Drawing Toolbar .......................................................................................................................... 831
Label Toolbar ...................................................................................................................................... 832
Main Toolbar ....................................................................................................................................... 832
Modify Connector Ribbon ................................................................................................................... 834
Using Help ................................................................................................................................................ 837
Glossary ................................................................................................................................................... 839
Index ......................................................................................................................................................... 853

22

SmartPlant Electrical User's Guide

SECTION 1

SmartPlant Electrical Overview


SmartPlant Electrical enables electrical engineers, designers, maintenance personnel in EPCs,
and plant owners to design and maintain the electrical equipment and documentation for process
plants, refineries, and so forth. SmartPlant Electrical is designed to meet specific needs of
electrical engineers by automating work processes, complying with corporate or project standards
and manipulating electrical data throughout the plant and project life cycle.
The software allows you to create electrical equipment and components and then dynamically
associate among them. You can determine the load requirements in your plant, keep track of
your electrical inventory, size your plant cables, and establish the electrical relationships among
the different electrical components.
You can use SmartPlant Electrical to generate single line diagrams, schematic drawings, wiring
drawings, and cable block diagrams without an external CAD engine and thus generate these
deliverables automatically, creating graphical reports based on the engineering work itself.
Electrical engineering deliverables include electrical equipment list reports, consumer list and load
summaries, power distribution board design, single-line diagrams, cable block diagrams, and
schematic drawings, as well as cable lists and wiring reports.
SmartPlant Electrical supports the major commercial databases and outputs drawings in common
CAD formats including SmartSketch, and generates reports in Microsoft Excel format.
SmartPlant Electrical incorporates the latest Microsoft technologies, such as OLE automation, to
provide integration with existing data and other systems. Running on Microsoft Windows XP,
Windows Vista, and Windows 7, SmartPlant Electrical does not require a traditional, expensive
CAD engine for the creation of single line diagrams, cable block diagrams, or schematics. The
open architecture of SmartPlant Electrical permits integration with other systems, such as
Intergraph SmartPlant Instrumentation and ETAP, which allow users to share data with third-party
software.
In the SmartPlant Electrical main window, the following windows are available:

Electrical Index
Enables you to quickly create, modify, view, and select items in your project inventory. For more
information, see Electrical Index (on page 66).

Reference Data Explorer


Enables you to create your default electrical equipment and data, loads, panels, and cables,
which you can then use to create and populate the project database in an efficient and consistent
manner. The Reference Data Explorer enables you to define equipment profiles, a powerful
means of creating standard data. You can apply this data in batch mode to a large number of
items of the same type, such as motors, resulting in the creation of project items and populating
them with default data. For more information, see Reference Data Explorer (on page 37).

Electrical Engineer
Enables you to create, modify, and display the electrical relations between various electrical
items. In this way, you establish the electrical infrastructure. For more information, see
Electrical Engineer (on page 183).

SmartPlant Electrical User's Guide

23

SmartPlant Electrical Overview


Reference Electrical Engineer
Allows you to copy existing partial or complete power network structures by dragging items from
one or more specified plants to the Electrical Engineer in the current plant. For more
information, see Reference Electrical Engineer (on page 61).

Properties Window
Displays the data fields of the currently selected item in tabular style where you can edit the
property values as needed. For more information, see Properties Window (on page 72).

Tabular Editor
Enables viewing and editing of items of the same type, and batch assignment of properties to a
selected group of items. You can also use the Tabular Editor to select items for including in
reports. For more information, see Tabular Editor (on page 373).

Status Bar
Displays summary information about selected menu items, processes, and tips when performing
particular actions. For more detailed information, refer to the appropriate SmartPlant Electrical
Online Help topic.

Working in a Multi-User Environment


Special considerations apply when several users work on the same item.
The software allows several users to concurrently access and edit the same item. In this case,
the software accepts the changes for the first user to commit those changes. The software then
saves the data committed by the second user overwriting the previously committed data.
Also, if a user deletes an item and commits the deletion, the software rejects changes made by
other users and those users cannot subsequently update the item because the deletion takes
priority. If you get a message that another user has modified or deleted an item that you are
working on, click Refresh
or select another item and then reselect the item you were editing
(if it has not been deleted).

24

SmartPlant Electrical User's Guide

SECTION 2

Getting Started with SmartPlant


Electrical
This section deals with the basic operations of SmartPlant Electrical. You will learn how to
connect to a plant group, create a plant using reference from another plant, and so on.
You will also learn how to create and manage plant and reference items.
Furthermore, you will get acquainted with the interface of commonly used SmartPlant Electrical
windows such as the Electrical Index, Electrical Engineer, Reference Data Explorer, and the
Properties window.

In This Section
Connecting to a Plant Group ......................................................... 25
Create a Plant Using Reference Data from an Existing Plant ....... 27

Connecting to a Plant Group


Before you can work with SmartPlant Electrical, you need to connect to a plant group. A plant
group is a specific group available within a plant hierarchy, for example, Plant1, Area1, Unit1.
Plant, area and unit are examples of plant group types. The available plant group types depend on
the plant hierarchy you define in Engineering Manager.
You can open a plant structure and then connect to a plant group. Also, if you have appropriate
access rights, you can connect to a plant group located on a different site server. You can only
connect to one plant group at a time.
1. Click File > Open Plant Group.
If the Open Plant Group command is not accessible, close all Options Manager
windows.
2. Do one of the following:
Expand the plant hierarchy and then select the desired plant group located on the lowest
hierarchy level.
Click Select Plant and then, under Available plant structures, select a plant to connect.
If you want to connect to a plant in a different database, on the Open Plant Structure
dialog box, click Site Server and from the Files of type list, select the desired .ini file.

SmartPlant Electrical User's Guide

25

Getting Started with SmartPlant Electrical

Changing Plant Group Hierarchy Names


You change the hierarchy group names of the areas and units in your project using SmartPlant
Engineering Manager. A message is displayed at the start of SmartPlant Electrical and
SmartPlant Options Manager informing you that changes have been made to the hierarchy names
and that you should run the Apply Naming Conventions command in SmartPlant Electrical to
complete these changes. Using the Apply Naming Conventions command the changes made
in the hierarchy names are propagated to the item type names through the entire project
according to the definitions created in the Options Manager.

Apply Plant Group Hierarchy Name Changes


1. Change the Plant Group Hierarchy names in SmartPlant Engineering Manager. For more
details, see Change Plant Group Hierarchy Names in the SmartPlant Engineer Manager
User's Guide, under Plant Structure Root, Plant Group Nodes, Change Plant Group Hierarchy
Names.
2. Click Tools > Apply Naming Conventions.
3. At the prompt, do one of the following:
Click Close to continue to work in SmartPlant Electrical.
Click View Log to open a log of the changes made to the hierarchy.

26

A message is displayed at the start of SmartPlant Electrical informing you that changes have
been made to the naming conventions. This message reappears every time SmartPlant
Electrical is run until you use the Apply Naming Conventions command.
Due to the possibility that the naming convention and inter item tag dependency can be very
complex the software runs the Apply Naming Conventions twice. After running the update
there may still be items that have not been updated. You can run the Apply Naming
Conventions again. You can also update the item names by using the Comply with
Naming Conventions in the Plant-Wide Parameters dialog box in SmartPlant Options
Manager.
The changes are made to the item types in a specific order. The running order for the item
type name changes is:
BatteryBank - BatteryCharger - Busway - Cabinet - CableDrum - CableWay - Capacitor CurrentLimitingReactor - Generator - HarmonicFilter - Heater - HeatTrace - JunctionBox LocalPanel - Motor - OffSitePower - OtherConvertingEquipment - OtherElectEquipment PowerDistributionBoard - Resistor - Transformer - UPS - VariableFrequencyDrive - Bus CableWaySegment - ControlStation - Instrument - Ammeter - Circuit - CircuitBreaker Contactor - CurrentTransformer - DisconnectSwitch - Fuse - Multimeter OtherDisconnectEquipment - OverloadRelay - PotentialTransformer - ProtectionRelay SignalRun - Starter - Voltmeter.

SmartPlant Electrical User's Guide

Getting Started with SmartPlant Electrical

Create a Plant Using Reference Data from an Existing


Plant
In SmartPlant Engineering Manager, when you associate a new plant hierarchy with SmartPlant
Electrical, if you already have existing plant data, you can specify an option to copy the reference
data from an existing plant to the new plant. To do so, you first copy an existing plant structure,
and then you load the reference data from the source plant. The copied data includes items from
the Reference Data Explorer and some Options Manager settings.
At least one plant that is already associated with SmartPlant Electrical for use as
your source must exist in the Plant hierarchy tree.
1. In SmartPlant Electrical, open the source plant and create all the reference data that you want
to copy (profiles, lookup tables, reference items, and so forth).
2. In the Options Manager, make the following definitions for the source plant: Formats, Item
Type Definitions, Naming Conventions, General Settings, Plant Default Preferences, and
Project-Wide Parameters.
The software sets the defaults for the locations in the target plant according to the
reference data path that you specify when copy the data (see step 12).
3. In the Options Manager, click Options > Naming Conventions > Copy to Reference Data.

4.
5.
6.
7.
8.
9.

You must perform this step if you want to the naming conventions to be available
for copying when you associate the target plant with SmartPlant Electrical.
Open SmartPlant Engineering Manager.
In the left pane (tree view), select the plant that you want to use as the source plant.
In the right pane, select the application, right-click, and click New Data Dictionary Template.
Navigate to the path where you want to create a template (.ddt) file containing the source
reference data and type a name for the file.
In the left pane, create a new plant or select an existing plant that is not associated with an
application. This will be your target plant.
Right-click the Applications sub- folder for the target plant and click Associate
Applications.

If necessary, expand the plant folder to display the Applications sub-folder.


For details of the Associate Applications wizard parameters, refer to SmartPlant
Engineering Manager Online Help.
10. Under Data dictionary source, click Use custom template.
11. Beside Template path, click the ellipsis button
to navigate to the .ddt file that you
created.
12. To copy values to Options Manager Locations, on the wizard page with the title Enter the
database server and user connection information for SmartPlant Electrical schema,
enter a path in the SmartPlant Electrical reference data path box.
13. On the wizard page with the title Enter the database server and user connection
information for SmartPlant Electrical reference schema, select the check box Load
reference data from <plant name>.
14. Complete the remaining pages of the wizard with the information that you require.

SmartPlant Electrical User's Guide

27

Getting Started with SmartPlant Electrical


15. In Options Manager, copy the naming conventions from the seed plant. For full details about
copying naming conventions, see Options Manager User's Guide > Copy Naming
Conventions for Plant Group.

28

SmartPlant Electrical User's Guide

SECTION 3

Customizing Preferences
You can set various preferences for SmartPlant Electrical. The software allows you to set general
preferences as well as preferences for SLDs, load summary reports, and load deletions.
The general preferences let you specify whether to open a dialog box after creating or duplicating
an item, activating the use of log files for reporting errors after performing some batch operations,
displaying in the Electrical Engineer buses, incomers, and bus risers together with the
associated PDB item tags.
SLD preferences allow you to customize various generation settings such as displaying NULL in
the generated drawing when there is no data, setting various margin settings, setting a distance
for SLD internal elements, and so forth.
The report settings let you specify the data that the software will use to generate your load
summary reports.
The delete load settings allows you to customize which related (sub) items of a main item are
deleted when deleting a main item from the Electrical Index.
Your preferences customization does not affect the preferences set by other users in the
plant. However, a user with Administrator rights can set new defaults and override your
user-defined preferences.

Customize General Preferences


General settings allow you to customize default preferences for creating and duplicating new
items, displaying PDB item tags in the Electrical Engineer, and activating log file generation.
1. Click File > Preferences.
2. On the General tab, under Open after creating or duplicating an item, do one of the
following:
Click None to display a created or duplicated item in the Electrical Index or the
Reference Data Explorer without opening either the Item Tag or Common Properties
dialog box, with a default property value and naming convention defined in Options
Manager.
Click Item Tag dialog box to be able to type text for the item tag right after creating or
duplicating an item.
Click Common Properties dialog box to be able to enter the desired electrical
properties right after creating or duplicating an item.
3. Under Electrical Engineer display options for buses, incomers and bus risers, do one of
the following:
Select the Include associated PDB item tags check box to display in the Electrical
Engineer item tags of buses, bus risers, and incomers together with the item tags of the
associated power distribution boards. For example, MCC \ Bus A.
Clear the Include associated PDB item tags check box to display in the Electrical
Engineer item tags of buses, bus risers, and incomers without the associated PDB item
tags. For example, Bus A.
4. Under Log file options, select Activate log file generation to enable generation of various
error log files.
5. Click OK or another tab.

SmartPlant Electrical User's Guide

29

Customizing Preferences

Customize Preferences for SLD Generation


SLD preferences allow you to customize default preferences for single line (SLD) generation.
1. Click File > Preferences.
2. Click the SLD tab.
3. Under SLD drawings, do one of the following:
Select the Save settings of last generated drawing check box to apply settings defined
for the last generated drawing to all subsequent generations.
Clear the Save settings of the last generated drawing check box to save only the SLD
margin preferences and return all the other SLD options to the application defaults.
Selecting the Save settings of the last generated drawing check box instructs the
software to apply all the settings defined on the Single Line Diagram Options dialog box
apart from the settings defined on the Preferences dialog box (SLD margins and Distance
for SLD internals). This preference option takes effect after generating an SLD and applies
to all subsequent SLD generations.
4. Do one of the following:
Select Use bus tie symbols to show a horizontal representation between two buses
using the BusTie.sym file. In this case, the software shows the connection between the
two buses as a straight bus-tie connection without showing the items connected between
and within the circuits. Note that the BusTie symbol is a "circuit" type symbol and has its
first connection point on the rightmost side and the second connection point at the
leftmost side. Also, the item property in the SLD displays only the coupler
information. Furthermore, if you use the Find in SLD command, the software finds the
pertinent coupler and not the bus riser.
Clear the Use bus tie symbols check box to use a vertical representation of a connection
between two buses. This is the standard bus coupler-riser circuit connection
representation that includes both coupler and the riser circuits and displays them as
vertical objects, connected to each other. The software displays both circuits as standard
arrows.
5. Do one of the following to set your preference for the display of electrical item positions when
opening an existing SLD from the Documents folder in the Electrical Index. You can move
the electrical items in the drawing, move and resize the frames that the software draws around
items belonging to PDBs and around circuits in each cell. The software retains these changes
after saving the drawing. Before reopening a saved SLD, you can choose whether or not to
display the last saved position by selecting or clearing the Retrieve last saved position of
electrical items check box.
Select the Retrieve last saved position of electrical items check box to show the
position of electrical items as they were in the last saved drawing.
Clear the Retrieve last saved position of electrical items check box to revert to the
optimized positioning of electrical items by regenerating the SLD.
6. Under SLD margins, select the desired unit of measure (mm or inches) and define the margin
settings.

30

SmartPlant Electrical User's Guide

Customizing Preferences
7. Under Distance for SLD internals, enter values and select a unit of measure for
representation of buses, circuits and circuit components in a generated SLD:
In Distance between circuits, set the horizontal distance between the circuits above and
below the buses.
In Distance between buses, set the horizontal distance between the buses.
In Distance between circuit internals, set the vertical distance between the circuit
internal components (fuses, starters, and so forth).
8. Click OK or another tab.

Customize All Feeder Load Summary Report


Preferences
These options allow you to specify the PDB loads that will take into account the coincidence
factors and whether and how to account for any loads connected to redundant buses.
1. Click File > Preferences.
2. Click the Reports tab.
3. Under Calculation method for All Feeder Load Summary Report, select one of the
following:
Use each load coincidence factor select to use the coincidence factor of each
individual load to calculate the total connected loads on the bus.
Use Bus PDB coincidence factor select to use the average coincidence factors of
the bus to calculate the total connected loads on the bus.
4. Under Inclusion of coupled buses in All Feeder Load Summary Report, select one of the
following:
Do not include coupled buses select to include in the calculation only those loads
that are connected to the current bus and do not include the loads that are connected on
the redundant buses.
Include coupled buses connected by couplers only select to include in the
calculation the loads connected on the current bus as well as loads connected on all the
redundant buses that are connected to the current bus by a coupler circuit.
Include coupled buses connected by couplers and bus risers select to include the
loads of the current bus as well as the loads on all the redundant buses that are
connected to the current bus by coupler and riser circuits.
5. Select the Account for converting equipment power losses check box to instruct the
software to take into account the power losses when using converting equipment.
The software adds these power losses to the upstream feeding bus and accounts for
them as continuous loads. The same losses are also taken into account in the All Feeder
Load Summary and PDB Load Summary reports.
6. Click OK or another tab.

SmartPlant Electrical User's Guide

31

Customizing Preferences

Customize Delete Loads Preferences


This procedure allows you to customize the Delete Loads default preferences that were set in the
Options Manager.
1. Click File > Preferences.
2. On the Delete Loads tab, under Delete Options select the options you want to apply when
deleting a main item.
3. Click OK or another tab.
Customizing the Delete Loads Preferences in SmartPlant Electrical, overrides the Delete
Loads Preferences set in Options Manager for the specific user. It does not change Option
Manager's settings for other users.

Customize Delete Load Preferences for a Specific Item


1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Select the item you want to delete and do one of the following:
Right-click and on the shortcut menu select, Delete.
Click
.
Click, Edit > Delete
3. On the Confirm Item Delete prompt, click Delete Options.
4. Select or clear the options you want to apply when deleting the selected item.
5. Click Yes.
This procedure overrides the Delete Load Preferences for this specific item only. It does
not change the Delete Load Preferences in the software.

32

SmartPlant Electrical User's Guide

SECTION 4

Troubleshooting Errors and Rule


Inconsistencies
In This Section
Generating Error Log Files ............................................................ 33
Activate Log File Generation ......................................................... 33
Generate Error Log Files ............................................................... 34
Troubleshooting Rule Inconsistencies ........................................... 34
Fix Inconsistencies ........................................................................ 35
Troubleshoot Rule Inconsistencies ................................................ 35
Operator Descriptions and Rule Examples ................................... 35

Generating Error Log Files


There are several batch operations that you can perform in SmartPlant Electrical, some of which
may not be completed or performed due to failures in validations, missing data, and so forth. You
can view a list of errors for these operations in an appropriate log file. Among the operations for
which the software generates log files are applying profiles, batch cable sizing, replacing cables,
batch data deletion, copying and pasting multiple items in the Tabular Editor, and bulk copying
and pasting of values in the Properties window.
The software generates an additional log file called RadApplication log. It is mostly used for
recording problems that may occur when working with the graphic environment of your drawings
and documents. The file also records various general errors that may occur in the process of
using SmartPlant Electrical. In some cases, sending an excerpt from this file or the entire log file
to Customer Support may speed up the process of getting assistance. Note that the software
places the RadApplication log file on the desktop of your client machine.

Activate Log File Generation


1. Click File > Preferences.
2. On the Preferences dialog box, under Log file options in the General tab folder, select
Activate log file generation.
3. Click OK.

SmartPlant Electrical User's Guide

33

Troubleshooting Errors and Rule Inconsistencies

Generate Error Log Files


1. Click File > Open > Log Files.
2. On the Log Files dialog box, select a log file category from the Log file type list.
3. Select one of the following:
All log file data - select to display data and rule inconsistency errors.
Rule inconsistencies only - select to display rule inconsistency errors only.
All log file data excluding rule inconsistencies - select to display data errors only.
4. Select Show log file data for last operation only to display errors for the last performed
operation relating to the specified log file. Clear to display accumulated errors for successive
operations.
5. Click Open.
The software generates the log file in a Microsoft Excel workbook where you can view a
list of any failed operations in the selected category. You can then go back to the Log Files
dialog box, select another log file type, and click Open. The software displays the log file in the
previously opened Excel workbook but in another worksheet.
6. Click Close.
The software creates log files only after you activate the log file option on the General tab
of the Preferences dialog box.

Troubleshooting Rule Inconsistencies


When you modify the value of any property of an item for which rules are defined in the Rule
Manager and the software detects a value that is inconsistent with one or more rules, the software
responds in accordance with the action specified for the inconsistency. You can view
inconsistencies for selected items at the time of data updating, or you can display a summary of
rule inconsistency statistics and view a log file with details of the inconsistencies at any time. The
software displays inconsistencies for values of item properties and of relationship properties
between a main item and an item associated with it.
When viewing inconsistencies at the time of updating, you can choose to accept or reject
inconsistencies where the action specified is Warn. If you accept the inconsistency, the software
saves the data and warns you that the inconsistency exists each time you update the data. If you
reject the inconsistency, the software does not update the database with values that violate the
rules.
When the specified action is Reject, the software does not update the database until you fix the
values that violate the rule.
After viewing inconsistencies, you can change the data values manually as needed to meet the
rule criteria.

34

SmartPlant Electrical User's Guide

Troubleshooting Errors and Rule Inconsistencies

Fix Inconsistencies
This option checks for rule violations, performs any copy rule operations, fixes any inconsistencies
that are found, and displays a summary of rule violations that may have occurred for the selected
items. You can also display the log file in Excel format if you require.
1. Click Actions > Fix Inconsistencies.
2. To display the log file as an .xls file, on the Fix Inconsistencies dialog box, click Show Log.
To make this feature available in SmartPlant Electrical, in the General Settings of
Options Manager, select Enable for the Consistency Rules setting.

Troubleshoot Rule Inconsistencies


This procedure applies when you update any data value for an item where there are one or more
rule violations. After you click OK or Apply on a Common Properties dialog box, or you update
a value in the Properties window or the Tabular Editor, you can view the rule inconsistencies.
1. If a message appears prompting you to view rule inconsistencies, click Yes.
2. On the Rule Inconsistencies dialog box, do one of the following:
Click Reject Operation to close the dialog box without saving updated data values.
Click Accept Inconsistencies to close the dialog box and save the data even though the
data values violate the rules.
Click Close to close the dialog box when one or more rule inconsistencies exist for which
the action is specified as Reject.
The commands Reject Operation and Accept Inconsistencies apply only to
inconsistencies for which the action is Warn. These commands only appear when there are no
inconsistencies that specify the Reject action.

Operator Descriptions and Rule Examples


Describes operators available on the Consistency tab of the Rule Properties dialog box. Also,
provides examples of rules that you can create using a particular operator.
In the examples shown in the table, the rule components are displayed in brackets to
separate them visually from properties or values. When a string that follows an operator does not
start with a bracket, this indicates a single component rule.
Operator

Description

Rule Example

functions as 'equal to' with


numeric characters or as
'like' with text strings

In a filtered subset of 1hp motors:


(Motor) Rated voltage = 120 v

>

greater than

(Cable) Insulation rated voltage > (Motor) Rated


voltage

>=

greater than or equal to

(Motor) Rated power >= (Motor) Brake power

<

smaller than

(Motor) Asynchronous speed < (Motor) Synchronous


speed

SmartPlant Electrical User's Guide

35

Troubleshooting Errors and Rule Inconsistencies

36

Operator

Description

Rule Example

<=

smaller than or equal to

(Motor) Asynchronous speed <= (Motor) Synchronous


speed

<>

or equal to

In a filtered subset of heaters with heater rated power


above 10kW:
(Heater) Number of phases <> 1

IN

any of the specified values

In a filtered subset of 10hp motors:


(Motor) Rated voltage In 380 V; 415 V; 460 V
Comment: The values are case- sensitive and must
be typed exactly as they appear in the Data
Dictionary. The value separator must be either a
semi-colon or a comma.

Is Null

ensures whether the user


Supply ACDC Is Null
enters values for the item tag
belonging to the rule
component

Is Not Null

used for testing or comparing


values or properties in a
conjunction with another rule
consistency

(Cable) Design length >= (Cable) Estimated length


(Cable) Design length Is not Null
(Cable) Estimated length Is not Null
Comment: if you do use the Is Not Null operator in this
rule, the software treats the expression as true even if
the values for the (Cable) Design length and (Cable)
Estimated length properties are not defined at all.

SmartPlant Electrical User's Guide

SECTION 5

Working with Reference Data


Reference items are predefined typical items that you can use to create project items for your
plant in the Electrical Index with the minimum amount of manual data entry.
You create reference items in the Reference Data Explorer. You can create various types of
electrical item, for example motors, cables, panels, junction boxes, control stations, and so on.
Also, you can create typical cable block diagrams, typical schematic blocks, typical schematic
drawings, I/O signals, profiles, and lookup tables. You can then create a project item based on a
reference item by simply dragging a reference item to an appropriate folder in the Electrical
Index.

In This Section
Reference Data Explorer ............................................................... 37
Shipped Reference Data ............................................................... 39
Create a Reference Item ............................................................... 40
Copy a Reference Item to the Electrical Index .............................. 40
Create a Typical Electrical Motor ................................................... 41
Create Typical I/O Signals ............................................................. 42
Creating Typical Panels ................................................................. 42
Create a Typical Circuit ................................................................. 44
Create a Profile .............................................................................. 45
Working with Typical Cable Block Diagrams ................................. 47
Create Typical Schematic Blocks .................................................. 51
Create a Typical Schematic ........................................................... 53
Working with Lookup Tables.......................................................... 56
Reference Electrical Engineer ....................................................... 61

Reference Data Explorer


You use the Reference Data Explorer for creating and managing reference (typical) items that
you use as templates for your project items that are maintained in the Electrical Index. For
details about creating reference items, see Create a Reference Item (on page 40).
The Reference Date Explorer window contains the following sections:
Toolbar
Tree view pane
List view pane
These sections are described below:

Toolbar
The toolbar contains the following options:
Find Click Find
to open the Find dialog box. Click Close to close the active Reference
Data Explorer window.
Refresh Click Refresh
to update the Reference Data Explorer display. This feature is
useful where multiple users are working on the same set of data.

SmartPlant Electrical User's Guide

37

Working with Reference Data


Views Click Views
to toggle through each view of the items in the list view pane, or click
the arrow and select the desired view.
Buttons Buttons provide a useful shortcut to an item or a group of items. Click Buttons
to show or hide existing buttons. To create a button for the currently selected item or folder, click
the arrow and click Add Button. To remove a button, select the button to remove, then click the
arrow, and click Remove Button. Note that if you do not select any button to remove, the
software removes the uppermost button in the list.

Tree View Pane


The tree view pane of the Reference Data Explorer shows typical items organized by
folders. SmartPlant Electrical defines standard folders in the database. You cannot move or
delete these folders, nor can you add new folders. However, you can rename folders if required
or create a custom folder inside a specific item type folder. Each folder contains a particular item
type, and the options available on the menus depend on the currently selected item type.
You can create custom folders in the Reference Data Explorer. For details, see
Customizing Folders (on page 67).
When you select a folder, the number of items in the folder appears in the status bar. You can
customize the sort sequence of items in the folders. For details, see Customize the Sort
Sequence of Items in Tree Folders (on page 70).
Expand or collapse the hierarchy by clicking the + and - icons respectively or by double-clicking a
folder.
After fully expanding a hierarchy, double-click an item to open its Common Properties dialog
box. In the Documents folder, double-clicking a drawing or any other document also opens the
document Common Properties dialog box.

List View Pane


The list view pane of the Reference Data Explorer displays items, other than folders, that are
contained in the currently selected folder or item in the tree view pane.

You can create several instances of the Reference Data Explorer by clicking Window > New
> Reference Data Explorer.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

Select a Set of Item Tags in the Reference Data Explorer


You can make a multiple selection of item tags for performing editing operations in the Reference
Data Explorer or the Electrical Index.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Right-click a folder and adjust the size of the panes to view the items in the list view pane.
3. If required, change the view in the list view pane by clicking View Settings
to toggle
through each view of the items in the list view pane, or click the arrow beside the icon and
select the desired view.
4. Select one or more items in the list view pane. Hold CTRL to select several items or hold
SHIFT to select a range of items.

38

SmartPlant Electrical User's Guide

Working with Reference Data


When you select a set of data, the list at the top of the Properties window displays Select
set and you can type properties that apply to all the items. Also, you can select a specific item
from the list to view or edit its individual properties.

Shipped Reference Data


You create default data and values for each item type, for example motors, heaters, circuit
breakers, or panels, in the Data Dictionary Manager. Default data affects all items at the plant
level and specifies the values that appear when you create new items.
SmartPlant Electrical provides you with a number of predefined default items that appear in the
Reference Data Explorer right after you install the application. These items are provided to you
as samples that you can use to create other default or project items.
The following reference items are available:
Typical motors
Profiles for motors
Look-up tables for motors
Control stations with associated control cables
Typical power, control, and ground cables. (Note that if you want to use the shipped
reference data provided with the application, please validate that these values are appropriate
for cable sizing. Note that shipped reference data is provided to you as uncertified samples
only.)
Typical circuits, including converting equipment of all types other than 3-winding transformers
Typical schematic blocks
Typical schematic drawings

The shipped reference data uses American regional settings; in other countries which use
different regional settings, you have to replace the supplied reference data with data that was
created using the appropriate regional settings, to ensure that the software uses the correct
standard values for performing calculations.
In addition to using the shipped standard reference data, you can populate the plant with
reference data that you can download from a network location using the Options
Manager. The download contains the following reference items:
Lookup tables containing typical IEC motor data
Lookup tables containing typical ANSI motor data
Lookup tables containing NEC motor data with appropriate FLA and LRC values (NEC
tables 430-7b, 430-147 through 151)
IEC reference cables
ANSI reference cables

SmartPlant Electrical User's Guide

39

Working with Reference Data

Create a Reference Item


This procedure explains how to create typical items in the Reference Data Explorer and use
these typical items as templates for new items or for profiles.
1. In the Reference Data Explorer, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders.
2. Right-click the folder or parent item where you are going to add the new item, and then click
New.
3. Accept the default item tag or type a name of up to 80 characters for the item.
4. Edit the item properties in the Properties window according to the catalog information.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You access this dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the item. For full details of the properties, see the
appropriate dialog box topic.

Copy a Reference Item to the Electrical Index


When you copy a reference item containing typical data that you use frequently, you save time by
using the reference item as a template. This way, you do not have to type common values every
time that you create a new item in the Electrical Index.
1. In the Reference Data Explorer, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders until you can see the item that you want to copy.
2. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders and navigate to the folder of the item type corresponding to the item that
you want to copy. For example, to copy a motor, expand the folder hierarchy Electrical
Equipment > Loads > Motors and select the Motors folder.
3. Drag the item from the Reference Data Explorer to the appropriate folder in the Electrical
Index.
You can copy an item from the Reference Data Explorer only to a folder in the
Electrical Index that can contain items of the same type.
4. Accept the default item tag that is based on the naming convention for the item type, or type
your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).

40

SmartPlant Electrical User's Guide

Working with Reference Data


5. For the item that you copied to the Electrical Index, edit the item properties in the Properties
window.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You access this dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the item. For full details of the properties, see the
appropriate dialog box topic.
When you copy a reference item, the software copies the item properties, except for the Item
tag property, which follows the item naming convention.
For an item that includes sub- items, such as a typical circuit with internal components, the
software copies the sub-items as well. In this case, the sub-items are the circuit components.

Create a Typical Electrical Motor


Most loads in your project are likely to be electrical motors, many with similar properties. For
convenience of creating motors in the Electrical Index, you can create typical motors to use as
templates for creating each group of project motors with common properties. Also, when you
create an electrical motor, you can specify a space heater used to heat the motor windings during
the non-operating state of the motor.
1. In the Reference Data Explorer, expand the folder hierarchy Electrical Equipment > Loads
> Motors.
2. Right-click the Motors folder, and then click New Motor or New Motor with Heater.
3. Accept the default item tag or type a name of up to 80 characters for the motor.
4. Right-click the motor and click Common Properties to open the Electrical Motor Common
Properties dialog box.
5. On the Electrical Motor Common Properties dialog box, edit the motor properties as
required. For more details, see Edit Electrical Motor Common Properties (on page 83).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new
electrical motor.
The Electrical Motor Common Properties dialog box shows the most commonly used
properties. You access this dialog box by clicking the Common Properties command on the
shortcut menu or you can specify in the preferences to open the dialog box directly when you
create a new electrical motor.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
When you add a motor with a space heater, the heater appears as a sub-item of the motor. If
you subsequently delete the motor, the software also deletes the heater.

SmartPlant Electrical User's Guide

41

Working with Reference Data

Create Typical I/O Signals


You can create typical I/O signals grouped together in typical I/O sets. You can then include a
typical I/O set in a profile that can be used with a project item or apply a typical I/O set to a project
control station or a circuit.
1. In the Reference Data Explorer, right-click the Typical I/O sets folder, and then click New
Typical I/O Set.
2. Right-click the new typical I/O set and select New Signal on the short-cut menu.
3. Accept the default item tag or type a name of up to 80 characters for the I/O signal.
4. Enter values for the I/O signal in the Properties window as you require.

Creating Typical Panels


You can create the following types of typical panels in the Reference Data Explorer:
Cabinets Multi-purpose electrical enclosures for various types of equipment. For more
information, see Create a Typical Cabinet (on page 42).
Control Stations Small cabinets containing low voltage start-stop circuitry used to control
a load at a remote location. For more information, see Create a Typical Control Station (on
page 43).
Local Panels Cabinets containing circuit, equipment, and wiring items, used for example,
to provide switching or isolation close to a motor. For more information, see Create a Typical
Local Panel (on page 43).
Junction Boxes Containers for electrical connections. For more information, see Create
a Typical Junction Box (on page 43).
In contrast to power distribution boards (PDBs), panels are much smaller in size and do not
contain busbars.

Create a Typical Cabinet


1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Cabinets folder, and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the cabinet.
If you are creating a number of typical cabinets at one time, you may want to stop at this
point and edit the typical cabinet properties at a later stage.
4. On the Cabinet Common Properties dialog box, edit the typical cabinet properties as
required.

42

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new typical
cabinet.
You access the Cabinet Common Properties dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create a new typical cabinet.

SmartPlant Electrical User's Guide

Working with Reference Data

Create a Typical Control Station


1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Control Stations folder, and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the control station.
If you are creating a number of typical control stations at one time, you may want to stop
at this point and edit the typical control station properties at a later stage.
4. On the Reference Control Station Common Properties dialog box, edit the typical control
station properties as required. For more details, see Edit Typical Control Station Common
Properties (on page 43).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new typical
control station.
You access the Reference Control Station Common Properties dialog box by clicking the
Common Properties command on the shortcut menu or you can specify in the preferences to
open the dialog box directly when you create a new typical control station.

Edit Typical Control Station Common Properties


1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Panels >
Control Stations.
2. Right-click the desired control station and on the shortcut menu, click Common Properties.
3. On the Reference Control Station Common Properties dialog box, add a cable to the
control station by clicking Add and performing the following steps.
4. On the Select Reference Cable dialog box, select the desired cable specification.
5. Click Find to open the Reference Cable Library dialog box, and select the cable that you
require.
6. Repeat the preceding steps if you require additional cables.
7. To remove a cable from the control station, select the desired cable under Associated cables
and click Remove.
You can define as many reference control stations as required for assigning to loads by
applying equipment profiles.

Create a Typical Local Panel


1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Local Panels folder and then click New Local Panel.
3. Accept the default item tag or type a name of up to 80 characters for the local panel.

Create a Typical Junction Box


1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Junction Boxes folder and then click New Junction Box.
3. Accept the default item tag or type a name of up to 80 characters for the junction box.

SmartPlant Electrical User's Guide

43

Working with Reference Data

Create a Typical Circuit


This feature allows you to create a typical circuit in the Reference Data Explorer. You can use a
typical circuit as a template for creating new project circuits that appear in the Electrical
Index. While editing the common properties of a typical circuit, you can associate the circuit
internal components with appropriate lookup tables.
1. In the Reference Data Explorer, right-click the Typical Circuits folder and then click an
option to create a new typical circuit of one of the following standard types:
New Feeder Circuit
New Incomer Circuit
New Coupler Circuit
New Bus Riser Circuit
New Panel Circuit
2. Accept the default item tag or type a name of up to 80 characters for the circuit.
3. Right-click the circuit and on the shortcut menu, click an option to create a new internal
component.
You can also create a circuit component by dragging an item from a folder under
Disconnect Electrical Equipment. For more information, see Copy Components to a
Typical Circuit (on page 44).
4. Right-click the new typical circuit and open its common properties.
5. In the Details of circuit internals data window, click under Lookup Table and select an
appropriate lookup table that you want to associate with the corresponding circuit internal
component.
You must first create an appropriate lookup table that is associated with the current
circuit internal component. For details, see Associate and Apply a Lookup Table to a Circuit
Internal Component (on page 59).
6. Repeat the previous steps as often as needed to create additional items for the circuit.

Copy Components to a Typical Circuit


1. In the Reference Data Explorer, expand the Typical Circuits folder and locate the desired
typical circuit.
Before dragging items between folders in the Reference Data Explorer, for
convenience, you can create another Reference Data Explorer window. To do this, click
Window > New > Reference Data Explorer.
2. Expand the folder hierarchy Electrical Equipment > Power Distribution Equipment >
Disconnect Electrical Equipment.

44

SmartPlant Electrical User's Guide

Working with Reference Data


3. In one of the following folders, expand the folder and select an existing item, or create a new
item in the folder:
Contractors
Overload Relays
Disconnect Switches
Circuit Breakers
Fuses
Starters
Other Disconnect Equipment
Metering Equipment (select a sub-folder)
4. Drag the desired item to the typical circuit.
5. Repeat the above steps as often as needed to create additional components for the circuit.

Copy from Typical Circuit Components


1. In the Reference Data Explorer, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Disconnect Electrical Equipment.
Before dragging items between folders in the Reference Data Explorer, for
convenience, you can create another Reference Data Explorer window. To do this, click
Window > New > Reference Data Explorer.
2. In the Typical Circuits folder, expand a typical circuit.
3. Drag the desired circuit component in the typical circuit to the Disconnect Electrical
Equipment sub-folder appropriate for the item type from among the following:
Contractors
Overload Relays
Disconnect Switches
Circuit Breakers
Fuses
Starters
Other Disconnect Equipment
Metering Equipment (select a sub-folder)
After copying an item by dragging it from a typical circuit to a Disconnect Electrical
Equipment sub-folder, you can drag the item to copy it to another typical circuit.

Create a Profile
You can create a profile for an item in the Reference Data Explorer and use it to create
associated items as well as to define default values for the main item and associated items in the
Electrical Index.
1. In the Reference Data Explorer, expand the Profiles folder hierarchy by clicking the + icon
and select the item type folder for the profile that you want to create.
2. Right-click the folder and then click New Profile.
3. Accept the default item tag or type a name of up to 80 characters for the profile.
If you are creating a number of profiles at one time, you may want to stop at this point and
edit the profile properties at a later stage.

SmartPlant Electrical User's Guide

45

Working with Reference Data


4. On the Equipment Profile Properties dialog box, edit the profile properties as required. For
more details, see Edit Profile Common Properties (on page 46).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new profile.
You access the Equipment Profile Properties dialog box (on page 764) by clicking the
Common Properties command on the shortcut menu or you can specify in the preferences to
open the dialog box directly when you create a new profile.
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Apply a Profile to an Item (on page 130).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Edit Profile Common Properties


1. In the Reference Data Explorer, expand the Profiles folder hierarchy by clicking the + icon
and select the item type folder for the profile that you want to edit.
2. Right-click the desired profile and on the shortcut menu, click Common Properties.
3. On the Equipment Profile Properties dialog box, click the General tab.
4. To change the profile name, click in the Profile tag box and type the profile name or click the
ellipsis button

beside the box.

If you want to use this profile as the default whenever you apply a profile to an item,
select Set as default.
5. Under Default reference item, select a reference item for copying the property values when
you apply the profile.
If you choose a motor that includes an internal heater, the Space Heater tab becomes
enabled.
6. To associate cables with the item referenced in the profile, under Associated cables, click
Add to open the Select Reference Cable dialog box, where you can select the desired cable.
7.
8.
9.
10.
11.
12.

13.
14.
15.
16.

46

You can add more than one cable to a profile.


Under Typical control station, click Add.
On the Find dialog box, click Find Now to display the available control stations.
In the list of control stations, highlight each control station that you want to associate with the
profile.
Click OK to add the selected control stations to the profile and return to the Equipment
Profile Properties dialog box.
Click the Protection Devices tab.
Under Typical circuit, click Find to find and select a typical circuit.
After selecting a typical circuit, the software displays the circuit function and the existing
internal components.
For a motor that includes an internal heater, click the Space Heater tab and define cables and
a typical circuit as required for the heater.
Click the Miscellaneous tab to specify a typical schematic and lookup table for the profile.
Under Typical schematic, click Find to find and select a typical schematic.
Under Lookup table, click Find to find and select a lookup table.

SmartPlant Electrical User's Guide

Working with Reference Data


For more details of how to find items, see the Find dialog box.

Now you can do one of the following:


To continue with the next step in the recommended workflow for generating a schematic
drawing, see Apply a Profile to an Item (on page 130).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Working with Typical Cable Block Diagrams


You can create typical cable block diagrams in the Reference Data Explorer. You can use typical
CBDs as a basis for your graphical design. Creating typical CBDs that contain a number of typical
electrical items that have predefined associations and definitions can be very helpful when
creating new project CBDs. You can create a number of different typical CBDs that cover the most
frequently used scenarios in your project. You can then drag a predefined typical CBD to the
Cable Block Diagrams folder in the Electrical Index or create a new project CBD based on an
existing typical CBD. The software will then create a new project CBD, all the project electrical
items based on the selected typical CBD, and make all the associations among these items as
they have been designed in the typical cable block diagram. The new project CBD and all the
newly created electrical items will then appear in the Electrical Index.
When opening an existing typical cable block diagram,
The software synchronizes the content of the typical CBD with the data in the Reference Data
Explorer. That is, if for some reason, a reference item used in the typical CBD has been
deleted from the Reference Data Explorer, this change is reflected in the typical cable block
diagrams that contain that reference item.
The software synchronizes the properties of the typical items placed on the drawing with the
properties of the reference items in the Reference Data Explorer. That is, if you change the
properties of a reference item that has already been placed on a typical CBD, this change will
also be reflected in in all the typical CBDs where this item has been used.
The software synchronizes the typical local panels and junction boxes with the data in the
Reference Data Explorer. That is, if for some reason, a circuit associated with a local panel
or junction box used in the typical CBD has been deleted or a new circuit has been added, this
change is reflected in the typical cable block diagrams that contain these reference items.
You design a typical CBD by dragging appropriate reference items to an open drawing. You can
drag almost any reference item (cables, loads, circuits, and so forth) from the Reference Data
Explore and create associations among them just like in a plant CBD. For details, see Create a
Typical Cable Block Diagram (on page 48).
The presentation of items in typical block diagrams is the same as in plant CBDs. To present the
placed items on the drawing, the software uses either a shipped symbol taken from the reference
data (specified by you on the Locations page in Options Manager) or a custom symbol that you
have associated with a specific item. If these images are not available in the specified folder, the
software uses a default image taken from the shipped reference data. For more information, see
Customizing Symbols (on page 347) and Defining File Locations in the SmartPlant Electrical
Option Manager Users Guide.
The rules for placing items, making connections, removing items from a typical CBD, and so forth
are the same as the ones for plant cable block diagrams. For details, see Working with Smart
Data and Auxiliary Graphics in a CBD (on page 320).

SmartPlant Electrical User's Guide

47

Working with Reference Data

Create a Typical Cable Block Diagram


This topic describes how to create a typical cable block diagram in the Reference Data Explorer.
1. In the Reference Data Explorer, right-click the Typical Cable Block Diagrams folder.
2. On the shortcut menu, click, New Typical Cable Block Diagram.
3. Right-click the new typical cable block diagram and then click Document Properties.
4. On the Typical Cable Block Diagram Options dialog box, do the following:
a. Under Document number, type a name of up to 80 characters for the new typical CBD.
b. Click in the Description box and type a brief description if needed.
c. From the Template name, select an appropriate drawing template.
d. To filter the display of cables in the CBD, select the appropriate check boxes under
Display cable types in cable block diagrams.
5. Click OK.
6. Do one of the following to open the drawing:
Double-click the name of the new typical block diagram.
Right-click the typical block diagram and then on the shortcut menu, click Open.
7. Drag the appropriate reference items from the Reference Data Explorer to the open drawing.

You can drag the following reference items to an open cable block diagram:
All electrical equipment items apart from power distribution boards, buses, and relay
functions.
You can drag disconnect electrical equipment items if they are stand-alone items, that
is, if they do not belong to any circuits.
Metering equipment items can be dragged only if they are current transformers or
potential transformers.
All wiring equipment items (panels, cables, and so forth) apart from busways, glands and
cableway components.

8. When done, click

48

on the main toolbar before closing the drawing.

If you place typical circuits, reference control stations, or reference instruments that are
associated with typical cables, the software places these reference cables on the drawing and
retains the associations.
If you delete any of the reference items that have been placed on a typical drawing, this item
will no longer appear on the drawings.
In addition to smart graphics, you can also add auxiliary graphics, redlining, and annotations to
your CBD. For details, see Working with Smart Data and Auxiliary Graphics in a CBD (on page
320). Once you save the drawing, the software retains all your additions and modifications.
You can create a project CBD based on a predefined typical CBD. For details, see Creating
Cable Block Diagrams (on page 317).

SmartPlant Electrical User's Guide

Working with Reference Data

Using Reference Control Stations, Typical Circuits, and


Reference Instruments in Typical CBDs
You can drag reference control stations, typical circuits, and reference instruments to a typical
cable block diagram. This enables you to place on your typical CBD drawing a typical set that
includes the selected reference control station, typical circuit, or instrument with all the associated
reference cables. Furthermore, after placing such a reference set on the drawing, the software no
longer retains the association with the related reference cable. That is, if for example, you
dissociate the reference cable from the reference control station, the typical CBD will still retain the
related cable on the drawing. Likewise, you can add or remove cables from the reference items
that you have placed on the drawing.

Using Reference Motors with Space Heaters in Typical CBDs


You can place reference motors with space heaters on typical cable block diagrams. Once you
drag such a reference motor to a typical CBD drawing, the software places both the motor and its
associated space heater on the drawing. The software places an association connector between
the reference motor and its associated space heater. You can use an appropriate symbol
assembly to represent a reference motor with a space heater on a typical CBD.

Note the following:


If you remove a reference motor from a drawing, the software also removes the associated
space heater.
You cannot remove a space heater and keep its motor on a drawing. To remove a reference
space heater, you must remove its associated reference motor. The software will then remove
both items from the drawing.
Association connectors between reference motors and their space heaters cannot be
removed from a CBD drawing. However, you can instruct the software to hide the association
connectors on the current CBD drawing. For details, see Hide Association Connectors (on
page 51).

Using Reference Junction Boxes and Local Panels in Typical


CBDs
When placing on typical cable block diagrams reference junction boxes and local panels that have
associated circuits, remember the following:
If the reference junction box or local panel has associated circuits, the associated circuits can
be placed on a typical CBD only with their associated junction box or local panel. When
dragging such a junction box or local panel to a typical CBD, the software places the
associated circuit automatically.
You can use a custom symbol assembly to represent a junction box or a local panel with
associated circuits in the drawing. Make sure that you use an appropriate symbol assembly for
such a junction box or local panel. That is, the number of circuits in the symbol assembly has
to match the number of circuits associated with the reference junction box or local panel that
that you want to place on a typical CBD. If the number of circuits does not match, the typical
CBD will display the associated circuits as they appear in the symbol assembly that you used
for that reference junction box or local panel.

SmartPlant Electrical User's Guide

49

Working with Reference Data

If you choose not to use a custom symbol assembly for a reference junction box or local panel.
the software will place associated circuits on the drawing automatically and it will also display
the non -power flow association connectors between the junction box and the local panel. You
can hide these connectors if you like. For details, see Hide Association Connectors (on page
51).

Note that the rules stated above apply only to typical circuits that have been created
under reference junction boxes and local panels and not to typical circuits that have been created
in the Typical Circuits folder of the Reference Data Explorer.

Make Non-Power Flow Associations in a Typical CBD


The following procedure explains how to create an association between a reference control
station or reference instrument and a reference equipment item. For example, you can create an
association between a reference motor and a reference control station or create an association
between a reference instrument and a reference heater.
Once an association has been established, the software places a logical connector between the
two associated items. By default, the software shows logical connectors as black dashed lines.
You can change the style of the line by using the Define Item Type Symbology feature in
Options Manager (in Options Manager, click .Options > Item Type Symbology > Define).
The association created by the software is only kept in the typical CBD drawing that
you are currently working on. After creating a plant CBD based on the current typical CBD, logical
associations will become real associations between plant items.
1. Open an existing typical CBD or create a new one.
2. Place the required reference equipment items on the drawing.
3. Place an appropriate reference control station, reference instrument or both on the drawing.
4. On the Edit Drawing toolbar, click

or click Edit > Activate Association Mode.

The software indicates that connection mode is active by changing mouse pointer to a
vertical line.
The software stays in the connection mode until you press the Esc key.
5. Click one of the required items and then the other item to associate them with each other.
The software places a logical connector between the associated items. The logical
connector is shown as a black dashed line.
To dissociate two items from each other, do one of the following:

50

Click the required logical connector and then press the Delete key or click
the Edit drawing toolbar.
Remove one of the associated items from the drawing.

(Remove) on

SmartPlant Electrical User's Guide

Working with Reference Data

Hide Association Connectors


You can instruct the software to show or hide non-power flow association connectors on a typical
cable block diagram.
Do one of the following:

On the Edit drawing toolbar, click


.
On the Edit menu, click Show/Hide Association Connectors.

By hiding the association connectors, you are not dissociating the items from each other.
To cancel an association, do one of the following:

Click the required logical connector and then press the Delete key or click
the Edit drawing toolbar.
Remove one of the associated items from the drawing.

(Remove) on

Create Typical Schematic Blocks


Blocks are the basic graphical components of schematics. You create your library of blocks in the
Reference Data Explorer. The definition of each block comprises the block name, the block
type, and the drawing file associated with the block. You can create the drawing files for use with
blocks in the Catalog Manager, or in an external CAD application such as SmartSketch, AutoCAD,
or MicroStation.
1. In the Reference Data Explorer, right-click the Typical Blocks folder, and then click New.
2. Accept the default item tag or type a name of up to 50 characters for the typical block.
If you are creating a number of schematic blocks at one time, you may want to stop at
this point and edit the schematic block properties at a later stage.
3. On the Typical Schematic Block Common Properties dialog box, edit the schematic block
properties as required. For more details, see Edit Typical Schematic Block Common
Properties (on page 52).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new typical
schematic block.
You access the Typical Schematic Block Common Properties dialog box by clicking the
Common Properties command on the shortcut menu or you can specify in the preferences to
open the dialog box directly when you create a new typical schematic block.
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Create a Typical Schematic (on page 53).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

51

Working with Reference Data

Edit Typical Schematic Block Common Properties


1. In the Reference Data Explorer, expand the Typical Blocks folder by clicking the + icon
beside the folder.
2. Right-click the desired block and on the shortcut menu, click Common Properties.
3. On the Typical Schematic Block Common Properties dialog box, under Block details,
select the desired block type in the Block type list.
4. Beside File name, click the ellipsis button
graphical representation of the block.

to navigate to the drawing file that contains the

You can only select drawing files from the default folder specified in the Options
Manager; you can navigate to other folders, but you will not be able to select any files in those
folders.
5. Click Add to add the block to the library without having to close the dialog box.
6. To delete from the database a block that is not used in any typical schematic, select the
desired block and click Delete.
7. When done, click Apply.

52

Each block can have one or more associated macros. You can define and edit macros using
the Catalog Manager or an external CAD application such as SmartSketch, AutoCAD, or
MicroStation.
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Create a Typical Schematic (on page 53).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

Working with Reference Data

Create a Typical Schematic


Many electrical items have a common circuit layout, where the graphical components are
identical, but the data is different. In order to generate a schematic for a particular load, you must
create a typical schematic. A typical schematic includes drawing blocks and macros to represent
the graphical components and data types respectively. Note that you can create schematic
drawings that include several sheets. Multi-sheet schematics are mostly used when you need to
display complex electrical equipment for which a single sheet is not enough to show all the
relevant wiring details of the equipment. The software uses the typical schematic as a template
for generating the schematic drawing that contains the actual load data.
1. In the Reference Data Explorer, right-click the Typical Schematics folder, and then click
New.
2. Accept the default item tag or type a name of up to 80 characters for the typical schematic.
If you are creating a number of typical schematics at one time, you may want to stop at
this point and edit the typical schematic properties at a later stage.
3. On the Typical Schematic Common Properties dialog box, edit the typical schematic
properties as required. For more details, see Edit Typical Schematic Common Properties (on
page 53).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new typical
schematic.
You access the Typical Schematic Common Properties (see "Typical Schematic Common
Properties Dialog Box" on page 778) dialog box by clicking the Common Properties
command on the shortcut menu or you can specify in the preferences to open the dialog box
directly when you create a new typical schematic.
You can add various macros to the title block that will appear in the schematic drawing. For
more details, see Title Block Macros (on page 256).
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Create a Profile (on page 45).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Edit Typical Schematic Common Properties


Many electrical items have a common circuit layout, where the graphical components are
identical, but the data is different. In order to generate a schematic for a particular load, you must
create a typical schematic. A typical schematic includes drawing blocks and macros to represent
the graphical components and data types respectively. Note that you can create schematic
drawings that include several sheets. Multi-sheet schematics are mostly used when you need to
display complex electrical equipment for which a single sheet is not enough to show all the
relevant wiring details of the equipment. The software uses the typical schematic as a template
for generating the schematic drawing that contains the actual load data.
1. In the Reference Data Explorer, expand the Typical Schematics folder by clicking the +
icon beside the folder.
2. Right-click a schematic and on the shortcut menu, click Common Properties.

SmartPlant Electrical User's Guide

53

Working with Reference Data


3. On the Typical Schematic Common Properties dialog box, add a block to the schematic by
clicking Add to add a new line to the list under Schematic blocks.
When adding blocks that comprise the typical schematic, make sure that all the
blocks belong to the same CAD format. Generating a schematic drawing based on a typical
schematic that uses different CAD formats (for example, .sym and .dgn files) may result in
generation errors.
4. Under Block details, select the desired block in the Block name list.
You can click View to preview the currently selected block before adding it to the typical
schematic.
5. Select the starting point for the bottom left corner of the block relative to the bottom left corner
of the schematic by specifying the values in the X and Y boxes. These are usually the same
as the coordinates that were originally defined for the block while it was a part of the complete
schematic. The default values for the coordinates are 0,0.
6. For the Sequence property, if needed, type a positive integer to represent the sequence in
which the software associates the blocks with matching project items.
The software uses these sequence numbers if there are multiple project items belonging
to the same item type, for example, a schematic that contains two control station blocks that
have to be associated with project items. The software associates the block that has lowest
sequence number with the plant item that has the lowest Sequence in group attribute among
the project items belonging to same item type. Example: A typical schematic contains two
blocks A and B whose sequence numbers are 5 and 8 respectively. If used with a motor that
has two control stations CS-1 and CS-2 for which the Sequence in group properties are 3
and 8 respectively, the software matches Block A with Control Station CS-1 and Block B with
Control Station CS-2.
7. Set the number of sheets in the typical schematic and define the sheet properties. For
details, see Create a Multi-Sheet Typical Schematic (on page 55).
8. Under Sheet number, select a sheet that you want to assign to the selected block.

You can assign the same block to several different sheets if you want the block to appear
more than once on different sheets of the same schematic.
Note that the software does not retain in the database the sheets that have not been
assigned to blocks.
9. To remove a block from the schematic, select the desired block under Schematic blocks and
click Remove.
10. When done, click Apply.

54

Now you can do one of the following:


To continue with the next step in the recommended workflow for generating a schematic
drawing, see Create a Profile (on page 45).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

Working with Reference Data

Create a Multi-Sheet Typical Schematic


Many electrical items have a common circuit layout, where the graphical components are
identical, but the data is different. In order to generate a schematic for a particular load, you must
create a typical schematic. A typical schematic includes drawing blocks and macros to represent
the graphical components and data types respectively. Note that you can create schematic
drawings that include several sheets. Multi-sheet schematics are mostly used when you need to
display complex electrical equipment for which a single sheet is not enough to show all the
relevant wiring details of the equipment. The software uses the typical schematic as a template
for generating the schematic drawing that contains the actual load data.
1. On the Typical Schematic Common Properties dialog box, click Sheets. For more details
on how to open the Typical Schematic Common Properties dialog box, see Edit Typical
Schematic Common Properties (on page 53).
2. On the Schematic Sheet Properties dialog box, click Add.
3. Under Sheet number in the Sheet details group box, type the sheet sequence number.
4. Under Description in the Sheet details group box, type the sheet description.
5. Click Add again to add another sheet to the same typical schematic and repeat steps 3 and 4.
6. Click OK to return to the Typical Schematic Common Properties dialog box and assign a
sheet number to each block in the typical schematic.

You can assign the same block to several different sheets if you want the block to appear more
than once on different sheets of the same schematic.
You should assign a sheet to each block in the typical schematic. Unassigned sheets are not
kept in the database by the software.
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Create a Profile (on page 45).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

55

Working with Reference Data

Working with Lookup Tables


Lookup tables enable you to define a set of default property values that you can apply to a project
item. Each set of these default values consist of one or more key properties and their related
common properties.
You can use lookup tables to populate item properties with a large number of values supplied by
vendors.

Create Lookup Tables


The following procedure explains how to create a new lookup table.
1. In the Reference Data Explorer, expand the Lookup Tables folder by clicking the + icon
beside the folder.
2. Right-click the folder for the item that you require and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the item lookup table.
If you are creating a number of lookup tables at one time, you may want to stop at this
point and edit the lookup table properties at a later stage.
4. On the Lookup Table Properties dialog box, edit the lookup table properties as
required. For more details, see Edit Lookup Tables (on page 56).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new lookup
table.
You access the Lookup Table Properties dialog box (on page 767) by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create a new lookup table.

Edit Lookup Tables


The following procedure explains how to modify an existing lookup table.
1. In the Reference Data Explorer, expand the Lookup Tables folder by clicking the + icon
beside the folder.
2. Expand the lookup table folder for the desired item type.
3. Right-click the desired lookup table and on the shortcut menu, click Common Properties.
4. On the Lookup Table Properties dialog box, click the Structure tab to determine the item
properties that you want to use for applying data.
To define the lookup table as the default for the current item type, select Set as default.
5. Click Add to add a new property line to the lookup table definition.

56

SmartPlant Electrical User's Guide

Working with Reference Data


6. Under Edit, select in the Property list the desired property to use for the lookup table.
It is good practice not to include calculated properties in lookup tables. For
example, if the Supply AC/DC Flag property for a motor is set to DC, and you try to select a
value for the Frequency property, you cannot apply this value and the software rejects the
operation. You must first set Supply AC/DC Flag to AC, and only then you can apply the
lookup table value for the Frequency property to the motor.
7. If required, modify the caption text for the header that appears on the Data tab. The default is
the property name.
8. From Input-output value, select Input if you want to define the property as a key field otherwise, select Output.

The software uses key field values to identify the data to update using the appropriate
values for the output fields.
The software treats read- only data as input only, and the Input-output value property is
disabled for such data.
9. From Overwrite option, select True if you want to overwrite existing data when you apply the
lookup table values, or select False to insert the values only where no data exists previously.
10. Repeat the preceding steps for as many other properties as you require.
11. If required, change the order of the properties under Definition by selecting an individual
property and clicking Up or Down.
The order of the properties affects how they are arranged on the Data tab. It is usually
convenient to arrange the input properties at the beginning, followed by the output
properties. For more details, see Lookup Table Structure Example (on page 58).
12. Click the Data tab and enter data values for the desired properties.
13. Enter data values for the properties that you require on the blank line.

You can right-click individual cells to copy and paste data. To copy and paste entire rows
of data, select the source row and click Copy Row. Next, select the target row and click
Paste Row.
Ensure that each combination of data in the key fields is unique. If you enter duplicate
key fields in two rows, the software displays a warning message and highlights the
duplicate row so that you can modify he input data. For more details, see Lookup Table
Data Example (on page 58).
You can sort the rows of data according to a particular column by clicking the column
header. Repeatedly clicking a column header displays the data in alternating ascending
and descending order.
14. Repeat the previous step for each set of data required.

You can define as many lookup tables as you require for a particular item type.
There are three specific lookup tables for conductors that cannot be deleted: Conductor
Material Coefficients, Conductor Insulation Temperatures, and Conductor Area
cmils. These tables contain typical values for some of the most common conductor materials
and conductor insulation materials. You should check these typical values and make sure
they comply with and match the values used or specified by local codes or cable
manufacturers. The software uses the data in these lookup tables for short circuit cable sizing
and you should add appropriate data for any additional conductor material or insulation if
needed.

SmartPlant Electrical User's Guide

57

Working with Reference Data


Do not change any of the values on the Structure tab for the conductors lookup
tables.

Lookup Table Structure Example

Lookup Table Data Example

58

SmartPlant Electrical User's Guide

Working with Reference Data

Enable Additional Regional Standard Lookup Tables


SmartPlant Electrical allows you to enable regional standard lookup tables in addition to the NEC
standards. You can define IEC and CEC standards in the Data Dictionary and then create lookup
tables in the Reference Data Explorer based on these regional standards. You can then apply
the new lookup tables to the appropriate equipment items that conform to these regional settings.
1. In the Data Dictionary, add a new regional standard entry in the Conformity to standard
select list.
2. Switch to SmartPlant Electrical and in the Reference Data Explorer, create a new lookup
table for the regional standard entry that you just created in the Data Dictionary.
3. Apply the new lookup table to all the equipment items in your project that conform with the
new regional standard.

Associate and Apply a Lookup Table to a Circuit Internal


Component
The software allows you to associate lookup tables with circuit internal components. You can
make this association on the Typical Circuit Common Properties dialog box in the Reference
Data Explorer and then apply that typical circuit to a number of project circuits. Alternatively, you
can make this association on the Circuit Common Properties dialog box for a circuit that you
select in the Electrical Index and then run the Apply Lookup Tables feature on the Apply
Options dialog box to propagate the lookup table data to the circuit internal components.
1. In the Reference Data Explorer, expand the Lookup Tables folder by clicking the + icon
beside the folder.
2. Right-click the folder for a circuit internal component (for example, Circuit Breakers, Fuses,
and so on) and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the item lookup table.

4.
5.
6.
7.
8.
9.
10.
11.

If you are creating a number of lookup tables at one time, you may want to stop at this
point and edit the lookup table properties at a later stage.
On the Lookup Table Properties dialog box, edit the lookup table properties as
required. For more details, see Edit Lookup Tables (on page 56).
Create or edit the properties of a typical circuit in the Reference Data Explorer. For details,
see Create a Typical Circuit (on page 44).
On the Typical Circuit Common Properties dialog box, under Details of circuit internals,
select an appropriate lookup table from Lookup Table list.
In the Electrical Index, select a project circuit to which you want to apply a lookup table.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Lookup Tables tab.
Select the Enable associated lookup tables of circuit internals check box.
Click Apply.
On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new lookup
table.
You access the Lookup Table Properties dialog box by clicking the Common Properties
command on the shortcut menu or you can specify in the preferences to open the dialog box
directly when you create a new lookup table.

SmartPlant Electrical User's Guide

59

Working with Reference Data

Automate the Sizing of Circuit Internal Components Based


on Load Data
SmartPlant Electrical enables you to create lookup tables that include load properties as key
fields. You can associate these lookup tables with circuits or circuit internal components and
apply these lookup tables to project circuits or circuit internals to populate the lookup table
data. This feature is especially useful when creating protection equipment, fuses, circuit
breakers, and so forth whose properties correlate with load lookup tables.
1. In the Reference Data Explorer, expand the Lookup Tables folder by clicking the + icon
beside the folder.
2. Right-click the folder for a circuit internal component (for example, Circuit Breakers, Fuses,
and so on) and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the item lookup table.

4.
5.
6.
7.
8.
9.
10.
11.

60

If you are creating a number of lookup tables at one time, you may want to stop at this
point and edit the lookup table properties at a later stage.
On the Lookup Table Properties dialog box, edit the lookup table properties as
required. For more details, see Edit Lookup Tables (on page 56).
Create or edit the properties of a typical circuit in the Reference Data Explorer. For details,
see Create a Typical Circuit (on page 44).
On the Typical Circuit Common Properties dialog box, under Details of circuit internals,
select an appropriate lookup table from Lookup Table list.
In the Electrical Index, select a project circuit to which you want to apply a lookup table.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Lookup Tables tab.
Select the Enable associated lookup tables of circuit internals check box.
Click Apply.
On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new lookup
table.
You access the Lookup Table Properties dialog box by clicking the Common Properties
command on the shortcut menu or you can specify in the preferences to open the dialog box
directly when you create a new lookup table.

SmartPlant Electrical User's Guide

Working with Reference Data

Reference Electrical Engineer


You use the Reference Electrical Engineer to copy existing partial or complete power network
structures by dragging items from one or more specified plants to the Electrical Engineer in the
current plant.
While working in your project plant, SmartPlant Electrical allows you to connect to another plant
and open the Electrical Engineer from which you can drag a power network structure to the
Electrical Engineer in your project. This way, any external plant can serve as a reference for
your project plant. Such an external plant can hold numerous assemblies in its Electrical
Engineer, from which you can drag an assembly to your project Electrical Engineer. As you
copy an assembly to your project Electrical Engineer, the software automatically copies to the
Electrical Index all the electrical items contained in the assembly as well as the items directly
associated with the items displayed in the Electrical Engineer (for example, a control
station). Furthermore, the software copies the reference power cables and typical schematics to
the Reference Data Explorer.
The rules that determine where you can drag certain items in the target Electrical Engineer are
similar to the drag-and- drop rules for items that you drag from the Electrical Index and within the
Electrical Engineer.
Before connecting to a reference plant and opening its Electrical Engineer, make
sure that you have been granted full access rights to that plant.
The Reference Electrical Engineer window contains the following sections:
Toolbar
Tree view pane
List view pane
These sections are described below:

Toolbar
The toolbar contains the following options:
Find Click Find
to open the Find dialog box where you can look for a specific item in the
Electrical Engineer. Click the arrow to display a menu with the following options:
Find Opens the Find dialog box where you can look for a specific item in the Reference
Electrical Engineer.
Close Closes the active Reference Electrical Engineer window.
Refresh Click Refresh
to update the Reference Electrical Engineer display. This
feature is useful where multiple users are working on the same set of data.
Buttons Buttons provide a useful shortcut to an item or a group of items. Click Buttons
to toggle show / hide for existing buttons. To create a button for the currently selected item or
folder, click the arrow and click Add Button. To remove a button, select the button to remove,
then click the arrow, and click Remove Button. Note that if you do not select any button to
remove, the software removes the uppermost button in the list.

Tree View Pane


The tree view pane of the Reference Electrical Engineer shows electrical items organized in the
Reference Plant folder. All items that appear under this folder have read-only status.
Expand or collapse the hierarchy by clicking the + and - icons respectively or by clicking an item in
the Reference Plant folder hierarchy.

SmartPlant Electrical User's Guide

61

Working with Reference Data


After fully expanding a hierarchy, double-click an item to open its Common Properties dialog
box.

You can open several instances of the Reference Electrical Engineer by clicking Window >
New > Reference Electrical Engineer.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

Copy Power Network Structures from Another Plant


You use this feature to copy power network structures from the Reference Electrical Engineer.
Before connecting to a reference plant and opening its Electrical Engineer, make
sure that you have been granted full access rights to that plant.
1. Click Window > New > Reference Electrical Engineer.
2. On the Open Plant Structure (see "Open Plant Structure Dialog Box" on page 612) dialog box,
select a plant from which you are going to copy the data structure. If the plant that you want
does not appear, click Site Server to navigate to another location.
3. Click Open to display the plant in the Reference Electrical Engineer.
4. Expand the folder hierarchy by clicking the + icon beside the folder that you require, or by
double-clicking the folder.
5. In the Electrical Engineer for the current plant, expand the item hierarchy to display the item
to which you want to copy the network structure.
6. Drag the parent (node) item of the network structure from the Reference Electrical Engineer
to an item in the Electrical Engineer.

62

You can open more than one Reference Electrical Engineer and copy data from different
plants to your current plant.
You can drag a parent item from the Reference Electrical Engineer to the root of your
current plant.
You can open an instance of the Reference Electrical Engineer for your current plant to
duplicate your current plant data. In this case, the results you obtain are not the same as if
you move items within the Electrical Engineer. For details of how the software copies data
from the Reference Electrical Engineer to the Electrical Engineer, see Rules Governing
the Copying of Power Network Structures to the Electrical Engineer (on page 63).
When you copy items from the Reference Electrical Engineer to the Electrical Engineer,
the item does not appear in the Electrical Index. To update the item in the Electrical Index,
click Refresh
.

SmartPlant Electrical User's Guide

Working with Reference Data

Rules Governing the Copying of Power Network Structures


to the Electrical Engineer
When you create new power network structures in your current plant by dragging items from the
Reference Electrical Engineer to the Electrical Engineer, there are specific rules that
determine how the software creates new items and the electrical associations with the items that
already exist in the target plant. When you drag an item to the Electrical Engineer, the software
includes that item and all items that are below it in the hierarchy, which together constitute the
scope of copied items.
The following rules apply to dragged items:
The software assigns names to the items created in the target plant according to the target
plant naming conventions.
Items that the software creates in the target plant inherit the properties of their source items.
If you drag a load to the root (Plant) of the target plant, the software copies the load, but does
not associate it with any item in the Electrical Engineer -instead the load appears in the
appropriate folder of the Electrical Index.
The software copies the electrical relationships that existed among the items in the scope to
the target plant. The software creates a new relationship between the dragged item at the top
of the hierarchy and the target item. This new relationship follows the rules that apply when
dragging items within the Electrical Engineer. For more information, see Rules for
Changing Electrical Associations (on page 192).
Cables that are created in the target plant include the conductor arrangement of the source
and all the sizing data. The software copies the reference cables to the Reference Data
Explorer in the target plant and associates them with the project power cables.
When the scope includes buses, the software copies their PDBs and PDB-bus associations to
the target plant.
When the scope includes circuits that have cells, the software copies these cells and their
circuit associations to the target plant.
When the scope includes circuits that contain internal components, the software copies the
circuits and their internal components to the target plant.
When the scope includes an auxiliary contact, special rules apply depending on the electrical
branch that you want to copy. For details, see Rules for Copying Branches with Auxiliary
Contacts (on page 64).
When copying loads or circuits, the software also copies all the signal data associated with
these items to the target plant.
When copying an item that is associated with a control station, the software copies the
pertinent control stations and control station cables to the Electrical Index in the target plant.
When copying a load that is associated with a typical schematic, the software copies the
relevant typical schematics and typical blocks to the Reference Data Explorer in the target
plant.
The software does not support the copying of equipment connected in parallel. Therefore, if
you copy an electrical branch that is connected in parallel in the Reference Electrical
Engineer, these items will not be copied to the Electrical Engineer.

SmartPlant Electrical User's Guide

63

Working with Reference Data

Rules for Copying Branches with Auxiliary Contacts


When copying a branch that includes an auxiliary contact, the software behaves according to the
rules described below. The rules apply to a situation illustrated in the following example:

When dragging to your project Electrical Engineer a branch that includes an auxiliary contact,
the rules are as follows:
If the auxiliary contact belongs to a standalone disconnect equipment item (for example, a
disconnect switch), the software creates the new branch in the project Electrical Engineer
only up to and not including the auxiliary contact. The parent disconnect electrical equipment
item of the auxiliary contact is not copied.
If the auxiliary contact belongs to disconnect electrical equipment and this disconnect
electrical equipment item is an internal component of a circuit, the software creates the new
branch in the project Electrical Engineer only up to and not including the auxiliary contact.
The parent disconnect electrical equipment item of the auxiliary contact is not copied.
If you drag to the project Electrical Engineer a branch that contains a disconnect electrical
equipment item that has an auxiliary contact, the software creates the following in the project
Electrical Engineer:
The full disconnect equipment branch.
The auxiliary contact.
All the electrical items belonging to the downstream branch of the auxiliary contact.

64

SmartPlant Electrical User's Guide

SECTION 6

Creating and Modifying Equipment


This section deals with the creation and management of your plant electrical equipment. You carry
out these tasks in the Electrical Index. The items that you can create are loads, generators,
battery banks, offsite power supplies, converting equipment, power distribution boards, buses,
disconnect electrical equipment, and so forth.

In This Section
Using Naming Conventions ........................................................... 65
Electrical Index .............................................................................. 66
Properties Window ......................................................................... 72
Create a New Item in the Electrical Index ..................................... 77
Create a Project Item Based on a Reference Item ........................ 77
Edit Item Properties ....................................................................... 78
Duplicate an Item ........................................................................... 78
Rename an Item ............................................................................ 79
Delete an Item ............................................................................... 79
Working with Loads ....................................................................... 81
Managing Space Heaters and Their Power Supplies .................... 89
Create a Generator ........................................................................ 99
Create an Offsite Power Supply .................................................... 100
Create a Battery Bank ................................................................... 101
Converting Equipment ................................................................... 101

Using Naming Conventions


You define naming conventions per item type, such as motors, cables, static loads, and so forth, in
Options Manager.
For full details of how to define naming conventions, see the Options Manager User's Guide:
Naming Conventions.
You set whether to use naming conventions by default for all item types in the Data Dictionary by
setting the Comply with Naming Convention flag to True or False.
When set to True, each time you create a new project item in the Electrical Index, the software
requires you to use an item tag that complies with the defined naming convention for the item
type. The software prompts you with a new item tag based on the naming convention whenever
you create a new item by a New command, a Duplicate command, by dragging items from the
Reference Data Explorer, or by applying profiles.
When set to False, the software prompts you with a new item tag based on the naming
convention, but you can overwrite it with any characters that you want.

You can override the default naming convention mode for one or more individual tags by
selecting the desired tags, and in the Properties window, changing the value of the Comply
with Naming Convention property.

SmartPlant Electrical User's Guide

65

Creating and Modifying Equipment

If you change the value of the Comply with Naming Convention property for an item tag
from False to True, the software designates a new item tag for the item based on the naming
convention.
Whether or not you use the naming convention, the software always prompts you with a new
item tag that is unique.

Electrical Index
The Electrical Index is the repository of all your project electrical items. You create and manage
the electrical inventory of your project using edit, duplicate, and delete operations. The electrical
items in the Electrical Index are organized by item type categories in a parent-child relationship.
This parent-child relationship is illustrated in the following example for a current transformer. To
see an existing current transformer, expand the following hierarchy in the Electrical Index:
Electrical Equipment > Converting Equipment > Transformers >a transformer item >Metering
Equipment > a current transformer item.
For more details about the creation and management of electrical items, see Creating and
Modifying Equipment (on page 65).
You can create electrical associations by dragging an electrical item from the Electrical Index to
the Electrical Index. For details, see Electrical Engineer (on page 183).
The Electrical Index window contains the following sections:
Toolbar
Tree view pane
List view pane
These sections are described below:

Toolbar
The toolbar contains the following options:
Find Click Find
to open the Find dialog box where you can look for a specific item in the
Electrical Index. Click the arrow to display a menu with the following options:
Find Opens the Find dialog box where you can look for a specific item in the Electrical
Index.
Find in Electrical Engineer Searches the Electrical Engineer for the item that is currently
selected in the Electrical Index. Note that both the Electrical Engineer and the Electrical
Index have to be open if you want to use this feature.
Close Closes the active Electrical Index window.
Refresh Click Refresh
to update the Electrical Index display. This feature is useful
where multiple users are working on the same set of data.
Views The Views icon
allows you to toggle through different views of the items in the
list view pane. The arrow beside the icon allows you to select a specific view.
Buttons Buttons provide a useful shortcut to an item or a group of items. The Buttons icon
allows you to toggle between showing and hiding existing buttons. The arrow beside the
icon includes options that allow you to add or remove buttons for the currently selected item or
folder. Note that when removing a button, if you do not select a specific button, the software
removes the uppermost button in the list.

66

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


Tree View Pane
The tree view pane of the Electrical Index shows the equipment in your inventory organized by
folders. SmartPlant Electrical defines standard folders in the database. You cannot move or
delete these folders, nor can you add new folders. However, you can rename folders if required
or create a custom folder inside a specific item type folder. Each folder contains a particular item
type, and the options available on the menus depend on the currently selected item type.
Expand or collapse the hierarchy by clicking the + and - icons respectively or by double-clicking a
folder.
For equipment items that are connected in parallel, the software uses a special indicator next
to the equipment items that are connected in parallel.
The indicator is
. For example
.
After fully expanding a hierarchy, double-click an item to open its Common Properties dialog
box. In the Documents folder, double-clicking a drawing or any other document also opens the
document Common Properties dialog box.
When you select a folder, the number of items in the folder appears in the status bar. You can
customize the sort sequence of items in the folders.

List View Pane


The list view pane of the Electrical Index displays items, other than folders, that are contained in
the currently selected folder or item in the tree view pane.

You can open several instances of the Electrical Index by clicking Window > New >
Electrical Index.
You can right-click any item in the Electrical Index to find it in the Electrical Engineer or click
an item in the Electrical Engineer to find it in the Electrical Index. Both the Electrical
Engineer and the Electrical Index have to be open if you want to use this feature.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

Customizing Folders
As your database in SmartPlant Electrical expands, the need to organize the various item types
into sub-categories becomes apparent. Using custom folders you can create sub-folders for each
item type folder. You can use these folders to divide item types into smaller more manageable
sections, for example within Wiring Equipment > Cables > Power Cables you could divide the
cables by manufacturer, cable specification, or insulation material. Using filters you can place
power cables into more than 1 folder, for example you could create a folder for all power cables
manufactured by a specific company, and another folder for all power cables that meet NEC
specifications, a power cable manufactured by the specific company and that has an NEC
specification appears in the folder created for the manufacturer, and appears in the folder created
for NEC specification power cables, along with all other power cables that have NEC
specifications. The software creates the duplicate items without moving the original item from the
Electrical Index or the Reference Data Explorer.

SmartPlant Electrical User's Guide

67

Creating and Modifying Equipment


Creating custom folders also improves the performance of SmartPlant Electrical when you are
looking for items in the Electrical Index. Due to the large amount of items that folders in the
Electrical Index may contain, opening a folder can take some time. Creating a custom folder, for
the first time, also creates a second sub-folder that contains all the items of the parent folder. This
is the All Items folder. Storing all the parent folder items in the All Items folder and creating
custom folders reduces the time the software takes to open the parent folder and the custom
folders. Also when SmartPlant Electrical searches the Electrical Index for an item, the software
first searches the custom folders and only searches the All Items folder if the item cannot be
found in a custom folder.
Only a maximum of 24 custom folders can be created.

Create a Custom Folder


This procedure allows you to create custom folders inside item type folders. Custom folders are
used when you want to divide an item type into smaller specific groups according to parameters
set by you. For example, you could divide power cables into groups according to their power
rating, divide the generators folder into groups according to their output, and so forth.
1. In the Reference Data Explorer or Electrical Index, expand the hierarchy and highlight the
item type folder to which you want to add a custom folder.
2. Do one of the following:
Click File > New > Custom Folder.
Right-click the item type folder, and on the shortcut menu, click New Custom Folder.
3. In the Name field, type the name of the new folder.
4. Next to the Filter field, click Browse to open the Select Filter dialog box, and do one of the
following:
Select a filter and click OK.
Create a new filter.
For more information on creating a filter, see Using Filters in the Filter Manager User's Guide.

68

The first time you create a custom folder, a second folder called All Items is also created in
the parent folder. All the items in the parent folder are moved to this folder.
Only a maximum of 24 custom folders can be created.
Items that match the filter criteria are automatically duplicated in the custom folder, without
moving them from the All Items folder.
Some standard folders already have a hard-coded filter, for example the power cables folder
has a hard-coded filter CableCategory = <Property>. When a hard-coded filter already
exists, the filter definition has to be set correctly or this could result in incorrect items
appearing in your custom folder. The filter definition for the custom folder should be Match
all, or the criteria of the existing hard-coded filter should be included in the filter for the custom
folder. For example; CableCategory = Power Cable and Conductor Arrangement = 3 core
cable.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Apply a Filter to a Custom Folder


1. To apply a filter to a custom folder do one of the following:
Create a new custom folder and open the Select Filter dialog box. For details, see
Create a Custom Folder (on page 68).
Right-click an existing custom folder and on the shortcut menu, click Properties. On the
Custom Folder Properties dialog box, click Browse.
2. On the Select Filter dialog box, open the folder that contains the required filter.
3. Select the required filter, and click OK.
4. On the open dialog box, click OK.

You create filters using Filter Manager, for more information, see Using Filters in the Filter
Manager User's Guide, under Using Filters.
Some standard folders already have a hard-coded filter, for example the power cables folder
has a hard-coded filter CableCategory = <Property>. When a hard-coded filter already
exists, the filter definition has to be set correctly or this could result in incorrect items
appearing in your custom folder. The filter definition for the custom folder should be Match
all, or the criteria of the existing hard-coded filter should be included in the filter for the custom
folder. For example; CableCategory = Power Cable and Conductor Arrangement = 3 core
cable.

Delete a Custom Folder


1. In the Reference Data Explorer or Electrical Index expand the hierarchy and find the
custom folder you want to delete.
2. Right-click the folder you want to delete and on the shortcut menu, click Delete Custom
Folder.
3. At the prompt, click Yes.
Deleting a custom folder does not remove the custom folder contents from the
database. These items can still be found in the All Items folder. The All Items folder is also
deleted, but not its contents, if the deleted custom folder is the only custom folder in the parent
folder.

Select a Set of Item Tags in the Electrical Index


You can make a multiple selection of item tags for performing editing operations in the Reference
Data Explorer or the Electrical Index.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Right-click a folder and adjust the size of the panes to view the items in the list view pane.
3. If required, change the view in the list view pane by clicking View Settings
to toggle
through each view of the items in the list view pane, or click the arrow beside the icon and
select the desired view.
4. Select one or more items in the list view pane. Hold CTRL to select several items or hold
SHIFT to select a range of items.
When you select a set of data, the list at the top of the Properties window displays Select
set and you can type properties that apply to all the items. Also, you can select a specific item
from the list to view or edit its individual properties.

SmartPlant Electrical User's Guide

69

Creating and Modifying Equipment

Customize the Sort Sequence of Items in Tree Folders


This procedure explains how to customize the sort sequence of items within the main folders of
the Electrical Index and Reference Data Explorer.
1. Create a new .XML file and call it SpelItem.xml.
2. Place the file in your plant data location on the server.
3. Add the following content to the new .XML file:
<Root>
<ItemType name="Item type">
<OrderBy>
<Attribute name="Attribute\Attribution" order="A"/>
</OrderBy>
</ItemType>
</Root>

You can add as many attribute name rows in the XML file as you need. We do not
recommend having more than three attributes so that not to affect the software performance.
ItemType name can be any item type that you need. "Motor" is given as an example.
The order can be either ascending (A) or descending (D).
The customization applies to folders in the Electrical Index and Reference Data Explorer.
This customization applies to main folders and does not apply to sub-folders.
This customization cannot be set according to select list properties or properties with attached
units of measure.
Example: <Root>
<ItemType name="Motor">
<OrderBy>
<Attribute name="PlantGroup.Name" order="A"/>
<Attribute name="TSN" order="A"/>
</OrderBy>
</ItemType>
</Root>

Show Related Items in a New Electrical Index Window


SmartPlant Electrical allows you to select an item in the Electrical Index or Electrical Engineer
and show all the items that are related to the selected item in a new window. For example, if you
select a motor, the software displays the associated control station and feeder circuits grouped
together in a new window. This way you do not need to search for associated items and save
time when wiring your project items.
1. In the Electrical Index or Electrical Engineer right-click an item.
2. On the shortcut menu, click Show Related Items in a New Window.

70

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Move an Item to Another Plant Group


This feature allows you to move multiple or single items to another plant group regardless of the
hierarchy level definitions made in Options Manager. The plant group definitions made in
Options Manager serve only as default settings and do not prevent you from moving items to other
hierarchy levels. Also, you can move items to a plant group that is different from the one in which
these items were created.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Select one or more items of the same item type.
3. Click Actions > Move Items to open the Move Items to Plant Group dialog box.
4. Expand the plant hierarchy and then select the plant group that you require.
5. At the prompt, click Yes to confirm the move.

You must have appropriate access rights for the target plant group to which you want to move
items.
You can move any item type in any folder that is under the Electrical Equipment folder. The
software does not move any control stations, circuits, and so forth that are associated with a
moved item.
If you move an item that has an I/O signal that is in the same plant group as that item, the
software moves the signal with the item to the target plant group. If the signal is in a plant
group that is different from the item's plant group, when you move the item the signal remains
in its original plant group.
If you move a motor with a space heater, the software moves the space heater with the
motor. You cannot move space heaters independently.
If you move a cable, the software also moves its conductors or cable sets. You cannot move
these cable components independently. Also, if you move one cable that is part of a parallel
cable assembly, the software moves all the cables in the assembly.
If you move a junction box or a local panel, the software moves any circuits associated with the
moved item.
You can move a PDB with its associated components, such as buses, cells, and circuits;
however you cannot move those components independently.
You can only move disconnect electrical equipment items that are not associated with any
circuits.

SmartPlant Electrical User's Guide

71

Creating and Modifying Equipment

Properties Window
The Properties window display is a two-column table that provides the common properties of the
current item tag in the active window (Reference Data Explorer, Electrical Index, Electrical
Engineer) or Tabular Editor. The active items always determine the content of the Properties
window. There can only be one Properties window open. If only one tag is selected in the active
window or in the Tabular Editor, or all tags are of the same type, all the properties of that tag type
are displayed. If the selected items have different values for their common properties, the value
field is blank. For select lists, there is a separating line below which all the available values
appear. You can modify the values for these properties in the Properties window.
At the top of the Properties window is the Properties box, listing all of the selected items. Item
properties can be displayed by locating the appropriate item in the Properties box, as well as by
selecting in the Reference Data Explorer, Electrical Index, Electrical Engineer, Tabular
Editor, or open a single line diagram. If more than one item is selected in the active window, then
the list at the top of the Properties window contains the choice Select Set, and individual items in
the set can be selected from the list.
You can use the Copy Bulk Properties and Paste Bulk Properties buttons to copy properties
from one item to another. This action can be particularly useful when, for instance, changes need
to apply to more than one item.

When you pause your pointer over the buttons on the Properties window toolbar, a ToolTip
appears, giving the name of the button.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

Turn the Display of the Properties Window On or Off


1. Display the Properties window by doing one of the following:
Click View > Display > Properties Window on the main menu bar.
Right-click in an empty area of the main toolbar and then click Properties on the shortcut
menu.
2. Use the Properties window to view and edit item properties.

Use Select Set Mode in the Properties Window


You can use the Select Set feature in the Properties window to modify multiple items in bulk
mode. After activating the Select Set feature and selecting several items, the Properties window
displays all the properties that have common values. The changes that you make will take effect
for all the items in the select set.
1. On the Properties window toolbar, click
Show Select Set.
2. In the Electrical Index, select a number of items in the Item Tag pane.
The list right above the toolbar in the Properties window displays Select Set.
3. Modify the properties as you require.
4. To modify the properties of a particular item belonging to the select set, select this item from
the list.
5. To switch back to the common values, from the list, click Select Set.
To switch to single item mode, click

72

Show Single Item on the toolbar.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Review and Edit Item Properties


1. Select the item or items for which you want to review the properties.
2. Display the Properties window by doing one of the following:
Click View > Display > Properties Window on the main menu bar.
Right-click the empty area of the main toolbar and then click Properties on the shortcut
menu.
3. Enter or edit information in the cell next to the appropriate property.
If you have selected more than one item, you can perform global replacement of property
values by choosing Select Set from the list at the top of the Properties window and typing
data for the property you want to edit. The data value is then populated in all the items of the
select set.
4. Enter or edit information in the cell next to the appropriate property.

You can review and edit item properties in the Tabular Editor too. You can edit the contents of
some cells directly in the table if the corresponding property is not read-only or generated
strictly by a calculation. Or you can click any cell or on the row number to the left of the table
to select an item and edit its properties in the Properties window.
In place of values that include automatically assigned units of measure, you can type any
string preceded by a single quote. This is useful if you do not initially know a specific value
and want to insert a comment instead.

Properties Window Toolbar


You can customize the display of the Properties window by using the following Properties
window toolbar buttons:
Alphabetic Lists properties in alphabetical order.
Categorized Displays properties grouped by specific categories. Categories are defined
and properties are assigned to those categories in Data Dictionary Manager.
Show Brief Properties Displays those properties that have been previously specified as
brief on the Advanced Table Properties dialog box.
Copy Bulk Properties Copies the bulk properties of a selected item. The properties are
then available to paste onto other items. For more information, see Copy Bulk Properties (on
page 74).
Paste Bulk Properties Pastes copied bulk properties onto the newly selected item or
items. You must have previously selected an item or items and copied bulk properties. For more
information, see Paste Bulk Properties (on page 75).
Display Null Displays a null value in blank properties that currently contain no value. This
option helps avoid confusion between empty cells and cells containing a zero. For more
information, see Display Null Values in the Properties Window (on page 76).
Show Case Data Displays a list of case conditions, for example, temperatures, pressures,
and so forth. Case data includes both process cases and control cases, which are displayed for
equipment, pipe runs or instruments, according to relevance. To see the case data that appears
for corresponding items, look in Data Dictionary Manager.

SmartPlant Electrical User's Guide

73

Creating and Modifying Equipment


Show Select Set Allows you to modify the properties of multiple items (a select set of
items) that you selected in the Electrical Index or a drawing. When working in a drawing, using a
fence to select a set of items, displays the common properties of the selected items. This option
improves display performance.
Show Single Item Allows you to modify the properties of single item that you select in the
Electrical Index or a drawing. When working in a drawing, using a fence to select a set of items,
displays the properties of one item only. If you select multiple items by holding down the SHIFT
key, the software displays the select set properties.

The software includes a default set of bulk and brief properties, but you can change those
properties in the Usage box on the Layout tab of the Advanced Table Properties dialog box.
When a URL such as: http://www.google.com?hl=en&q=Intergraph is entered in a
Description field, the software will not recognize it as a URL because it contains special
characters (?, & and =). The user has to manually replace special characters with encoded
characters as shown.
Special Character

Replace With

3F

3D

&

26

In this example, you would change:


http://www.google.com?hl=en&q=Intergraph
to:
http://www.google.com%3Fhl%3Den%26q%3DIntergraph

Copy Bulk Properties


1. In the Electrical Index or Tabular Editor window, select the item for which you want to copy
the bulk properties.
2. In the Properties window, click Copy Bulk Properties
.
3. These properties are now available to paste onto another item. For more details, see Paste
Bulk Properties (on page 75).
You must have a bulk layout defined for the item type of the selected item.

74

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Paste Bulk Properties


1. In the Electrical Index or Tabular Editor window, select the item or items that you want to
paste bulk properties onto.
You must first have copied the bulk properties of a different item in order to paste them
onto your current selection. For more details, see Copy Bulk Properties (on page 74).
2. If you have selected to paste onto more than one item, from the tag list at the top of the
Properties window, choose Select Set.
3. Click Paste Bulk Properties
your current selection.

on the Properties window toolbar to paste properties onto

Customizing Data Display in the Properties Window


You can customize the display of the Properties window by using the following Properties
window toolbar buttons:
Lists properties in alphabetical order.

Alphabetic

Categorized

Copy Bulk Properties


Copies the bulk properties of a selected item. The properties
are then available on the Paste Bulk Items button.

Display Null
Displays a null value in blank properties that currently contain no value.
This option help avoid confusion between empty cells and those containing a zero.

Paste Bulk Properties


Pastes copied bulk properties onto the newly selected item or
items. You must have previously selected an item or items and copied bulk properties.

Show Brief Properties


specified as Brief.

Displays properties grouped by specific categories.

Displays those properties that have been previously

Customize Data Display in the Properties Window


1. If the Properties window is not already displayed, do one of the following:
Click View > Display > Properties Window on the main menu bar.
Right-click in an empty area of the main toolbar and then click Properties on the shortcut
menu.
2. You can display properties alphabetically or by categories by clicking the corresponding
display mode button. Click

to display alphabetically. Click

to display by categories.

3. You can display only brief properties by clicking Show Brief Properties

4. You can display a null character in empty properties cells by clicking Display Null

When you point to a button on the Properties window toolbar and pause over it, a ToolTip
displays the corresponding command.
You create categories and assign properties to them in the Data Dictionary Manager.

SmartPlant Electrical User's Guide

75

Creating and Modifying Equipment

Show Brief Properties

Click the Show Brief Properties button

in the Properties window.

Display Null Values in the Properties Window


1. Select an item in your drawing.
2. Right-click and select Properties.
3. Click the Display Null button

to display a null value in blank properties.

Add a Text Box for UDFs in the Properties Window


In the Properties window, for long descriptions of user-defined properties, you can add a text box
where you can type a long text value.
This functionality is available only for user-defined properties that have the String
data type.
1. In Data Dictionary Manager, add or modify a property.
2. For the Data Type property, select String.
3. For the Calculation ID property, type the following value:
SPELForeignCalc.ForeignCalc
4. Click OK and close Data Dictionary Manager.
5. In the Properties window, scroll to the appropriate user-defined property and click
to
open the text box where you can type your text as needed. Note that the length of the text is
determined by the value that you enter for the Maximum Length property when defining the
user-defined property in Data Dictionary Manager.

76

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Create a New Item in the Electrical Index


This procedure explains how to create a new plant item in the Electrical Index. You can create
electrical loads, cables, junction boxes, power distribution boards, buses, and so forth.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Navigate to the folder or parent item where you are going to add the new item, right- click, and
then click New.
3. Accept the default item tag that is based on the naming convention for the item type, or type
your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. Edit the item properties in the Properties window as required.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You access this dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the item. For full details of the properties, see the
appropriate dialog box topic.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Create a Project Item Based on a Reference Item


When you copy a reference item containing typical data that you use frequently, you save time by
using the reference item as a template. This way, you do not have to type common values every
time that you create a new item in the Electrical Index.
1. In the Reference Data Explorer, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders until you can see the item that you want to copy.
2. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders and navigate to the folder of the item type corresponding to the item that
you want to copy. For example, to copy a motor, expand the folder hierarchy Electrical
Equipment > Loads > Motors and select the Motors folder.
3. Drag the item from the Reference Data Explorer to the appropriate folder in the Electrical
Index.
You can copy an item from the Reference Data Explorer only to a folder in the
Electrical Index that can contain items of the same type.
4. Accept the default item tag that is based on the naming convention for the item type, or type
your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).

SmartPlant Electrical User's Guide

77

Creating and Modifying Equipment


5. For the item that you copied to the Electrical Index, edit the item properties in the Properties
window.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You access this dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the item. For full details of the properties, see the
appropriate dialog box topic.
When you copy a reference item, the software copies the item properties, except for the Item
tag property, which follows the item naming convention.
For an item that includes sub- items, such as a typical circuit with internal components, the
software copies the sub-items as well. In this case, the sub-items are the circuit components.

Edit Item Properties


When an item is selected in the Reference Data Explorer or the Electrical Index, you can edit
the item properties in the Properties window. For some of the items, you can edit the most
commonly used properties more conveniently on a dialog box.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Edit the item properties as required in the Properties window. Note that an asterisk beside a
property name indicates required data.

For some items, you can edit properties in either the Properties window or on a Common
Properties dialog box. You can click the Common Properties command on the shortcut
menu for an item to open a dialog box on which you can edit the most commonly used
properties for the item. For full details of the properties, see the appropriate dialog box topic.
If you edit a profile, a typical circuit, or a control station in the Reference Data Explorer, the
software uses the latest update when you next apply options to a project item. For example, if
you modify the components of a typical circuit that already has a reference from a motor, the
software does not automatically update the change in the typical circuit connected to the
motor. The software updates the change only when you next apply a typical circuit or a profile
to the motor.

Duplicate an Item
You can duplicate an item in the Reference Data Explorer or Electrical Index. This method is
advantageous when you have items that include a hierarchy of sub-items, in which case the
software duplicates the sub-items including the parent items.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Right-click an item, and on the shortcut menu, click Duplicate.
3. Accept the default item tag that is based on the naming convention for the item type, or type
your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).

78

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


4. For the item that you duplicated, edit the item properties in the Properties window.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you duplicate the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You access this dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the item. For full details of the properties, see the
appropriate dialog box topic.
When you duplicate an item, the software copies only the item properties, except for the Item
tag property, which follows the item naming convention. The software does not copy
associated items such as cables, typical circuits, or control stations, nor does it duplicate
associations to feeder circuits.
For an item that includes sub- items, such as a circuit with internal components, the software
duplicates the sub-items as well. In this case, the sub-items are the circuit components.

Rename an Item
This procedure explains how to rename an existing item in the Electrical Index, Electrical
Engineer, or Reference Data Explorer.
1. In the Reference Data Explorer, the Electrical Index, or the Electrical Engineer, expand
the folder hierarchy by clicking the + icons or double-clicking the folders.
2. Select an item and open the Item Tag dialog box by doing one of the following:
Right-click the item, and on the shortcut menu, click Rename.
Press F2.
3. Type a new item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on page
65).
If you rename a profile, a typical circuit, or a control station in the Reference Data
Explorer, the software uses the new name if there is a reference to one of these items from a
project item. For example, if you change the name of a typical circuit that already has a reference
from a motor, the software automatically updates the name of the typical circuit associated with
the motor.

Delete an Item
You can delete items in the Reference Data Explorer or the Electrical Index. When you delete
items, the software deletes them from the database.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy by
clicking the + icons or by double-clicking the folders.
2. Right-click the item that you want to delete, and on the shortcut menu, click Delete.
3. At the prompt, click Yes to confirm the deletion.

You can delete only items that do not have associations to other items. For example, you
cannot delete a power distribution board associated with loads unless you first dissociate the
loads.

SmartPlant Electrical User's Guide

79

Creating and Modifying Equipment

If you select more than one item for deletion, any failures to delete items are recorded in the
Batch Deletion log file. For the procedure for creating and viewing the log file, see Generate
Error Log Files (on page 34).

Rules for Deleting Reference Items


The following rules apply when you delete an item in the Reference Data Explorer:
Item

Precondition

Result

Profile

The profile is not the most


recent one that you applied to
any motor.

The software deletes the profile only.

Typical circuit

You have dissociated the


The software deletes the typical circuit
typical circuit from all profiles to and all the circuit components.
which it belonged and the
typical circuit is not the most
recent one that you applied to
any electrical equipment.

Typical control
station

You have dissociated the


typical control station from all
profiles to which it belonged
and the typical control station
does not have a link with any
electrical equipment.

Typical
schematic

You have dissociated the


The software deletes the typical
schematic from all profiles and schematic only.
project loads to which it
belonged.

Typical block

You have dissociated the block The software deletes the typical block
from all schematics to which it only.
belonged.

Typical motor

You have dissociated the motor The software deletes the motor and
from all profiles to which it
any space heater associated with the
belonged.
motor.

The software deletes the typical


control station and dissociates any
control station cables.

Rules for Deleting Project Items


The following rules apply when you delete an item in the Electrical Index:

80

Item

Precondition

Result

Motor

None.

The software deletes any space


heater associated with the motor and
clears any To side cable
association. The software also clears
any relationships to control stations.

Static load

None.

The software clears any To side cable


association. The software also clears
any relationships to control stations.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


Item

Precondition

Result

Converting
equipment

None.

The software moves any items in the


electrical hierarchy below the deleted
converting equipment to the root of the
Electrical Engineer. The software
also clears any From or To side cable
association.

Panel

You have dissociated all the


circuits in the panel from
external items, such as cables,
loads, and so forth.

The software deletes all the internal


panel circuits and moves any items in
the electrical hierarchy below the
deleted panel to the root of the
Electrical Engineer.

Panel circuit

None.

The software moves any items in the


electrical hierarchy below the deleted
panel circuit to the root of the
Electrical Engineer.

Working with Loads


The following section contains topics related to the creation and management of loads.
Loads in SmartPlant Electrical are arranged in the following sub-folders:
Motors (for details, see Electrical Motors (on page 82).)
Static Electrical Equipment (for details, see Create Static Electrical Equipment (on page
85)):
heaters
heat traces
capacitors
harmonic filters
resistors
Miscellaneous Electrical Equipment (for details, see Create Miscellaneous Electrical
Equipment (on page 87)):
lighting fixtures
socket outlets
welding outlets
other electrical equipment
Also, you can create load items in batch mode. For details, see Create Load Items in Batch Mode
(on page 82).

SmartPlant Electrical User's Guide

81

Creating and Modifying Equipment

Create Load Items in Batch Mode


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads.
2. In the Electrical Index, expand the Electrical Equipment folder hierarchy by clicking the +
icons or by double-clicking the folders.
3. With the desired folder selected, right-click, and then click Tools > Apply Options.
4. On the Apply Options dialog box, click the Equipment Profile tab.
5. Select Enable equipment profile.
6. In the Number of items to create box, enter the number of new electrical items that you want
to create.
7. Beside Create item based on profile, click Find.
8. On the Find dialog box, click Find Now to display the available profiles.
9. From the list of profiles, highlight the profile that you want to apply to the newly created items
and click OK.
10. Click Apply.

If the Create item based on profile box contains the text No default profile exists, the
software does not create any items when you click Apply. You must select a profile first.
If the profile contains a reference item, the software populates new items that you create by
this method with values copied from the reference item.

Electrical Motors
The following sub-section contains topics related to the creation and management of electrical
motors.

Create an Electrical Motor


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads >
Motors.
2. Right-click the Motors folder, and then click New Motor or New Motor with Heater.
If you create a motor without a heater, you can add a heater later by right-clicking the
motor, and on the shortcut menu, clicking New Space Heater.
3. Accept the default item tag that is based on the naming convention for the motor, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. On the Electrical Motor Common Properties dialog box, edit the motor properties as
required. For more details, see Edit Electrical Motor Common Properties (on page 83).

82

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new
electrical motor.
The Electrical Motor Common Properties dialog box shows the most commonly used
properties. You access this dialog box by clicking the Common Properties command on the
shortcut menu or you can specify in the preferences to open the dialog box directly when you
create a new electrical motor.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
When you add a motor with a space heater, the heater appears as a sub-item of the
motor. The motor symbol includes an indication that it has a space heater
. If you
subsequently delete the motor, the software deletes the heater also.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Edit Electrical Motor Common Properties


1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Load > Motors.

For a motor without a heater, you can add a heater by right-clicking the motor, and on the
shortcut menu, clicking New Heater.
You can delete a heater from a motor by selecting the heater, and on the shortcut menu,
clicking Delete.
2. Right-click the desired motor and click Common Properties to open the Electrical Motor
Common Properties dialog box.
3. Edit the data as needed on each tab. Note that an asterisk beside a property name indicates
required data.
For full details of the most commonly used properties, see the Electrical Motor Common
Properties dialog box (on page 691). Also, you can use the Properties window or the Tabular
Editor to edit these properties.

Calculate Power Requirements for an Electrical Motor


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads >
Motors.
2. Do one of the following:
Expand the Motors folder and select an existing motor from the list.
Right-click the Motors folder, then create a new motor.
3. Right-click the motor and click Common Properties to open the Electrical Motor Common
Properties dialog box.
4. Click the Load Data tab and enter the appropriate load data properties.
5. Click the Electrical Data tab to view the calculated power requirements for the motor.

For full details of the properties that the software uses in power calculations and the formulas
the software uses to calculate power requirements, see Electrical Calculations (on page 569).
For full details of the most commonly used properties, see the Electrical Motor Common
Properties dialog box (on page 691). Also, you can edit these properties and additional
properties on the Properties window or on the Tabular Editor.

SmartPlant Electrical User's Guide

83

Creating and Modifying Equipment

Brake Power / Demand Factor Calculation


The software enables you to calculate the required brake power or demand factor values for an
electrical motor in your plant. The standard (default mode) for load data calculation is to enter an
appropriate rated power value and let the software calculate the demand factor. Alternatively, you
can also enter an appropriate demand factor value and select a motor rated power value. In this
case, SmartPlant Electrical will calculate the brake power.
If you want to be able to enter a demand factor value so that the software can
calculate the brake power, prior to making your calculations, you must set the Demand factor
property in the Data Dictionary Manager to Write. For details about setting permissions for
SmartPlant Electrical properties, see the Data Dictionary Manager Guide > Defining Item Type
Properties > Modify Item Type Properties.
Therefore, the software does the following depending on your input on the Load Data tab of the
Electrical Motor Common Properties dialog box:
1. No values have been entered for the motor rated power, brake power, or demand factor.
Enter the motor rated power and brake power values to calculate the demand factor.
Enter the motor rated power and demand factor values to calculate the brake power.
2. The three values (the motor rated power, brake power, and demand factor) have already been
entered or calculated.
Changing the motor rated power recalculates the demand factor.
Changing the brake power recalculates the demand factor.
Changing the demand factor calculates the brake power.
To calculate the demand factor or brake power, do the following:
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads >
Motors.
2. Do one of the following:
a. Expand the Motors folder and select an existing motor from the list.
b. Right-click the Motors folder, then create a new motor.
3. Right-click the motor and click Common Properties to open the Electrical Motor Common
Properties dialog box.
4. Click the Load Data tab.
5. Enter an appropriate motor rated power value.
In order for the software to make the required calculation, you must select an
appropriate motor rated power value either before or after you enter the demand factor or
brake power value. The software will make the required calculation once the motor rated
power and the second value have been entered.
6. Do one of the following:
To calculate the Demand factor, type an appropriate Brake power value.
To calculate the Brake power, type an appropriate Demand factor value.
7. Click in another property or press the Tab key.

84

The Demand factor value affects the following properties of electrical motors:
Brake power.
Power factor and efficiency at demand.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Duplicate an Electrical Motor


1. In the Reference Data Explorer or the Electrical Index, expand the Electrical Equipment >
Load > Motors folder hierarchy.
2. Right-click a motor and click Duplicate to make a copy of the motor at the lowest position in
the folder.
3. Accept the default item tag that is based on the naming convention for the motor, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. If required, on the Electrical Motor Common Properties dialog box, edit the motor
properties as required. For more details, see Edit Electrical Motor Common Properties (on
page 83).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you duplicate an
electrical motor.
The Electrical Motor Common Properties dialog box shows the most commonly used
properties. You access this dialog box by clicking the Common Properties command on the
shortcut menu or you can specify in the preferences to open the dialog box directly when you
duplicate an electrical motor.
When you duplicate a motor, the software copies only the item properties, except for the Item
tag property, which follows the motor naming convention. The software does not copy
associated items such as cables, typical circuits, or control stations, nor does it duplicate
associations to feeder circuits.
When the motor has a space heater, the software duplicates the space heater as well.

Create Static Electrical Equipment


You can create the following types of static electrical equipment in your project:
Heaters You can create electrical process heaters for heating fluids in the plant.
Heat Traces An electrical heat trace is a kind of cable that is used to heat equipment and
pipes, to ensure that the temperature for the process does not fall below the desired level.
Capacitors You can include power factor correction capacitors in your project.
Harmonic Filters A harmonic filter enables you to select and filter out a particular
frequency in a power distribution network.
Resistors You can include power dissipation resistors in your project.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Loads > Static Electrical Equipment.
2. Right-click the folder for the desired item type - for example, Heaters - and then click New.
3. Accept the default item tag or type your own item tag for the item.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the item type. For more details of naming convention settings, see Using Naming
Conventions (on page 65).

SmartPlant Electrical User's Guide

85

Creating and Modifying Equipment


4. On the Static Load Common Properties dialog box, edit the item properties as
required. Note that an asterisk beside a property name indicates required data.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new item.
The Static Load Common Properties dialog box shows the most commonly used
properties. You access this dialog box by clicking the Common Properties command on the
shortcut menu or you can specify in the preferences to open the dialog box directly when you
create a new item.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Absorbed Power / Demand Factor Calculation for Static Loads


The software enables you to calculate the required absorbed power or demand factor values for a
static and miscellaneous electrical equipment item in your plant. The standard (default mode) for
load data calculation is to enter an appropriate rated power and demand factor values and let the
software calculate the absorbed power. Alternatively, you can also enter an appropriate demand
factor and rated power values. In this case, SmartPlant Electrical will calculate the absorbed
power.
Therefore, the software does the following depending on your input on the Load Data tab of the
Common Properties dialog box:
1. No values have been entered for the rated power, absorbed power, or demand factor.
Enter the rated power and absorbed power values to calculate the demand factor.
Enter the rated power and demand factor values to calculate the absorbed power.
2. The three values (the rated power, absorbed power, and demand factor) have already been
entered or calculated.
Changing the rated power recalculates the demand factor.
Changing the absorbed power recalculates the demand factor.
Changing the demand factor calculates the absorbed power.
To calculate the demand factor or absorbed power, do the following:
1. Open the Common Properties dialog box by right-click the load in the Electrical Index.
2. Click the Load Data tab.
3. Enter an appropriate rated power value.
In order for the software to make the required calculation, you must select an
appropriate rated power value either before or after you enter the demand factor or absorbed
power value. The software will make the required calculation once the rated power and the
second value have been entered.
4. Do one of the following:
To calculate the Demand factor, type an appropriate Absorbed power value.
To calculate the Absorbed power, type an appropriate Demand factor value.
Click in another property or press the Tab key.

86

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Create Miscellaneous Electrical Equipment


Miscellaneous electrical equipment includes the following items that you can create in your
project:
Lighting Fixtures You can add and define each lighting fixture in your plant, whether the
fixture consists of single or multiple lighting units.
Socket Outlets You can add and define each socket outlet in your plant, whether the outlet
consists of single or multiple sockets.
Welding Outlets You can add and define welding outlets in your plant.
Other Electrical Equipment You can add and define any other general type of electrical
equipment in your plant.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Loads > Miscellaneous Electrical Equipment.
2. Right-click the folder for the desired item type - for example, Lighting Fixtures - and then
click New.
3. Accept the default item tag or type your own item tag for the item.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the item type. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. On the Other Electrical Equipment Common Properties dialog box, edit the item
properties as desired. Note that an asterisk beside a property name indicates required data.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new item.
The Other Electrical Equipment Common Properties dialog box shows the most commonly
used properties. You access this dialog box by clicking the Common Properties command
on the shortcut menu or you can specify in the preferences to open the dialog box directly
when you create a new item.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

87

Creating and Modifying Equipment

Absorbed Power / Demand Factor Calculation for Miscellaneous


Electrical Equipment
The software enables you to calculate the required absorbed power or demand factor values for a
static and miscellaneous electrical equipment item in your plant. The standard (default mode) for
load data calculation is to enter an appropriate rated power and demand factor values and let the
software calculate the absorbed power. Alternatively, you can also enter an appropriate demand
factor and rated power values. In this case, SmartPlant Electrical will calculate the absorbed
power.
Therefore, the software does the following depending on your input on the Load Data tab of the
Common Properties dialog box:
1. No values have been entered for the rated power, absorbed power, or demand factor.
Enter the rated power and absorbed power values to calculate the demand factor.
Enter the rated power and demand factor values to calculate the absorbed power.
2. The three values (the rated power, absorbed power, and demand factor) have already been
entered or calculated.
Changing the rated power recalculates the demand factor.
Changing the absorbed power recalculates the demand factor.
Changing the demand factor calculates the absorbed power.
To calculate the demand factor or absorbed power, do the following:
1. Open the Common Properties dialog box by right-click the load in the Electrical Index.
2. Click the Load Data tab.
3. Enter an appropriate rated power value.
In order for the software to make the required calculation, you must select an
appropriate rated power value either before or after you enter the demand factor or absorbed
power value. The software will make the required calculation once the rated power and the
second value have been entered.
4. Do one of the following:
To calculate the Demand factor, type an appropriate Absorbed power value.
To calculate the Absorbed power, type an appropriate Demand factor value.
5. Click in another property or press the Tab key.

88

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Managing Space Heaters and Their Power Supplies


The software provides for the creation and management of space heaters and their power
supplies. It is possible to design space heaters that are powered from either the main bus circuit or
another bus which does not feed the main equipment that is associated with the space heater. To
illustrate the possible design scenarios, let's consider an electrical motor with an associated space
heater. While the motor is fed by the main bus circuit (for example, 400V, 3.3Kv), the space heater
can be fed from different buses:
A separate PDB with a dedicated direct feeder.
A separate PDB with a dedicated feeder circuit that powers the auxiliary contact of the main
motor feeder circuit breaker (contactor or starter) and from there feeds the space heater.
An internal auxiliary bus and feeder circuit that powers the auxiliary contacts of the circuit
breaker or contactor and from there feeds the space heater.

Associating Space Heaters and Auxiliary Contacts with Main Equipment


You can associate space heaters and auxiliary contacts with the relevant electrical equipment
either in the Electrical Engineer or a cable block diagram.

Presentation of Space Heaters and Auxiliary Contacts in Single Line Diagrams


After creating and the required plant items and associating them with the relevant equipment, you
select whether to show the space heaters and auxiliary contacts next to their main equipment or
under their feeding equipment.

Accounting for Space Heaters and Auxiliary Contacts in Load Summaries


All load summary reports include all loads with their space heaters connected to respective buses.

Accounting for Space Heaters and Auxiliary Contacts in Batch Load Associations
Space heaters connected through the main equipment circuit auxiliary contacts are shown and
taken into account in the batch load association of the bus that feeds the auxiliary contact and not
the main equipment bus.
On the Batch Load Association dialog box, you can now select space heaters as regular loads
even if they are connected through auxiliary contacts.

To see various recommended scenarios for working with space heaters and auxiliary
contacts, see Suggested Workflows for Space Heaters and Auxiliary Contacts (on page 90).
When designing electrical terminations of space heaters, to terminate the auxiliary contact
with a space heater or any other electrical equipment item, terminate the cable conductors to
the terminal strip of the circuit where the auxiliary contact is located.
If you are generating a cable schedule report for a cable that is connected to an auxiliary
contact, the cable schedule report will display the full connection path:
PDB > Bus > Cell > Circuit > Circuit internal disconnect electrical equipment > Auxiliary
contact
Or
Stand-alone disconnect electrical equipment > Auxiliary contact

SmartPlant Electrical User's Guide

89

Creating and Modifying Equipment

When performing bus load association and assigning a load to another bus on the Cached
Loads tab of the Bus Load Association dialog box, the software checks if the selected load
is associated with a heater that is connected through an auxiliary contact that is fed from the
same circuit as the selected load. If the software detects such a heater, it will prompt you to
move the associated circuit together with the load. If you click Yes, the software will move the
load and its heater together with the associated circuit to another bus. If you click No, the
software will only move the selected load without moving the heater or the circuit. In this case,
you will have to move the associated heater manually.

Suggested Workflows for Space Heaters and Auxiliary


Contacts
The following scenarios are suggested workflows for the design of space heaters in your plant.
Prior to generating your single line diagrams, you have to decide if you want to
represent your plant space heaters and auxiliary contacts as independent symbols or make them
part of symbol assemblies(for example, a symbol assembly that contains a circuit, circuit breaker,
and an auxiliary contact). For details about using symbol assemblies, see Use Symbol
Assemblies for Space Heaters with Motors in SLDs (on page 98) and Use Symbol Assemblies for
Disconnect Equipment with Auxiliary Contacts in SLDs (on page 99).

90

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


Scenario 1:
Auxiliary contact and space heater are powered from an external power supply provided by a PDB
or bus that does not feed the main equipment. In this scenario, we want to create the design
shown in the following single line diagram:

To create the design shown above, do the following:


1. In the Electrical Index or cable block diagram, create two separate electrical branches:
A branch for the main motor.
A branch for the feeder to supply the power to the auxiliary contact.
2. Associate the space heater and its power cable with the output of the auxiliary contact.
3. Associate the input of the auxiliary contact with its power cable and feeder.
You can make the associations either in the Electrical Engineer or cable block
diagram.

SmartPlant Electrical User's Guide

91

Creating and Modifying Equipment


a. In the Electrical Engineer, the electrical tree should look like so:

b. In a cable block diagram, the associations should look like so:

92

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


Scenario 2:
Auxiliary contact and space heater powered from a bus that does not feed the main equipment.
Both the space heater and auxiliary contact are located in the same PDB. In this scenario, we
want to create the design shown in the following single line diagram:

The design can include a cable between the input of the auxiliary contact and its feeding
circuit as shown above. Alternatively, you can design it without a cable. In this case, all the
connections are made internally in the PDB.
To create the design shown above, do the following:
1. In the Electrical Index or cable block diagram, create two separate electrical branches in the
same PDB:
A branch for the main motor.
A branch for the feeder to supply the power to the auxiliary contact.

SmartPlant Electrical User's Guide

93

Creating and Modifying Equipment


There is no cable connecting the auxiliary contact and its feeder circuit because
both the auxiliary contact and its feeder circuit are in the same PDB.
2. Associate the space heater with the output of the auxiliary contact.
3. Associate the input of the auxiliary contact with its feeder.
You can make the associations either in the Electrical Engineer or cable block
diagram.
a. In the Electrical Engineer, the electrical tree should look like so:

b. In a cable block diagram, the associations should look like so:

94

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


Scenario 3:
Auxiliary contact and space heater powered from the same circuit as the main equipment feeder
circuit. In this scenario, we want to create the design shown in the following single line diagram:

In this design, the power for the space heater is provided by either an internal connection
taken from one of the phases or by using an internal transformer that converts the three-phase
400v of the main bus to lower, single-phase voltages. The software shows these internal items as
auxiliary graphics that are contained in the symbol of the auxiliary contact.
To create the design shown above, do the following:
1. In the Electrical Index or cable block diagram, create one electrical branch for the main
motor.
2. Associate the space heater with the output of the auxiliary contact by dragging the auxiliary
contact under the main circuit to supply the power to the auxiliary contact and space heater
(through the auxiliary contact).
A branch for the feeder to supply the power to the auxiliary contact.
There is no cable connecting the auxiliary contact and its feeder circuit because
both the auxiliary contact and its feeder circuit are in the same PDB.

SmartPlant Electrical User's Guide

95

Creating and Modifying Equipment


a. In the Electrical Engineer, the electrical tree should look like so:

b. In a cable block diagram, the associations should look like so:

For detailed information about the creation and association of electrical items, see the topics in the
Managing Space Heaters and Their Power Supplies section in the table of contents as well as
the topics listed below:
Create a Space Heater (on page 97)
Create an Auxiliary Contact (on page 109)
Working with Smart Data and Auxiliary Graphics in a CBD (on page 320)
Create an Electrical Association (on page 186)
Rules for Associating Electrical Equipment (on page 187)
Change an Existing Electrical Association (on page 191)

96

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Create a Space Heater


This procedure explains how to add a space heater to an electrical motor.
You can create an electrical motor with a space heater. This procedure deals with adding a
space heater to a motor that was created without a space heater.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads >
Motors.
2. Right-click an existing motor, and then click New Space Heater.
3. Accept the default item tag that is based on the naming convention for the space heater, or
type your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. On the Static Load Common Properties dialog box, edit the space heater properties as
required. For more details, see Static Load Common Properties Dialog Box (on page 722).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new
electrical motor.
The Static Load Common Properties dialog box shows the most commonly used
properties. You access this dialog box by clicking the Common Properties command on the
shortcut menu or you can specify in the preferences to open the dialog box directly when you
create a new electrical motor.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
After adding a space heater to a motor, the space heater appears as a sub-item of the
motor. The motor symbol includes an indication that it has a space heater
. If you
subsequently delete the motor, the software deletes the heater also.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Show Space Heaters Next to the Associated Motors in SLDs


In single line diagrams, you can show space heaters adjacent to their associated motors.
This procedure applies only to those space heaters that are represented by
independent space heater symbols. If the space heater symbol is represented by a symbol
assembly, see Use Symbol Assemblies for Space Heaters with Motors in SLDs (on page 98).
1. Do one of the following:
Generate a new single line diagram. For more information, see Generating New Single
Line Diagrams (on page 287).
Open an existing single line diagram. For more information, see Opening Existing Single
Line Diagrams. (see "Opening Existing Single Line Diagrams" on page 293)
2. Click Tools > Drawing Options.
3. On the Single Line Drawing Options dialog box, click the Related Equipment tab.
4. Under Space heater options, select the Show space heaters next to associated motors
check box.

SmartPlant Electrical User's Guide

97

Creating and Modifying Equipment


5. Under Space heater symbol displacement, type the values for the X: and Y: coordinates,
and select the units required from the Units list.
6. Click Generate.
If you do not select the Show space heaters next to associated motors check
box, the space heaters will be shown under their feeding equipment or they will not be shown at all
if their feeding equipment is not part of the current SLD.

Use Symbol Assemblies for Space Heaters with Motors in


SLDs
In single line diagrams, you can use a symbol assembly to show a space heater next to its
associated motor.
1. Create a symbol assembly that suits your needs, for example an electrical motor and a space
heater. For details, see Creating and Using Symbol Assemblies for SLD Diagrams (on page
308).
2. Associate the new symbol assembly with the relevant item type in Options Manager. For
details, see Create and Use a Symbol Assembly (on page 309).
You can associate just a specific electrical item with a custom symbol and select a
symbol assembly if you want to use this symbol assembly just for that particular electrical
item. For details, see Use Custom Symbols in SLDs (on page 305).
3. Generate your single line diagram.
The Space heater options on the Related Equipment tab of the Single Line
Diagram Options do not apply for electrical items associated with a symbol assembly.

Show Auxiliary Contacts Next to Disconnect Equipment in


SLDs
In single line diagrams, you can show auxiliary contacts next to their associated disconnect
equipment.
This procedure applies only to those auxiliary contacts that are represented by
independent auxiliary contact symbols. If the auxiliary contact symbol is represented by a symbol
assembly, see Use Symbol Assemblies for Disconnect Equipment with Auxiliary Contacts in SLDs
(on page 99).
1. Do one of the following:
Generate a new single line diagram. For more information, see Generating New Single
Line Diagrams (on page 287).
Open an existing single line diagram. For more information, see Opening Existing Single
Line Diagrams. (see "Opening Existing Single Line Diagrams" on page 293)
2. Click Tools > Drawing Options.
3. On the Single Line Drawing Options dialog box, click the Related Equipment tab.
4. Under Auxiliary contact options, select the Show auxiliary contacts next to disconnect
equipment check box.
5. Under Auxiliary contact symbol displacement, type the values for the X: and Y:
coordinates, and select the units required from the Units list.

98

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


6. Click Generate.
If you do not select the Show auxiliary contacts next to disconnect equipment
check box, the auxiliary contacts will be shown under their feeding equipment or they will not be
shown at all if their feeding equipment is not part of the current SLD.

Use Symbol Assemblies for Disconnect Equipment with


Auxiliary Contacts in SLDs
In single line diagrams, you can use a symbol assembly to show an auxiliary contact next to its
associated disconnect equipment item.
1. Create a symbol assembly that suits your needs, for example a circuit breaker and an
auxiliary contact. For details, see Creating and Using Symbol Assemblies for SLD Diagrams
(on page 308).
2. Associate the new symbol assembly with the relevant item type in Options Manager. For
details, see Create and Use a Symbol Assembly (on page 309).
You can associate just a specific electrical item with a custom symbol and select a
symbol assembly if you want to use this symbol assembly just for that particular electrical
item. For details, see Use Custom Symbols in SLDs (on page 305).
3. Generate your single line diagram.
The Space heater options on the Related Equipment tab of the Single Line
Diagram Options do not apply for electrical items associated with a symbol assembly.

Create a Generator
You can include generators to provide power supply for your utility.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Generators.
2. Right-click the Generators folder, and then click New.
3. Accept the default item tag or type your own item tag for the generator.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
generator. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. Edit the generator properties in the Properties window as required.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the
generator.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

99

Creating and Modifying Equipment

Define a Neutral Earthing Connection for Generators


The following procedure explains how to define a neutral earthing connection for a generator by
creating a neutral earthing connection branch under a particular generator in the Electrical
Engineer.
1. In the Electrical Engineer, under a generator, create an independent branch that starts with
a power cable or busway.
2. Right-click an appropriate generator and then click Common Properties on the shortcut
menu.
3. Click the Electrical Data tab.
4. Under the Neutral Earthing box, click Find.
5. On the Find dialog box, click Find Now and then select an appropriate child power cable or
busway that will be connected to the non-power connection point of the generator symbol in
an SLD.
6. Click OK to return to the Electrical Data tab of the Generator Common Properties dialog
box.
7. Generate an SLD for that generator.

After generating an SLD, the diagram will display the neutral earthing branch connected to a
non-power connection point of the generator.
If you are using custom symbols for your generators in SLDs, make sure that they have an
additional non-power connection point. Alternatively, you can use one of the symbol
provided in the shipped data.

Create an Offsite Power Supply


You can include offsite power supplies to provide power supply for your utility.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Offsite Power Supplies.
2. Right-click the Offsite Power Supply folder, and then click New.
3. Accept the default item tag or type your own item tag for the offsite power supply.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
offsite power supplies. For more details of naming convention settings, see Using
Naming Conventions (on page 65).
4. Edit the generator properties in the Properties window as required.

100

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create an offsite
power supply.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

Creating and Modifying Equipment

Create a Battery Bank


You can include battery banks to provide a power supply backup for your utility.
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Battery Banks.
2. Right-click the Battery Banks folder, and then click New.
3. Accept the default item tag or type your own item tag for the battery bank.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the battery bank. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. Edit the battery bank properties in the Properties window as required.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create the battery
bank.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Converting Equipment
The following section contains topics related to the management of various types of converting
electrical equipment.
Battery Chargers
Other Converting Equipment these includes devices such as rectifiers.
Transformers You can include various transformers in your project wherever you need to
step-down or step-up the voltage. You can create transformers with two or three sets of
windings. For more information, see Create a Transformer (on page 102).
Uninterrupted Power Supplies (UPSs)
Variable Frequency Drives (VFDs)
Current Limiting Reactors
For information on how to define a converting equipment item as a consumer, see Define
Converting Equipment as Consumers (on page 104).

SmartPlant Electrical User's Guide

101

Creating and Modifying Equipment

Create Converting Equipment


The following procedure applies to the creation of battery chargers, other electrical equipment,
UPSs, VFDs, and current limiting reactors. For information about transformers, see Create a
Transformer (on page 102).
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Converting Equipment.
2. Right-click the folder for the desired item type for example, Battery Chargers and then
click New.
3. Accept the default item tag or type your own item tag for the item.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the item type. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. On the Converting Equipment Common Properties dialog box, edit the item properties as
required. Note that an asterisk beside a property name indicates required data.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new item.
The Converting Equipment Common Properties dialog box shows the most commonly
used properties. You access this dialog box by clicking the Common Properties command
on the shortcut menu or you can specify in the preferences to open the dialog box directly
when you create a new item.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Create a Transformer
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy
Electrical Equipment > Converting Equipment > Transformers.
2. Right-click the Transformers folder, and then click New 2-winding Transformer or New
3-winding Transformer.
3. Accept the default item tag or type your own item tag for the transformer.

102

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the transformer. For more details of naming convention settings, see Using Naming
Conventions (on page 65).

SmartPlant Electrical User's Guide

Creating and Modifying Equipment


4. On the Converting Equipment Common Properties dialog box, edit the transformer
properties as required. Note that an asterisk beside a property name indicates required data.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new
transformer.
The Converting Equipment Common Properties dialog box shows the most commonly
used properties. You access this dialog box by clicking the Common Properties command
on the shortcut menu or you can specify in the preferences to open the dialog box directly
when you create a new transformer.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
The secondary windings of a transformer are sub-items of the transformer. The properties of
the secondary windings appear separately in the Properties window. To view these
properties, expand the icon that represents the transformer
and select the icon
representing the desired secondary winding .
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Define Transformer Connections


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Converting
Equipment > Transformers.
2. Right-click a transformer primary winding, and on the shortcut menu, click Connections and
Tapping.
3. On the Transformer Connections and Tapping dialog box, click the tab for the winding
where you want to make the definitions: Primary, Secondary 1, or Secondary 2.
4. Specify the connection, for example, Wye, Delta, Star.
5. Specify the type of neutral grounding that you require.
The software does not validate the type of connection that you selected and allows you
to specify neutral grounding for all connection types.
6. Where the neutral grounding value is Solid Grounding or Impedance click the ellipsis button
beside Grounding cable to open the Find dialog box, where you can select a grounding
cable.
If necessary, define a new grounding cable, ensuring that you select the Use for neutral
grounding check box - only those grounding cables for which this check box is selected are
available for selection.
7. Where the neutral grounding value is Impedance click the ellipsis button
Grounding resistor.

beside

On the Find dialog box, the software retrieves all the existing resistors regardless of
whether they have or have not been associated with transformers. Make sure that you
select an appropriate resistor that has not been associated yet.
If necessary, define a new resistor.
8. Click Apply to accept the values.

SmartPlant Electrical User's Guide

103

Creating and Modifying Equipment


9. For a Secondary tab, enter values for the connection group, feeder winding, and phase shifts
as you require.

You must specify a separate grounding cable and resistor for each winding, if needed.
To enable the display of grounding cable and resistor data in an SLD, you must use a
transformer symbol that includes macros for these items. To do this, right-click on the
transformer, and on the shortcut menu click Associate custom symbols. On the Associate
Custom Symbols dialog box, under Document Type, select Single Line Diagrams, then
navigate to the symbol folder and select the appropriate file.

Define Transformer Tapping


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Converting
Equipment > Transformers.
2. Right-click a transformer primary winding and on the shortcut menu, click Connections and
Tapping.
3. On the Transformer Connections and Tapping dialog box, click the tab for the winding
where you want to make the definitions: Primary, Secondary 1, or Secondary 2.
4. Select Tapping required and enter values for the tapping, percentage per step, and number
of steps as you require.
5. Enter values for other transformer windings as you require by clicking the appropriate tabs.

Define Converting Equipment as Consumers


You can define converting equipment items as consumers. This allows you to include these items
in the calculations of load summaries, load associations, and when generating enhanced all
feeder load summary reports.
1. Select a converting equipment item in the Electrical Index or Electrical Engineer.
2. Do one of the following:
On the General tab of the Common Properties dialog box, select the Consumer check
box.
In the Properties window, set the Is Load property to True.
3. On the Common Properties dialog box, click the Electrical Data tab.
4. Enter appropriate values in the Electrical power group box.
When performing a drill-down calculation for a PDB that has a branch connected to a bus
through a converting equipment item, junction box, or local panel that is defined as a consumer,
the software takes into account the total of this branch using the electrical power values of this
converting equipment item.

104

SmartPlant Electrical User's Guide

SECTION 7

Power Distribution Equipment


SmartPlant Electrical provides for the creation and management of the following:
Power distribution boards (PDBs) and their child items, such as buses, circuits, and so on.
Disconnect electrical equipment:
Contactors
Overload relays
Disconnect switches
Circuit breakers
Fuses
Starters
Other disconnect equipment
Metering equipment
Freestanding buses
For information on the design of power distribution board structures, see Designing Power
Distribution Boards (on page 114).

In This Section
Power Distribution Boards and Buses ........................................... 105
Create Disconnect Electrical Equipment ....................................... 108
Metering Equipment ....................................................................... 110
Designing Power Distribution Boards ............................................ 114
Using Dual Source Power Supplies ............................................... 119
Using Transfer Switches ................................................................ 121
Working with Circuits ..................................................................... 122

Power Distribution Boards and Buses


This section deals with the creation and management of power distribution boards (PDBs) and
buses. You can do the following:
Create a Power Distribution Board (PDB) (on page 106)
Create a Bus (on page 106)
Create a Freestanding Bus (on page 107)
Delete a Power Distribution Board or a PDB Internal Item (on page 107)

SmartPlant Electrical User's Guide

105

Power Distribution Equipment

Create a Power Distribution Board (PDB)


This procedure explains how to create a power distribution board (PDB).
In the Reference Data Explorer, you can create PDBs with buses only.
1. In the Electrical Index or the Reference Data Explorer, expand the folder hierarchy
Electrical Equipment > Power Distribution Equipment.
2. Right-click the Power Distribution Board folder and click New.
3. Accept the default item tag or type your own item tag for the PDB.

In the Reference Data Explorer, you can type a string of up to 80 characters in length.
In the Electrical Index, the name must be in accordance with the naming convention for
the PDB. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. Design the PDB structure if you need to do it at this stage. For details, see Design a Power
Distribution Board Structure (on page 115).

You can also create a power distribution board by dragging a typical PDB from the Reference
Data Explorer to the Electrical Index.
You can customize the appearance of how the PDB appears on your SLD drawings. The
options available include line style, width, and color, position of SmartText and so forth. For
more details, see Creating Symbols in the Catalog Manager User's Guide, under Catalog
Manager, Working with Symbols, Creating Symbols.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Create a Bus
This procedure explains how to add a new bus to a power distribution board.
1. In the Electrical Index or the Reference Data Explorer, expand the folder hierarchy
Electrical Equipment > Power Distribution Equipment > Power Distribution Boards.
2. Click a PDB to expand its folder hierarchy.
3. Right-click the Buses folder and click New.
4. Accept the default item tag or type your own item tag for the bus.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the bus. For more details of naming convention settings, see Using Naming Conventions
(on page 65).
5. Edit the bus properties as required in the Properties window.
You can also create a dual bus. Create buses and then connect them using a bus tie. For
information about bus tie creation, see Associate Bus Riser Circuits with Coupler Circuits (on page
196).

106

SmartPlant Electrical User's Guide

Power Distribution Equipment

Create a Freestanding Bus


SmartPlant Electrical allows you to create freestanding buses that are not associated with power
distribution boards. You create these buses in the Freestanding Buses folder of the Electrical
Index. Freestanding buses can be parent items of circuits and circuit internals, but not cells.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Freestanding Buses.
2. Right-click the Freestanding Buses folder and click New Bus.
The software creates a new freestanding bus and names it automatically. In the
Electrical Engineer, freestanding buses appear at the top level.

Delete a Power Distribution Board or a PDB Internal Item


This procedure shows how to delete a power distribution board or any PDB internal item. The
topic also states the deletion preconditions and lists the other items that the software deletes with
the selected item.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards.
2. Select a PDB or one of its internal items.
3. Click Edit > Delete.
You can also delete a PDB or any PDB internal item by right-clicking an item and selecting
Delete on the shortcut menu.

You can delete only items that do not have associations to other items. For example, you
cannot delete a power distribution board associated with loads unless you first dissociate the
loads.
If you select more than one item for deletion, the software records any deletion failures in the
Batch Deletion log file. For the procedure for creating and viewing the log file, see Generate
Error Log Files (on page 34).

SmartPlant Electrical User's Guide

107

Power Distribution Equipment


Deletion Rules for PDBs and PDB Internal Items
The following rules apply when you delete a PDB or a PDB internal item in the Electrical Index:
PDB Item

Precondition

Power distribution
board

You have dissociated all


The software also deletes all the
the circuits in the PDB from internal buses, cells, circuits, and
external items, such as
circuit components.
cables, loads, and so forth.

Bus

You have dissociated all


The software also deletes all the
the bus circuits from
cells, circuits, and circuit
external items, such as
components.
cables, loads, and so forth.

Cell

You have dissociated all


The software also deletes all the
the circuits in the cell from circuits in the cell and the circuit
external items, such as
components.
cables, loads, and so forth.

Circuit

You have dissociated all


The software also deletes all the
the external items, such as circuit components.
cables, loads from the
circuit.

Circuit internal

Result

The software deletes the circuit


internal and clears any existing
association with a typical circuit.

Create Disconnect Electrical Equipment


You can create the following types of disconnect electrical equipment in your project:
Contactors
Overload relays
Disconnect switches
Circuit breakers
Fuses
Starters
Other disconnect equipment
Note that you can create auxiliary contacts under all disconnect equipment types
except for metering equipment.
1. In the Electrical Index or Reference Data Explorer, expand the folder hierarchy Electrical
Equipment > Power Distribution Equipment > Disconnect Electrical Equipment.
2. Expand the hierarchy of the folder for the desired item type.
3. Right-click the folder and then click New.

108

SmartPlant Electrical User's Guide

Power Distribution Equipment


4. Accept the default item tag or type your own item tag for the item.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the item type. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
5. On the Disconnect Electrical Equipment Common Properties dialog box, edit the item
properties as required. Note that an asterisk beside a property name indicates required data.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new item.
The Disconnect Electrical Equipment Common Properties dialog box shows the most
commonly used properties. You access this dialog box by clicking the Common Properties
command on the shortcut menu or you can specify in the preferences to open the dialog box
directly when you create a new item.
You can also edit the most commonly used properties and additional properties in the
Properties window or on the Tabular Editor.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Create an Auxiliary Contact


Auxiliary contacts are child items of disconnect electrical equipment.

You can create only one auxiliary contact under a given type of disconnect electrical
equipment.
You cannot create auxiliary contacts under metering equipment.
1. In the Electrical Index or Reference Data Explorer, expand the following hierarchy:
Power Distribution Equipment > Disconnect Electrical Equipment.
Also, you can create an auxiliary contact under any circuit in the Electrical Index.
However, the software does not allow you to create more than one auxiliary contact under a
specific circuit. That is, if you try to create an auxiliary contact under a circuit which already
has an auxiliary contact, the software displays a message informing you that this operation is
not allowed.
2. Expand the hierarchy further until you see the individual child items of disconnect electrical
equipment.
3. Right-click an appropriate child item of the desired disconnect electrical equipment (for
example, a contactor) and then click New.

In the Reference Data Explorer, you can type a string up to 80 characters long.
In the Electrical Index, the name must be in accordance with the naming convention for
the item type. For more details of naming convention settings, see Using Naming
Conventions (on page 65).
4. In the Properties window, enter the item properties as required.
On the Preferences dialog box, General tab, under Open after creating or duplicating
an item, you can specify whether to open the Item Tag dialog box when you create a new item.

SmartPlant Electrical User's Guide

109

Power Distribution Equipment

Metering Equipment
SmartPlant Electrical allows you to create equipment for measuring electrical parameters such as
voltages and currents. The software allows you to create voltmeters, ammeters, and
multimeters. For measuring large voltages and currents, you can also create measuring
transformers for these parameters. You create standard meters and measuring transformers in
the Reference Data Explorer as standalone items or as part of reference circuits.
In addition, you can create protection relays with various functions for protecting the circuit.
In the Electrical Index, you can locate metering equipment at any level under a PDB. You can
display metering equipment in single line diagrams.

Create Measuring Transformers


This procedure explains how to create current and potential transformers. These items are
'in-line' items which you can pace at specific points in a circuit to measure currents and voltages.
1. Do one of the following:
In the Reference Data Explorer, expand the hierarchy Power Distribution Equipment
> Disconnect Electrical Equipment > Metering Equipment.
In the Electrical Index, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders, and then select an item according to the following step.
2. Do one of the following:
Under the Electrical Equipment folder, navigate to a load, an item of converting
equipment, or another electrical item, and display the Metering Equipment folder for that
item.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a Metering Equipment folder under a power distribution board, a bus, a cell,
or a transfer switch.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a circuit.
3. Right-click the selected item, and then click one of the following:
New Current Transformer.
New Potential Transformer.
4. Select the new item that you have created, and in the Properties window, type a numeric
value for the Tag Sequence No property.
The Tag Sequence No property determines the positioning of the measuring
transformer on the SLD.
5. With the item selected, do one of the following:
Click Edit > Common Properties.
Right-click the item and on the shortcut menu, click Common Properties.
Press CTRL + F2.
6. On the Metering Equipment Common Properties dialog box, enter the desired values for
the item.

110

SmartPlant Electrical User's Guide

Power Distribution Equipment


If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

Create Meters
This procedure explains how to create ammeters, voltmeters, or multimeters. You can use these
meters to measure the outputs of measuring transformers.
1. Do one of the following:
In the Reference Data Explorer, expand the hierarchy Power Distribution Equipment
> Disconnect Electrical Equipment > Metering Equipment.
In the Electrical Index, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders, and then select an item according to the following step.
2. Do one of the following:
Under the Electrical Equipment folder, navigate to a load, an item of converting
equipment, or another electrical item, and display the Metering Equipment folder for that
item.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a Metering Equipment folder under a power distribution board, a bus, a cell,
or a transfer switch.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a circuit.
Right-click the selected item, and then click one of the following:
New Ammeter.
New Voltmeter.
New Multimeter.
3. Select the new item that you have created, and in the Properties window, type a numeric
value for the Tag Sequence No property.
The Tag Sequence No property determines the positioning of the meter on the SLD.
To display a meter on an SLD, you need to drag it to the SLD after generation.
4. With the item selected, do one of the following:
Click Edit > Common Properties.
Right-click the item and on the shortcut menu, click Common Properties.
Press CTRL + F2.
5. On the Metering Equipment Common Properties dialog box, enter the desired values for
the item.
6. For a multimeter, click the Ranges tab to specify the meter functions and desired range of
values for each function.
If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

111

Power Distribution Equipment

Create Relay Functions


You create relay functions in the Reference Data Explorer. Each relay function represents a
default action in response to a standard setting. After you add relay functions to protection relays
in the Electrical Index, you can modify the function parameters.
1. In the Reference Data Explorer, select the Electrical Equipment folder and select Relay
Functions.
2. Right-click the folder, and then click New Relay Function.
3. In the Properties window, enter values for the following relay function properties:
Relay Action.
Relay Function Code.
Relay Function Type.
Relay Percent Setting.
Relay Setting.
The software uses the values that you enter for the relay functions as defaults when you add
those relay functions to a protection relay. Any subsequent modifications you make to those
values in the protection relay do not change the default relay function values.
If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

Create Protection Relays


This procedure explains how to create protection relays. You can assign one or more functions to
a protection relay.
1. Do one of the following:
In the Reference Data Explorer, expand the hierarchy Power Distribution Equipment
> Disconnect Electrical Equipment > Metering Equipment.
In the Electrical Index, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders, and then select an item according to the following step.
2. Do one of the following:
Under the Electrical Equipment folder, navigate to a load, an item of converting
equipment, or another electrical item, and display the Metering Equipment folder for that
item.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a Metering Equipment folder under a power distribution board, a bus, a cell,
or a transfer switch.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a circuit.
Expand the hierarchy Power Distribution Equipment > Disconnect Electrical
Equipment > Protection Relays.

112

SmartPlant Electrical User's Guide

Power Distribution Equipment


3. Right-click the selected item, and then click New Protection Relay.
4. Select the new protection relay that you have created, and in the Properties window, type a
numeric value for the Tag Sequence No property.

5.

6.
7.
8.
9.

The Tag Sequence No property determines the positioning of the measuring transformer
on the SLD.
To display a protection relay on an SLD, you need to drag it to the SLD after generation.
With the protection relay selected, do one of the following:
Click Edit > Common Properties.
Right-click the protection relay and on the shortcut menu, click Common Properties.
Press CTRL + F2.
On the Metering Equipment Common Properties dialog box, enter appropriate values for
the protection relay.
Click the Functions tab to specify the relay functions that you want to include.
Click Add for each new function that you want to add to the relay and from the Find dialog
box, select the required relay function.
Modify the function properties if desired.
In Data Dictionary, you can add user-defined properties for your protection relay functions. For
details, see the Data Dictionary documentation.
Modifying the function properties does not affect the default values for that function.

If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

113

Power Distribution Equipment

Copy Metering Equipment


This procedure explains how to copy metering equipment by dragging default items from the
Reference Data Explorer to an appropriate target folder in the Electrical Index.
1. In the Reference Data Explorer, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Disconnect Electrical Equipment > Metering Equipment.
2. Select an item in one of the sub- folders.
3. In the Electrical Index, expand the folder hierarchy and display the Metering Equipment
folder for one of the following item types:
Loads
Converting equipment
Converting equipment components
Battery banks
Generators
Off-site power
PDBs
Buses
Cells
Circuits
Disconnect electrical equipment
Transfer switches
4. Drag the desired metering equipment item from the Reference Data Explorer to the
appropriate target folder.

Designing Power Distribution Boards


After creating a power distribution board (PDB) and the required cells, you have to design the
physical structure of the PDB and assign the cells to specific places in the PDB.
You design your PDBs in a PDB layout drawing which takes the form of a grid that represents the
physical structure of the current PDB. We recommend the following flow of activities when
designing your power distribution boards:
1. Create the physical structure of the PDB.
2. Create a PDB layout drawing and associate it with a particular PDB.
3. Create the required cells for the PDB and define their size. Note that you can automate the
cell size definition so that the size of the cells will be based on particular electrical properties of
the equipment associated with the cells.
4. Place the cells in the appropriate places in the drawing and thus assign the cells to specific
locations in the drawing grid.
5. Save the drawing.
Also, we recommend that you make a number of preliminary setting prior to the actual PDB
design. These settings are optional.
In Options Manager, you can define the following:
Define which characters you want to exclude from the PDB row names.
Define the location of the default PDB layout drawing template.
Define the location of the PDB layout symbols.

114

SmartPlant Electrical User's Guide

Power Distribution Equipment

Define the naming conventions for PDB and cells.


Define the item type symbology for cells, that is define a particular symbol for cells that have
specific properties such as width, height, etc.
In Catalog Manager, you can customize the symbols for PDBs and cells. This customization
allows you to show the cell properties in drawing in the manner that you need.
For information on how to carry out the specific tasks to make these preliminary settings, see the
appropriate topics in the documentation of each manager.

Design a Power Distribution Board Structure


This procedure explains how to design the physical structure of a power distribution board. This
is the first step in the PDB design and you have to perform this procedure before you open a PDB
layout drawing and associate it with the current PDB.
You design the PDB structure on the Power Distribution Board Structure dialog box. Since
PDB structure takes the form of a layout grid which is made up of grid units, you need to set the
required unit height and width.
Then, you define the number of vertical sections that the PDB will contain. You set the section
names and determine the section width (in grid units). The number of sections and their width will
determine the width of the PDB. Also, you can define the PDB as double-sided. This allows you
to set each section on the front or back of the PDB.
To determine the height of the PDB, you have to define the number of grid rows and set the row
names. Note that the height of each row is determined by the setting of the grid unit height. The
software allows you to determine the row naming type and exclude any unwanted characters from
the row names.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment.
2. Right-click the Power Distribution Board folder and click Design PDB Structure.
3. On the Power Distribution Board Structure dialog box, enter the values in the following
group boxes:
General definitions These settings allow you to define the height and width of the grid
units that make up the PDB layout drawing. The width of the vertical sections and the
height of the grid rows are measured in these units. Also, you can define the current PDB
as double- sided.
Section definitions These settings allow you to define the vertical sections of the
current PDB.
Grid rows These settings allow you to define the vertical structure of the current
PDB. That is, you define the number of rows that will make up the height of the current
PDB.

For more details about the values needed for PDB structures, see Power Distribution Board
Structure Dialog Box (on page 759).
If you need to change the physical structure of a PDB that is already associated with a PDB
layout, the software does not allow you to make any changes to those parts of the structure
that are assigned to cells. For example, if you want to delete a section or a row where you
have already placed a cell, you have to open the pertinent PDB layout drawing and remove the
cell. Only then can you reopen the Power Distribution Board Structure dialog box and
delete that section or row.

SmartPlant Electrical User's Guide

115

Power Distribution Equipment

Design a Power Distribution Board Layout


This procedure explains how to design a layout for a power distribution board. This design
consists of several stages and it is based on the physical structure that has been defined for the
selected PDB.
The first step in the design is to create a PDB layout drawing and associate it with the structure of
the current PDB. Next, you place the appropriate cells in the layout grid by dragging a cell to the
drawing.
Before you start this procedure, make sure that the physical structure of the current
PDB has been defined. For details on how to define a PDB physical structure, see Design a
Power Distribution Board Structure (on page 115).
1. In the Electrical Index, expand the folder hierarchy Documents > PDB Layout Drawings.
2. Right-click the PDB Layout Drawings folder and then on the shortcut menu click New PDB
Layout Drawing.
3. Right-click the new drawing and then on the shortcut menu click Document Properties.
4. Document Properties dialog box, select an appropriate template and set the scale factor,
which determines how the PDB is actually displayed in the drawing.
5. Right-click the drawing name in the Electrical Index and then on the shortcut menu click
Open.
6. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards and select an appropriate PDB.
7. Drag the PDB from the Electrical Index to the open drawing.
Once you drag the PDB to the drawing, the software draws the PDB structure based on
the definitions you entered on the Power Distribution Board Structure dialog box. Also,
the software associates the drawing with the current PDB. The software allows only one
drawing to be associated with a PDB.
8. In the Electrical Index, expand the hierarchy of the current PDB to display the existing cells.
Now you are ready to start placing the cells in the PDB layout. Prior to doing that, make
sure that the size of all the cells has been defined. The cell size can be automated or defined
manually. For more information, see Create a Cell (on page 118).
9. Drag each cell from the Electrical Index to the appropriate place in the layout grid.
The software places the cell in the drawing and associates the cell with its location in the
drawing grid.

116

The software represents the cells using a default symbol and a macro that specifies the
cell name.
You can customize your own PDB and cell symbols or use the default symbols provided
by the software.
The software determines the symbol size automatically based on the cell size.
You can specify the cell names based on the physical location of the cells within the
PDB. The cells inherit and store in their properties all the spatial coordinates related to
their locations. You can use these coordinates when defining the cell naming
conventions.
When placing a cell in the drawing grid, the origin point of the placed symbol is always the
upper left corner of the upper grid row taken by the symbol.

SmartPlant Electrical User's Guide

Power Distribution Equipment

Make sure that you synchronize the size of your cell symbols with the size of the
cells. When creating cell symbols, the symbol size has to be defined according to the
original physical size of the cell. The software scales the macro fonts and x and y
coordinates according to the scale factor defined on the Document Properties dialog
box. This way you will avoid a situation in which the software places the macro
incorrectly or the macro size exceeds the size of the cell units.
10. Save the drawing.

A PDB can have only one structure and be associated only with one PDB layout drawing.
Once you placed a cell in the grid, moving a cell to another place in the drawing grid is possible
if that part of the grid is vacant, that is there are no other cells assigned to that part of the
grid. To move a cell, click Edit > Move Cell and then drag the cell to another place in the grid.
To remove a cell from the layout drawing, select a cell in the layout drawing and then click Edit
> Remove Cell. Removing a cell from a PDB layout drawing does not delete the cell from
your plant. Once you remove a cell from a PDB layout, the software dissociates the cell from
the drawing and the place that used to occupy in the grid becomes available for other cells. If
no other cells exist, you can delete the vacant rows from the PDB structure. For details, see
Design a Power Distribution Board Structure (on page 115).
Save the PDB layout drawing in the file format that you require.
Deleting a PDB layout drawing, does not dissociate the PDB from its layout. Furthermore, the
software still retains the association of the cells with their locations in the PDB layout. The
PDB layout drawing serves only as a means to show the PDB layout in a graphical
way. Therefore, if you want to redesign the structure of a PDB, open the associated PDB
layout drawing and remove all the cells.
You can open an existing PDB layout drawing for a specific power distribution board by
right-clicking a PDB in the Electrical Index and then clicking Associated Drawings.
The scale of PDB layout drawings is limited to 1:100.

Open a PDB Layout Design for a Selected PDB


Follow this procedure when opening a PDB layout design for a particular PDB.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards.
2. Right-click the required PDB and click Open PDB Layout.

SmartPlant Electrical User's Guide

117

Power Distribution Equipment

Create a Cell
This procedure shows how to create a cell and manually define its size. Note that you must
define the cell size prior to assigning it to a specific location in a PDB layout.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
2. Right-click a bus and click New Cell.
3. Accept the default item tag that is based on the naming convention for the cell, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. Edit the other cell properties in the Properties window as required.

118

It is essential that you define the cell size. This definition is required for PDB layout
design. You can define the cell size manually or perform a procedure that will automate the
cells sizing every time you create a cell. To define the cell size manually, in the Properties
window, under Identification, type an appropriate value for Cell Height in Units and Cell
Width in Units. Alternatively, you can type a Space Factor. The Cell Height in Units value
equals double of the Space Factor value. The Space Factor value that you can type can
only be incremented by 0.5, for example 0.5, 1, 1.5, 2, 2,5, and so forth.
For information on how to perform the procedure that automates cell size definition, see
Automate Cell Size Definition (on page 119).
Now you can place this cell in a PDB layout drawing by dragging it from the Electrical Index to
an appropriate place in the layout grid. For details, see Design a PDB Layout (see "Design a
Power Distribution Board Layout" on page 116).
We recommend that you redefine the cell naming conventions and use the available spatial
properties of cells so that you can fully take advantage of the PDB layout functionality. Also
note that the Row Name and Section Name cell properties are no longer in use.

SmartPlant Electrical User's Guide

Power Distribution Equipment

Automate Cell Size Definition


This procedure explains how to automate the definition of cell sizes. Defining a cell size is
essential for PDB layout design. Automating your cell size definition is very useful if you want cell
size values to be based on particular electrical properties of the equipment associated with the
cells.
1. In the Reference Data Explorer, create a lookup table that sets a relation between load data
(rated power, voltage, and so on) and cell size values (cell height and cell width). For
information on how to create a lookup table, see Create Lookup Tables (on page 56).
2. In Rule Manager, define a set of rules that will instruct the software to copy the load data to the
cell properties that they are assigned to. As a result, whenever a load-cell relationship is
created, the software will copy the load property values to the cell. For information on how to
define rules, see the Rule Properties topic in the Rule Manager documentation.
3. Apply the cell lookup tables to the appropriate cells in your plant. This will automatically set
the cell size according to their definitions in the lookup tables. For details on how to apply
lookup tables, see Apply Lookup Table Data to Equipment (on page 126).
You can define a number of different rules and lookup tables for various cell sizes and load
data values.

Using Dual Source Power Supplies


SmartPlant Electrical allows you to specify two power sources for equipment: a primary source
and an alternative source. Examples of dual source power supplies include:
A motor fed by supplies on two separate buses.
A variable-frequency drive fed by the two secondaries of a 3-winding transformer.
An uninterruptible power supply fed by a main input with battery back-up.
To set up a dual power supply, you first create each of the feeder branches and associate the
main supply with the item. Next, you specify the second feeder branch as the alternative power
supply. The software can display dual power supplies in single line diagrams.

Loads that are connected to circuits for which the circuit mode value is Disconnected appear
in bus load summaries, but the software does not take those loads into account in the total
load calculation.
If a load is connected to a dual power source that originates from the same feeding upstream
bus, the software does not count such a load twice and accounts for it correctly in load
summaries and other load calculations.
For batch load association calculations, a load connected to a circuit in Disconnected mode
is only displayed in the Associated loads data window of the Bus Load Association dialog
box. Such a load does not appear in the Calculation results group box. There is no need to
set the circuit mode as Connected or Disconnected for loads that have an alternative power
source. The software automatically sets the circuit mode of these loads to Disconnected.

SmartPlant Electrical User's Guide

119

Power Distribution Equipment

Associate a Dual Power Supply with an Equipment Item


1. In the Electrical Index, create the load to which you want to associate the power supplies.
2. Create two power cables to associate with the item.
3. Create two feeder branches: one for each supply, for example a generator and an off-site
power supply, each attached to a bus.
4. In the Electrical Engineer, associate the load with the main supply. For details, see
Associate Electrical Equipment with Feeders (on page 194).
5. Select the load and right-click.
6. On the shortcut menu, click Select Alternative Power Source.
7. On the dialog box that opens, navigate to the item that you want to designate as the
alternative supply.
If the item is not visible in the window, select a branch and click Expand. Alternatively,
click Find to locate the item using the Find dialog box.
8. Click OK to select the item as the alternative power supply.
The OK button is only enabled when you select an item that is valid for use as an
alternative power supply.
9. To view the load power supplies, select the load, and on the shortcut menu, click Common
Properties.
10. On the Common Properties dialog box for the load, click the Feeder Data tab to view details
of the main power supply and click the Alternative Feeder Data tab to view the name of the
feeder equipment used as the secondary power supply.

In the Electrical Engineer, the software places a visual indication '(#)' beside the names of
the load and the feeder cable where they appear in the alternative power supply branch.
You can change the alternative power source by right-clicking the feeder cable in the
alternative power supply branch and clicking Select Alternative Power Source.
If the load is only connected to an alternative power source, any drag-and-drop operations that
you perform in the Electrical Engineer affect the primary power source only.

Change an Alternative Power Supply of an Equipment Item


1. In the Electrical Engineer, select the load for which you want to change the alternative
supply.
You can only change the alternative supply if you select the item at the lowest level of the
branch.
2. Right-click the load.
3. On the shortcut menu, click Change Alternative Power Source.
4. On the dialog box that opens, navigate to the item that you want to designate as the
alternative supply.
If the item is not visible in the window, select a branch and click Expand. Alternatively,
click Find to locate the item using the Find dialog box.
5. Click OK to select the item as the alternative power supply.

120

SmartPlant Electrical User's Guide

Power Distribution Equipment

Dissociate an Alternative Power Supply from an Equipment


Item
1. In the Electrical Engineer, select the load for which you want to dissociate the alternative
supply.
You can only dissociate the alternative supply if you select the item at the lowest level of
the branch.
2. Click Actions > Dissociate.

Using Transfer Switches


Transfer switches are two-way manual or automatic switches that are used to switch or transfer an
essential load from the main power source to a backup power source.
In the Electrical Engineer, the software displays a transfer switch as a normal bus with two
incomers. You drag each incomer separately to its parent power source. The software shows
the two paths separately, with the items downstream of the transfer switch repeated on each
path. The software can display transfer switches and their electrical paths in single line diagrams.

You cannot select transfer switches as designated PDBs on the Feeder tabs of the Common
Properties dialog boxes for loads, converting equipment, and so forth.
The software includes the name of a transfer switch on the Feeder tab for a connected load as
part of the feeder path.
After you create a transfer switch, you can add cells and circuit internals to it.

Create a Transfer Switch


1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Transfer Switches folder.
2. Right-click the Transfer Switches folder, and on the shortcut menu, click New Transfer
Switch.
The software creates a PDB, a bus, two incomers, and a feeder. The Equipment Type
property for the PDB is set as Transfer Switch.
3. Select one of the incomers.
4. Right-click the incomer and on the shortcut menu, click Common Properties.
5. On the Circuit Common Properties dialog box, select a value for the Circuit Mode property:
Connected or Disconnected.
When you select a circuit mode value Connected for a transfer switch incomer, the
value for the second incomer circuit mode automatically changes to Disconnected. You can
set both incomers to be disconnected, or one only.
6. Specify values for other incomer properties as you require.
7. Close the dialog box and in the Electrical Engineer, connect items to the feeder and incomer
branches as you require.
If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

SmartPlant Electrical User's Guide

121

Power Distribution Equipment

Generate an SLD for a Transfer Switch


1. In the Electrical Engineer, while holding down the CTRL key, select the top level items in
both of the branches associated with the transfer switch.
2. Right-click one of the selected items and on the shortcut menu, click New SLD.

Working with Circuits


This section deal with the creation and management of circuits. The following tasks are used
frequently when you add feeder circuits to buses on power distribution boards (PDBs). Usually,
you define your circuits and then assign them to loads. You can do the following:
Create a Circuit (on page 122)
Copy Circuit Components (on page 123)
Apply Typical Circuit Data to a Project Circuit (on page 123)
Create Circuit Components (on page 124)
Change the Location of a Circuit on a Bus (on page 124)

Create a Circuit
This procedure shows how to create a new circuit in the Electrical Index.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
You can also create a circuit by dragging a typical circuit from the Reference Data
Explorer to the Electrical Index.
2. Right-click a bus and on the shortcut menu, select one of the following:
New Feeder Circuit
New Incomer Circuit
New Coupler Circuit
New Bus Riser Circuit
3. Accept the default item tag that is based on the naming convention for the circuit, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. Edit the circuit properties as required on the Circuit Common Properties dialog box.

122

You can associate the internal components of a circuit with relevant lookup tables that contain
appropriate data. On the Circuit Common Properties dialog box, click the Associate Items
tab. Then, in the Circuit internals data window, under Lookup Table, click and select the
lookup table that you require. You will then be able to apply this associated lookup table to a
project circuit when you run the Apply Lookup Tables feature on the Apply Options dialog
box to propagate the lookup table data to the circuit internal components.
You cannot change the circuit function in the Properties window. If you need to change the
function of an existing circuit, create a new one then delete the circuit for which the function is
not appropriate.
You cannot add a circuit that has a function type that does not match the circuit function of the
existing circuits belonging to the same bus or cell.

SmartPlant Electrical User's Guide

Power Distribution Equipment

Copy Circuit Components


This procedure shows how to copy circuit components, such as protection devices, disconnect
devices, electrical distribution equipment, and so forth, from the Reference Data Explorer.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
2. Double-click a bus to expand its folder hierarchy.
3. Select the desired circuit.
4. In the Reference Data Explorer, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Disconnect Electrical Equipment.
5. Select the appropriate sub-folder and drag the desired item to the circuit in the Electrical
Index.

If the circuit was previously populated with typical circuit data, the software clears the
reference to the typical circuit.
If the circuit is already associated with a load, the software clears the reference to the typical
circuit.

Apply Typical Circuit Data to a Project Circuit


This procedure shows how to apply circuit components using a typical circuit from the Reference
Data Explorer to an existing project circuit This method is recommended for bulk replacement
of circuits with internal components.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
2. Expand the Buses folder and in the lower pane, select one or more circuits to which you want
to assign the typical circuit.

3.
4.
5.
6.
7.
8.
9.
10.
11.

12.

13.

You can assign a typical circuit to a bus, in which case the software adds to the bus a
new circuit containing components that are derived from the typical circuit.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Typical Circuit tab.
Select Enable typical circuit.
Beside the Typical circuit box, click Find.
On the Find dialog box, click Find Now to display the available typical circuits that match the
type of circuit you have selected to assign the data to, such as feeder or incomer.
From the list of typical circuits, highlight the typical circuit that you want to assign.
Click OK.
If you apply a typical circuit to more than one circuit in the Electrical Index, the software
applies the typical circuit only to those circuits of the same type as the typical circuit.
If you apply a typical circuit to a circuit that already has associated components, the software
prompts you as to whether you want to replace the existing components with components
belonging to the typical circuit.
If you apply a typical circuit that includes associated reference cables, the software creates
project cables from them and adds the project cables to the circuit with the To sides of the
cables associated with the circuit.
You cannot assign a typical circuit to a circuit that is already associated with a load.

SmartPlant Electrical User's Guide

123

Power Distribution Equipment

Create Circuit Components


This procedure shows how to add individual circuit components, such as protection devices,
disconnect devices, electrical distribution equipment, and so forth, to a circuit.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
2. Double-click a bus to expand its folder hierarchy.
3. Right-click the desired circuit and on the shortcut menu, click an option to create new
disconnect, protection, converting or control equipment.
As an alternative method, you can create a circuit component by dragging from the
Reference Data Explorer an item under Disconnect Electrical Equipment. For more
information, see Copy Circuit Components (on page 123).
4. Accept the default item tag that is based on the naming convention for the component, or type
your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
5. Edit the component properties as required in the Properties window.
You cannot change the electrical equipment class and sub-class values in the Properties
window. If you need to change these values, create a new component and then delete the
component that is not needed.

Change the Location of a Circuit on a Bus


This procedure shows how to move a circuit between cells on a bus or between a cell on a bus and
the bus itself.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Power
Distribution Equipment > Power Distribution Boards > Buses.
2. Expand the desired bus and locate the circuit you want to move.
3. Do one of the following:
Drag a circuit on a bus to a cell under the bus.
Drag a circuit in a cell to the bus on which the cell is located.

124

The circuit function type must match the function type of the bus or cell. For example:
incomer or feeder.
You can relocate a circuit within a specific bus only; you cannot move a circuit to a different
bus.

SmartPlant Electrical User's Guide

SECTION 8

Populating Items with Data


This section describes how to create items and populate them with data in a batch operation, thus
keeping to a minimum the editing that you need to perform for individual items. You can perform
batch item creation using the following methods:

Apply a Typical Item to a Project Item


Typical items in the Reference Data Explorer enable you to create project items based on the
selected typical items. The software simply clones the typical item in the Electrical Index after
dragging a typical item to an appropriate folder in the Electrical Index. For more information, see
Copy a Reference Item to the Electrical Index (see "Create a Project Item Based on a Reference
Item" on page 77).

Apply Options Using Typical Items


You can use the Apply Options feature to create and associate project items with electrical
equipment in the Electrical Index where the associated items are based on typical items defined
in the Reference Data Explorer. This option is very useful for populating data in batch
mode. For example, you can select a number of motors in the Electrical Index and associate
them with a control station, a typical circuit, or both. You can also associate these motors with a
typical schematic. For more information, see Apply Options to a Set of Tags (on page 126).

Apply a Profile to an Electrical Item


You can define specific profiles for various item types. A profile is an assembly of various typical
items that you can use as a template for creating project items. For example, you can create a
motor profile that consists of the following reference items: a motor, one or more cables, a control
station, a circuit with protection devices, and schematic. Applying a profile to an electrical item in
the Electrical Index enables you to specify various properties for that item as they were defined in
that profile. This way you can create an electrical item with all its related equipment and with all
the properties as you require. For more information, see Apply a Profile to an Item (on page 130).

Apply a Lookup Table to an Electrical Item


Lookup tables are data tables used to populate project items singly or in batch with data values
based on one or more key fields. Where the key fields exactly match the data for a particular
item, the software copies the data from the matching row in the lookup table to the project
item. For example, you can select a number of motors in the Electrical Index and apply a
selected lookup table for a motor with a particular motor rated power and rated voltage. The
software will then populate the properties of the selected tables with appropriate values. For more
information, see Apply Lookup Table Data to Equipment (on page 126).

SmartPlant Electrical User's Guide

125

Populating Items with Data

Apply Options to a Set of Tags


You can use the Apply Options feature to create and associate project items with electrical
equipment in the Electrical Index where the associated items are based on typical items defined
in the Reference Data Explorer. This option is very useful for populating data in batch
mode. For example, you can select a number of motors in the Electrical Index and associate
them with a control station, a typical circuit, or both. You can also associate these motors with a
typical schematic.
1. Do one of the following:
In the Electrical Index, select a set of tags. For more information, see Select a Set of
Tags (see "Select a Set of Item Tags in the Electrical Index" on page 69).
Select multiple tags in the Tabular Editor.
2. Click Tools > Apply Options.
3. On the Apply Options dialog box, select the values that you require on the appropriate tabs.
4. After you have selected the values on a tab, click Apply.

Apply Lookup Table Data to Equipment


Lookup tables are data tables used to populate project items singly or in batch with data values
based on one or more key fields. Where the key fields exactly match the data for a particular
item, the software copies the data from the matching row in the lookup table to the project
item. For example, you can select a number of motors in the Electrical Index and apply a
selected lookup table for a motor with a particular motor rated power and rated voltage. The
software will then populate the properties of the selected tables with appropriate values.
You can apply data from a lookup table to any type of equipment for which you have created a
lookup table. Each lookup table is specific for an item type, such as transformers, and by
selecting a key value for a lookup table, the software automatically populates the item with other
properties that you defined in the lookup table.

When you apply data using a lookup table, the software can overwrite existing data. Since
this process is not reversible, you should proceed with great care.
It is good practice not to include calculated properties in lookup tables. For example, if the
Supply AC/DC Flag property for a motor is set to DC, and you try to select a value for the
Frequency property, you cannot apply this value and the software rejects the operation. You
must first set Supply AC/DC Flag to AC, and only then you can apply the lookup table value
for the Frequency property to the motor.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Navigate to the folder for the desired equipment type and do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.
You can also select more than one item by selecting a subset of item tags in the Tabular
Editor.
3. Click Tools > Apply Options.
4. On the Apply Options dialog box, click the Lookup Table tab.

126

SmartPlant Electrical User's Guide

Populating Items with Data


5. Select Enable lookup table.
The default lookup table for the equipment type appears in the Lookup table box. You
can select a different profile by performing the following steps.
6. Beside the Lookup table box, click Find.
7. On the Find dialog box, click Find Now to display the available lookup tables.
8. From the list of lookup tables, highlight the lookup table that you want to apply.
For each item property, the software overwrites existing values if the value of the
Overwrite Option property in the lookup table is set to True. It is recommended that you
view the lookup table before applying the data to verify which properties the software
overwrites.
9. Click OK.

Apply a Typical Circuit to an Item


Applying a typical circuit to an electrical item in your project allows you to create a new circuit with
predefined properties. The software automatically associates the new circuit with the selected
project item. You can apply a typical circuit to all loads, all converting equipment items, and
circuits.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Navigate to the folder for the equipment type that you require and do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.

3.
4.
5.
6.
7.
8.
9.
10.

You can apply a typical circuit to all loads, all converting equipment items, and circuits.
You can also select more than one item by selecting a subset of item tags in the Tabular
Editor.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Typical Circuit tab.
Select Enable typical circuit.
Beside the Typical circuit box, click Find.
On the Find dialog box, click Find Now to display the available typical circuits.
From the list of typical circuits, highlight the typical circuit that you want to assign to the
equipment.
Click OK.
Under Apply to, select one of the following options according to the rule the software uses to
apply the typical circuit:
All items - Applies the typical circuit to all the selected items.
Items with no typical circuit - Applies the typical circuit only to items without an existing
typical circuit. Use this option to add a typical circuit only to new items among the items
that you selected.
Items with a different typical circuit from the selection - Changes the typical circuit of
the selected items to the current typical circuit. Use this option to add a typical circuit to
items with a modified typical circuit definition.
Items with the same typical circuit as the selection - Updates an existing typical circuit
for the selected items.

SmartPlant Electrical User's Guide

127

Populating Items with Data


11. Click Apply.

If you apply a typical circuit to an item that is already associated with a circuit, the software
adjusts the components of the circuit to match the typical circuit specified by the item.
If you apply a typical circuit that includes associated cables to a circuit, the software creates
cables in the project and associates their 'To' sides with the circuit.
If you modify the components of a typical circuit that already has a reference from an item, the
software does not update the change in the reference until you next apply a typical circuit or a
profile to the item.
If the item that you are applying the typical circuit to is connected to a feeder circuit, the system
replaces the circuit so that it matches the applied typical circuit as specified in the profile.
If the item is connected to feeder equipment other than a circuit (such as a variable frequency
drive, a transformer, or a battery bank), the software does not apply the typical circuit.
If more than one item is connected to the same circuit, the software changes the last applied
typical circuit for all the items.
You can clear the typical circuit of an item that is not connected to any circuit by selecting
Clear the last applied typical circuit.
You can apply a typical circuit on a circuit, provided that the circuit has no equipment
connected to it.

Apply a Typical Control Station to an Item


Applying a typical control station to a project item allows you to create a predefined control station
and associate it with a selected project item. The software allows you to apply a typical control
station to all loads, all converting equipment items, disconnect equipment, generators, and battery
banks.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Navigate to the folder for the desired equipment type and do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.

3.
4.
5.
6.
7.
8.
9.
10.

You can also select more than one item by selecting a subset of item tags in the Tabular
Editor.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Control Station tab.
Select Enable control station.
Click Add.
On the Find dialog box, click Find Now to display the available control stations.
From the list of control stations, while holding CTRL, highlight each control station that you
want to associate with the item.
Click OK.
Under Apply to, click All items.

If required, you can click Items with no control station to add control stations only to
items that do not have any existing control stations.
11. Under Action, click Add or Replace to determine how the software deals with control stations
that have the same name as existing control stations. This option applies only if you click All
items.

128

SmartPlant Electrical User's Guide

Populating Items with Data


12. Click Apply.

You can apply a typical control station to a load, converting equipment item, disconnect
electrical equipment item, a generator, and a battery bank.
You can view the control stations associated with an item of electrical equipment by selecting
Common Properties on the shortcut menu for the item, and on the dialog box that opens,
selecting the Controls & Signals tab.
If you select a reference control station that has one or more associated control cables, the
software creates these cables in the control station that you add to the project item.
If you apply control stations to one or more items that are connected to circuits, the software
associates the control station cables (instrumentation and control) with the circuits
automatically when you select the appropriate Options Manager setting. If you do not use the
setting, you need to make the association manually. For details, see Associate Control
Station Cables with Equipment Circuits (see "Associate Cables of Control Stations with
Equipment Circuits" on page 197).
If you modify the components of a reference control station that already has a reference from
an item, the software does not update the change in the reference until you next apply a profile
to the item.

Apply a Typical Schematic to an Item


Applying a typical schematic to a plant electrical item allows you to add a definition of a schematic
to the selected project item. You can then generate a schematic without the need to define the
schematic drawing properties, such as schematic blocks, templates, and so forth.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads by
clicking the + icons or by double-clicking the folders.
2. Select the Motors, Static Electrical Equipment, or Other Electrical Equipment folder and
do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.
3. Click Tools > Apply Options.
4. On the Apply Options dialog box, click the Typical Schematic tab.
5. Select Enable typical schematic.
6. Beside the Typical schematic box, click Find.
7. On the Find dialog box, click Find Now to display the available typical schematics.
8. From the list of typical schematics, highlight the typical schematic that you want to assign to
the item.
9. Click OK.
10. Under Apply to, select one of the following options according to the rule the software uses to
apply the typical schematic:
All items - Applies the typical schematic to all the selected items.
Items with no typical schematic - Applies the typical schematic only to items without an
existing typical schematic. Use this option to add a typical schematic only to new items
among the items that you selected.
Items with a different typical schematic from the selection - Changes the typical
schematic of the selected items to the current typical schematic. Use this option to add a
typical schematic to items with a modified typical schematic definition.

SmartPlant Electrical User's Guide

129

Populating Items with Data


11. Click Apply.

If you modify the components of a typical schematic that already has a reference from an item,
the software does not update the change in the reference until you next apply a typical
schematic or a profile to the item.
You can assign a new typical schematic or change an assigned typical schematic for an item
at any time.

Apply a Profile to an Item


A profile is an assembly of various typical items that you can use as a template for creating project
items.
You can apply a profile to any item or group of items, and the software creates and associates all
the referenced items in the Electrical Index with the default data. In this way, you can quickly
define common properties for a group of items of the same type, and you can associate the same
type of typical circuit, control stations, cables, and typical schematic with each item in the group.
When you apply a profile to an item, the software can overwrite existing data. Since
this process is not reversible, you should proceed with great care.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by
double-clicking the folders.
2. Navigate to the folder for the desired equipment type and do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.
You can also select more than one item by selecting a subset of item tags in the Tabular
Editor.
3. Click Tools > Apply Options.
4. On the Apply Options dialog box, click the Equipment Profile tab.
5. Select Enable equipment profile.

6.
7.
8.
9.
10.

130

The default profile appears in the Create item based on profile box. You can select a
different profile by performing the following steps.
Beside Create item based on profile, click Find.
On the Find dialog box, click Find Now to display the available profiles.
From the list of profiles, highlight the profile that you want to apply.
Click OK.
Under Apply to, select one of the following options according to the rule the software uses to
apply the profile:
All items Applies the profile to all the selected items.
Items with no profile Applies the profile only to items without an existing profile. Use
this option to add a profile only to new items among the items that you selected.
Items with a different profile from the selection Changes the profile of the selected
items to the current profile. Use this option to add a profile to items with a modified profile
definition.
Items with the same profile as the selection Updates an existing profile for the
selected items.

SmartPlant Electrical User's Guide

Populating Items with Data


11. Select the Populate empty item properties check box to update only those item properties
that contain null data. When you select this option, the software does not overwrite the data
that is not null.
Clear the check box to leave existing values of the item properties as they are, regardless of
whether they contain null or not null values.
12. Click Apply.

Applying a profile is a useful way of creating new items and populating large amounts of data
in your project. When you apply the profile, the software automatically applies any definitions
for typical circuits, control stations, typical I/O sets, and lookup tables that you define on the
other tabs of the Apply Options dialog box.
After you apply a profile for which the software creates new items and relations successfully,
the operation may still partially fail, for example if certain values of updated data conflict with a
rule. In such cases, the software displays an error message and records the problem in the
log file.
When you apply a profile, the software replaces all formerly associated items with the items
specified in the current profile including any values that you have modified. The software
assigns new item tags according to the naming convention.
If you apply a profile that contains a reference item to one or more project items, the software
populates the properties of those project items with values copied from the reference item.
If you modify the components of a typical circuit that already has a reference from an item, the
software does not update the change in the reference until you next apply a typical circuit or a
profile to the item.
When an item has associated cables, and you connect the item to a circuit by applying a
profile with a typical circuit, if there is more than one cable, the software associates the free
ends of all the cables to the circuit.
If you apply a profile for a reference motor with a heater to a project motor without a heater, the
software adds a heater to the project motor.
If you apply a profile for a transformer, the software applies the profile only if the reference and
project transformers have the same number of windings and where the Number of
Secondaries property for the project transformer has a value of 1 or 2. If no value appears
for this property, you must type one manually in accordance with the number of secondary
windings in the transformer.
If the item that you are applying a profile to is connected to a feeder circuit, the system
replaces the circuit so that it matches the applied typical circuit as specified in the profile.
If the item is connected to feeder equipment other than a circuit (such as a variable frequency
drive, a transformer, or a battery bank), the software does not apply the profile.
Now you can do one of the following:
To continue with the next step in the recommended workflow for generating a schematic
drawing, see Generate a Schematic (on page 273) or Generate a Multi-Item Schematic (on
page 274).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

131

Populating Items with Data

Apply a Set of Signals to an Item


Applying a typical I/O set to a project control station or a circuit creates predefined I/O signals and
associates them with a selected item. You can then publish the signal data to SmartPlant
Instrumentation.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Navigate to the folder for the desired equipment type and do one of the following:
Expand the folder and select an item from the list.
Click the folder, and in the list view pane, hold CTRL while you select more than one item.

3.
4.
5.
6.
7.
8.
9.
10.

11.

132

You can also select more than one item by selecting a subset of item tags in the Tabular
Editor.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Typical I/O Sets tab.
Select Enable typical I/O sets.
Beside the Typical I/O sets box, click Find.
On the Find dialog box, click Find Now to display the available set of signals.
From the list of signal sets, highlight the set of signals that you want to assign to the item.
Click OK.
Under Apply to, select one of the following options according to the rule the software uses to
apply the set of signals:
All items - Applies the set of signals to all the selected items.
Items with no typical I/O sets - Applies the set of signals only to items without an
existing set of signals. Use this option to add a set of signals only to new items among
the items that you selected.
Items with a different typical I/O set from the selection - Changes the set of signals of
the selected items to the current set of signals. Use this option to add a set of signals to
items with a modified typical I/O set definition.
Click Apply.
If you modify the components of a set of signals that already has a reference from an item, the
software does not update the change in the reference until you next apply a set of signals or a
profile to the item.
You can assign a new set of signals or change an assigned set of signals for an item at any
time.

SmartPlant Electrical User's Guide

Populating Items with Data

Apply a Typical Cable Block Diagram to an Electrical


Item
This feature allows you to apply a typical cable block diagram to plant loads. You can apply a
selected typical CBD to a single load or to several loads that you select in the Electrical Index. As
a result of this operation, the software will do the following for each plant load based on the
reference items that are contained in the selected typical CBD:
Create all the plant equipment based on the reference items contained in the typical CBD.
Make all the associations among the new plant equipment as defined in the typical CBD.
Create a plant cable block diagram in which the selected plant load serves as a focal item. The
name of the new CBD will be the same as the name of the plant load to which you apply the
selected typical CBD.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads by
clicking the + icons or by double-clicking the folders.
2. Expand the Motors, Static Electrical Equipment, or Other Electrical Equipment folder.
3. Select one or more loads.

4.
5.
6.
7.
8.
9.

10.
11.

12.

To select several loads, click the folder, and then in the list view pane, hold CTRL while
you select more than one item.
Click Tools > Apply Options.
On the Apply Options dialog box, click the Typical CBD tab.
Select Enable typical CBD.
Beside the Typical cable block diagram box, click Find.
On the Find dialog box, click Find Now to display the available typical cable block diagrams.
From the list of the available typical cable block diagrams, select an appropriate typical cable
block diagram that you want to apply to the electrical loads that you selected in the Electrical
Index.
Click OK to return to the Typical CBD tab of the Apply Options dialog box.
Select the Populate empty item properties check box to update only those item properties
that contain null data. When you select this option, the software does not overwrite the data
that is not null.
Clear the check box to leave existing values of the item properties as they are, regardless of
whether they contain null or not null values.
Click OK.

The software does not apply a typical CBD to plant loads in the following cases and
logs the rejection reason in the Apply Typical CBD log file:
If the typical CBD does not contain any typical item that belongs to the same item type as the
electrical item to which you are applying the typical CBD.
If the typical CBD contains more than one typical item that belongs to the same item type as
the electrical item to which you are applying the typical CBD.
If the electrical item is not associated with a bus but the selected typical CBD contains a
reference bus circuit.
If the selected electrical item is already associated with other plant items.

SmartPlant Electrical User's Guide

133

Populating Items with Data

When applying a typical CBD to motors with space heaters:


The software deletes the space heater from the plant and applies the typical CBD to the motor.
If the typical CBD contains a reference motor with a space heater, the software creates a new
plant space heater under the plant motor after applying the typical CBD.
If the plant space heater is associated with other items (for example, cables, control stations,
signals, terminal strips, and so on), the software does not apply the selected typical CBD to the
motor of the space heater and logs the rejection reason in the Apply Typical CBD log file.
When applying a typical CBD to loads that are associated with buses:
After applying a typical CBD, the software validates that the association has been retained.
If the association has been broken, the software searches for the root item in the electrical
branch where the load is connected. If the root item is not a circuit, the software attempts to
associate the root item with the bus in that electrical branch.
If the association of the root item with a bus is not possible, the software does not stop or
cancel the process of applying the selected typical CBD.

Apply a Typical Schematic to an Instrument


Applying a typical schematic to an instrument allows you to add a definition of a schematic to the
selected instrument. You can then generate a schematic without the need to define the
schematic drawing properties, such as schematic blocks, templates, and so forth.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Instruments by
clicking the + icons or by double-clicking the folders.
2. Select the instruments that you require.
3. Click Tools > Apply Options.
4. On the Apply Options dialog box, click the Typical Schematic tab.
5. Select Enable typical schematic.
6. Beside the Typical schematic box, click Find.
7. On the Find dialog box, click Find Now to display the available typical schematics.
8. From the list of typical schematics, highlight the typical schematic that you want to apply to the
selected instruments.
9. Click OK.
10. Under Apply to, select one of the following options according to the rule the software uses to
apply the typical schematic:
All items - Applies the typical schematic to all the selected items.
Items with no typical schematic - Applies the typical schematic only to items without an
existing typical schematic. Use this option to add a typical schematic only to new items
among the items that you selected.
Items with a different typical schematic from the selection - Changes the typical
schematic of the selected items to the current typical schematic. Use this option to add a
typical schematic to items with a modified typical schematic definition.
11. Click Apply.

134

If you modify the components of a typical schematic that already has a reference from an item,
the software does not update the change in the reference until you next apply a typical
schematic or a profile to the item.
You can assign a new typical schematic or change an assigned typical schematic for an item
at any time.

SmartPlant Electrical User's Guide

Panel Management

SECTION 9

Panel Management
You can create the following types of panel in the Electrical Index:
Cabinets Multi-purpose electrical enclosures for various types of equipment. For more
information, see Create a Cabinet (on page 135).
Control Stations - Small cabinets containing low voltage start-stop circuitry used to control a
load at a remote location. For more information, see Create a Control Station (on page 136).
Local Panels - Cabinets containing circuit, equipment, and wiring items, used for example, to
provide switching or isolation close to a motor. For more information, see Create a Local
Panel (on page 137).
Junction Boxes - Containers for electrical connections. For more information, see Create a
Junction Box (on page 137).
In contrast to PDBs (power distribution boards), panels are much smaller in size and do not
contain busbars.

Create a Cabinet
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Cabinets folder, and then click New.
3. Accept the default item tag that is based on the naming convention for the panel, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. On the Cabinet Common Properties dialog box, edit the typical cabinet properties as
required.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new
cabinet.
You access the Cabinet Common Properties dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create a new cabinet.

SmartPlant Electrical User's Guide

135

Panel Management

Create a Control Station


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Control Stations folder, and then click New.
3. Accept the default item tag that is based on the naming convention for the control station, or
type your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. On the Control Station Common Properties dialog box, edit the control station properties
as required. For more details, see Edit Control Station Properties (on page 136).

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you create a new control
station.
You access the Control Station Common Properties dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create a new control station.
If the parent folder contains custom folders, the created item is placed in the root folder. If the
items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re- opening SmartPlant Electrical moves the
item from the root folder to the All Items folder.

Edit Control Station Properties


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels > Control
Stations.
2. Right-click the desired control station and on the shortcut menu, click Common Properties.
3. On the Control Station Common Properties dialog box, beside Associated load, click
Find to open the Find dialog box.
4. From the Equipment type list, select the desired load type.
5. Click Find Now.
6. From the data window, highlight an item tag.
7. Click OK to associate the item tag with the current control station.
8. To add one or more control, grounding, or instrumentation cables to the control station, do the
following:
a. Click Add.
b. On the Find dialog box, click Find Now to display the available control and grounding
cables that have at least one unassociated side.
c. For each cable that you want to associate with the control station, select the cable and
then click Apply.
9. To add an I/O signal to the control station that is going to be associated with a load, in the
Electrical Index, right-click the control station, and on the shortcut menu, click New Signal.

136

SmartPlant Electrical User's Guide

Panel Management

Create a Local Panel


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Local Panels folder and then click New Local Panel.
3. Accept the default item tag that is based on the naming convention for the panel, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. If required, right-click the local panel and click New Circuit to add a panel circuit.
Also, you can add a panel circuit by expanding the Typical Circuits folder in the
Reference Data Explorer and dragging an existing typical panel circuit
to the panel.
5. Right-click the desired circuit and on the shortcut menu, click an option to create new
disconnect, protection, converting or control equipment.
6. Repeat the previous step as often as needed to create additional items for the circuit.

Create a Junction Box


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Junction Boxes folder and then click New Junction Box.
3. Accept the default item tag that is based on the naming convention for the junction box, or
type your own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
4. If required, right-click the junction box and click New Circuit to add a panel circuit.
Also, you can add a panel circuit by expanding the Typical Circuits folder in the
Reference Data Explorer and dragging an existing typical panel circuit
to the junction
box.
5. Right-click the circuit and on the shortcut menu, click an option to create new disconnect,
protection, converting or control equipment.
6. Repeat the previous step as often as needed to create additional items for the circuit.

Define a Junction Box as a Consumer


You can define a junction box as a consumer. This allows you to include junction boxes in the
calculations of load summaries, load associations, and when generating enhanced all feeder load
summary reports.
1. Select a junction box in the Electrical Index.
2. In the Properties window, set the Is Load property to True.
3. In the Properties window, enter appropriate Load and Electrical values.
When performing a drill-down calculation for a PDB that has a branch connected to a bus
through a converting equipment item, junction box, or local panel that is defined as a consumer,
the software takes into account the total of this branch using the electrical power values of this
converting equipment item.

SmartPlant Electrical User's Guide

137

Panel Management

Define a Local Panel as a Consumer


You can define a local panel as a consumer. This allows you to include local panels in the
calculations of load summaries, load associations, and when generating enhanced all feeder load
summary reports.
1. Select a local panel in the Electrical Index.
2. In the Properties window, set the Is Load property to True.
3. In the Properties window, enter appropriate Load and Electrical values.
When performing a drill-down calculation for a PDB that has a branch connected to a bus
through a converting equipment item, junction box, or local panel that is defined as a consumer,
the software takes into account the total of this branch using the electrical power values of this
converting equipment item.

Create a Panel Circuit


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels.
2. Right-click the Local Panels folder or the Junction Boxes folder and select an item.
3. Right-click the local panel or the junction box where you want to add the circuit and click New
Circuit.
Also, you can add a panel circuit by expanding the Typical Circuits folder in the
Reference Data Explorer and dragging an existing typical panel circuit
to the local panel
or the junction box.
4. Accept the default item tag that is based on the naming convention for the circuit, or type your
own item tag according to the naming convention.
For more details of naming convention settings, see Using Naming Conventions (on
page 65).
5. Right-click the desired circuit and on the shortcut menu, click an option to create new
disconnect, protection, converting or control equipment.
6. Repeat the previous step as often as needed to create additional items for the circuit.

138

SmartPlant Electrical User's Guide

SECTION 10

Cable Management
You can create cables in your project for several purposes. SmartPlant Electrical specifies the
following cable categories according to the purpose of the cable: power, control, grounding, and
instrumentation. The software supports compliance with the strict regulations governing cable
definitions by using standard reference cables as a basis for all the cables that you create in your
project. Reference cables contain technical cable data such as voltage rating, ampacity,
resistivity, cable material, and data relating to the construction of the cable. For this reason, you
must initially create all your reference cables in the Reference Data Explorer.
The software allows you to organize your reference cables in families known as cable
specifications. When you select a reference cable to use as a basis for your project cable, you
must select the appropriate cable category and cable specification for the reference cable.
Also, when you size project cables, the software looks for the appropriate reference cable based
on a particular cable specification and conductor arrangement.

Create a Reference Cable


You use reference cables as a basis for creating new cables in your project. Unlike other items,
which you can create directly in the Electrical Index or copy from the Reference Data Explorer,
you must create reference cables with manufacturer specifications prior to creating new cables in
the Electrical Index.
1. In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Cables.
2. Right-click the Power, Control, Grounding, or Instrumentation folder according to the type
of cable required, and then click New.
3. Accept the default item tag or type a name of up to 80 characters for the cable.
4. Enter values for the cable properties on the Reference Cable Common Properties dialog
box according to the available catalog information. You must enter values for those
properties marked with an asterisk.
To enable sizing of a power cable in the project, you should enter values for all the properties
on the General tab.

You access the Reference Cable Common Properties dialog box by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the cable.
Short circuit sizing calculations for project power cables use data in the Conductors lookup
tables, and this data is then used to select the appropriate reference cable. For this reason,
when you create a new reference cable, it is recommended that you open the Data tab of each
lookup table to ensure that appropriate data related to the reference cable is available, and if it
is not, to add the data on the lookup table.
Do not change any of the values on the Structure tab for the conductors lookup

tables.

SmartPlant Electrical User's Guide

139

Cable Management

Edit Reference Cable Common Properties


1.
2.
3.
4.

In the Reference Data Explorer, expand the folder hierarchy Wiring Equipment > Cables.
Expand the desired cable folder: Power Cables, Control Cables, or Grounding Cables.
Right-click the desired cable and on the shortcut menu, click Common Properties.
Enter values for the cable properties on the Reference Cable Common Properties dialog
box according to the available catalog information. You must enter values for those
properties marked with an asterisk.

To enable sizing of a power cable in the project, you should enter values for all the properties
on the General tab.

You can edit the properties of a reference cable as long as it has not been used in the
Electrical Index with any project item or if the reference cable is not part of any existing profile
or control station in the Reference Data Explorer.
Short circuit sizing calculations for project power cables use data in the Conductors lookup
tables, and this data is then used to select the appropriate reference cable. For this reason, if
you change the values of reference cable properties, it is recommended that you open the
Data tab of each lookup table to ensure that appropriate data related to the reference cable is
available, and if it is not, to add the data on the lookup table.
Do not change any of the values on the Structure tab for the conductors lookup

tables.

Create a Plant Cable


This procedure explains how to create a new cable in the Electrical Index based on existing
reference cable data.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Right-click the desired cable folder: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables, and then click New.
3. Accept the default item tag that is based on the naming convention for the cable, or type your
own item tag according to the naming convention.

For more details of naming convention settings, see Using Naming Conventions (on page
65).
If the cable naming convention includes the tag of an associated item and you rename the
associated item tag, you must click Refresh
on the toolbar of the Electrical Index or
the Electrical Engineer to update the cable tag.
If you are creating a number of cables at one time, you may want to stop at this point and
edit the cable properties at a later stage.
4. On the Cable Common Properties dialog box, General tab, select a cable specification.
5. For the selected specification, do one of the following:
If you know the reference cable that you want to use to define your project cable, select
that reference cable from the Reference cable list. The software populates the
properties with data from the reference cable.
If you want to perform sizing for a power cable to determine the most suitable reference
cable, select an option from the Conductor arrangement list.

140

SmartPlant Electrical User's Guide

Cable Management
In addition to sizing a non- sized power cable, you can perform cable sizing when you
select a specific reference cable also.
6. Enter other values for the cable properties as required. You must enter values for those
properties marked with an asterisk.
7. Click the Design Data tab and enter routing and cable length data as required.

You must associate each power cable in the Electrical Index with a reference (catalog)
cable. You must therefore first define appropriate reference cables in the Reference Data
Explorer.
You access the Cable Common Properties dialog box (on page 624) by clicking the Common
Properties command on the shortcut menu or you can specify in the preferences to open the
dialog box directly when you create the cable.
You cannot delete a cable that has been assigned to a cable drum.
You cannot assign a project cable to a different cable drum if this cable has been locked to a
drum.

Edit Plant Cable Properties


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Expand the desired cable folder: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
3. Right-click the desired cable and on the shortcut menu, click Common Properties.
4. On the Cable Common Properties dialog box, General tab, select a cable specification.
5. For the selected specification, do one of the following:
If you know the reference cable that you want to use to define your project cable, select
that reference cable from the Reference cable list. The software populates the
properties with data from the reference cable (for further details, see Notes at the end of
this procedure).
If you want to select a reference cable by performing and applying sizing for a power
cable, enter the necessary data (for details of the properties that are mandatory, see
Required Data for Cable Sizing (on page 151)).
In addition to sizing a non- sized power cable, you can perform cable sizing when you
select a specific reference cable also.
6. Enter other values for the cable properties as required. You must enter values for those
properties marked with an asterisk.
If the cable naming convention includes the tag of an associated item and you rename
the associated item tag, you must click Refresh
on the toolbar of the Electrical Index or
the Electrical Engineer to update the cable tag.
7. Click the Design Data tab and enter routing and cable length data as required.

When applying sizing for a power cable, suitable reference cables that the software can select
from must be defined in the Reference Data Explorer.
When changing the reference cable manually or by applying cable sizing, the software copies
all properties relating to cable construction and electrical properties such as ampacity and
resistance. The software does not copy project data such as cable tag and description, nor
data used for sizing such as estimated and design lengths. The software copies other data
such as manufacturer and model only if the value for the project cable is initially empty.

SmartPlant Electrical User's Guide

141

Cable Management

Whenever the data of the reference cable that a project cable is associated with is changed,
the Compare to Reference command button in the project cable becomes enabled. This
button opens the Compare Project and Reference Cable Data dialog box (on page 643), from
which you can compare the current project cable properties with the modified reference cable
properties. You can copy the updated reference data to the project cable if required. For a
parallel cable assembly, the software applies the reference data to all the cables in the
assembly.
For full details of the most commonly used properties, see the Cable Common Properties
dialog box (on page 624). Also, you can edit these properties and additional properties in the
Properties window or in the Tabular Editor.
You cannot delete a cable that has been assigned to a cable drum.
You cannot assign a project cable to a different cable drum if this cable has been locked to a
drum.
When defining naming conventions for parallel cables, you can determine where in the cable
tag name you want to include the parallel cable suffix. In Options Manager, on the Define
Naming Conventions dialog box (Options > Naming Conventions > Define), define the
parallel cable suffix in the Segment definitions section. You can move the parallel cable
suffix property up or down the list to set the position of this property in the segment definition.
If you do not select this check box, the suffix for the parallel cables will appear at the end of the
cable tag name.

Delete a Cable
1. In the Reference Data Explorer or the Electrical Index, expand the folder hierarchy Wiring
Equipment > Cables.
2. Expand one of the cable folders: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
3. Right-click the cable that you want to delete, and on the shortcut menu, click Delete.
4. At the prompt, click Yes to confirm the deletion.
If you select more than one cable for deletion, the software records any deletion failures in
the Batch Deletion log file. For the procedure for creating and viewing the log file, see Generate
Error Log Files (on page 34).

Deletion Rules for Cables


The following rules apply when you delete a cable in the Reference Data Explorer or the
Electrical Index:

142

Item

Precondition

Result

Reference cable

There is no project cable that


uses the properties of the
reference cable.

The software deletes the cable.

Project cable

The project cable is not


assigned to a cable drum.

The software deletes the cable and


moves any items in the electrical
hierarchy below the deleted cable
to the root of the Electrical
Engineer.

Control station cable

None.

The software deletes the cable.

SmartPlant Electrical User's Guide

Cable Management

Cable Glands
The topics in this section deal with the management of cable glands.

Create Reference Glands


1. In the Reference Data Explorer, under Wiring Equipment, right-click the Glands folder.
2. Click New Gland.
3. On the Reference Gland Common Properties dialog box, General tab, type values for each
property as desired.
4. Click the Details tab.
5. Enter values for the properties as required. You must enter values for those properties
marked with an asterisk.

Associate Cable Sides with Glands


This procedure associates glands with project or reference cables. You can specify different
gland types for each cable end.
1. In the Electrical Index, select a cable and open its Cable Common Properties dialog box.
You can associate glands with a reference cable if you want to create project cables from
it with glands already assigned.
2. Click the Connections tab.
3. On the From or To cable side, beside the appropriate Gland property, click Find.
After you have associated glands with a number for cables, you can view the bill of
materials for the glands by generating a Gland Material Take-Off report.

Batch Associate Cable Sides with Glands


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Select the desired cable folder: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
3. In the lower pane, select the desired cables for which you want to associate glands.
4.
5.
6.
7.
8.
9.

You can also perform the cable selection in the Tabular Editor.
Click Actions > Cables > Batch Cable Side and Gland Association.
On the From or To cable side, clear the Clear existing gland check box to allow replacement
of existing cable glands for the cables that you select.
Beside the check box, click Find to open the Find dialog box.
Click Find Now.
In the Results data window, select the gland that you want to associate with the cable sides,
and click OK.
From the cable list in the Batch Cable Side and Gland Association dialog box, select the
check boxes beside the cables for which you want to make gland associations

You can select the Speed up association check box to make the process work faster.
However, if the software encounters a problem with one of the cables, the entire association
process is canceled.
10. Click OK.

SmartPlant Electrical User's Guide

143

Cable Management

Batch Dissociate Cable Sides and Glands


1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Select the desired cable folder: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
3.
4.
5.
6.
7.

For power cables, you can dissociate glands only.


In the lower pane, select the desired cables.
Click Actions > Cables > Batch Cable Side and Gland Association.
On the From or To cable side, select the Clear existing connection check box to dissociate
cable side associations for the cables that you select.
On the From or To cable side, select the Clear existing gland check box to dissociate cable
glands for the cables that you select.
From the cable list, select the check boxes beside the cables for which you want to dissociate
the items and click OK.

Synchronize Cable Glands with Reference Cables in Batch


Mode
This option allows you synchronize the glands on selected plant cables with the glands on the
reference cables associated with each of the selected plant cables.
1. In the Electrical Index, expand the Wiring Equipment > Cables hierarchy and then click one
of the cable type folders.
2. In the List View pane of the Electrical Index, select the cables that you require (use the
CTRL or SHIFT key to select multiple cables).
3. On the SmartPlant Electrical menu bar, click Actions > Cables >Synchronize Gland
Associations.
4. On the Synchronize Gland Associations dialog box, under Synchronize, select one of the
following options that determines the side of the cables on which you want to synchronize the
glands with the glands on the associated reference cables:
Glands on both cable sides Synchronizes the glands on both sides of the selected
cables.
Glands on the "To" cable sides Synchronizes the glands on the "To" side of the
selected cables.
Glands on the "From" cable sides Synchronizes the glands on the "From" side of the
selected cables.
5. In the Cable data section, select the cables that you want to be included in the
synchronization process.

144

Make your cable selection as follows:


To select a single cable, select the check box beside the desired cable in the data
window.
To select all the cables in the data window, click the Select cables check box below the
data window.
To clear the selection of all the cables, click the Select cables arrow and select None.
To select all the cables that do not have any glands, click All cables without glands.
To select all the cables whose glands are different from the glands on their associated
reference cables, click All cables with different glands.

SmartPlant Electrical User's Guide

Cable Management
6. Click OK to start the synchronization process.

The software synchronizes the glands with the glands of each reference cable that is
associated with the selected plant cables.
The Filter cable criteria options are disabled since you have selected the required cables in
the Electrical Index.
The Show Cable Data button is also disabled as the software populates the Cable data grid
automatically.

Synchronize Cable Gland Associations with a Specific


Reference Cable
This procedure explains how to synchronize glands on a number of plant cables with the glands
on a specific reference cable.
1. On the SmartPlant Electrical menu bar, click Actions > Cables >Synchronize Gland
Associations.
2. On the Synchronize Gland Associations dialog box, set a filter criteria that determines
which cables are displayed in the Cable data section.
You must select an appropriate reference cable whose glands will be
synchronized with all the selected plant cables. The Show Cable Data button remains
unavailable until you select a reference cable.
3. Under Synchronize, select one of the following options that determines the side of the cables
on which you want to synchronize the glands with the glands on the associated reference
cables:
Glands on both cable sides Synchronizes the glands on both sides of the selected
cables.
Glands on the "To" cable sides Synchronizes the glands on the "To" side of the
selected cables.
Glands on the "From" cable sides Synchronizes the glands on the "From" side of the
selected cables.
4. Click the Show Cable Data button to populate the Cable data section with all the plant cables
that comply with filter condition that you have set and whose glands are different from the
glands on the associated reference cables.
This button becomes available only after selecting a reference cable in the Filter
criteria group box and the glands on that reference cable is inconsistent with glands on the
selected plant cables.
5. In the Cable data section, select the cables that you want to be included in the
synchronization process.

Make your cable selection as follows:


To select a single cable, select the check box beside the desired cable in the data
window.
To select all the cables in the data window, click the Select cables check box below the
data window.
To clear the selection of all the cables, click the Select cables arrow and select None.
To select all the cables that do not have any glands, click All cables without glands.
To select all the cables whose glands are different from the glands on their associated
reference cables, click All cables with different glands.

SmartPlant Electrical User's Guide

145

Cable Management
6. Click OK to start the synchronization process.

Size a Cable
This procedure explains how to size low voltage project power cables. If you associate the cable
with a load, the software uses the load data for sizing, or you can size a cable that is not
associated with a load by typing in data manually. The algorithm that the software uses for sizing
gives a good estimate; however, we recommend that you use specialized cable sizing software for
more accurate results.
SmartPlant Electrical uses algorithms that give a good estimate for cable sizing; however,
we recommend that you use specialized cable sizing software for more accurate results.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables > Power
Cables.
You can also select a cable in the Electrical Engineer.
2. Select the desired cable and do one of the following:
Click Edit > Common Properties.
Right-click the cable and on the shortcut menu, click Common Properties.
Press CTRL + F2.
3. On the General tab of the Cable Common Properties dialog box, select the Sizing required
check box.
4. Select a cable specification.

When sizing the cable, the software selects the appropriate reference cable from the
family of cables that you specify under Cable specification and with the value that you
select under Conductor arrangement.
When sizing a multi-core cable, you must first select a reference cable. You cannot size
a multi-core cable if you select a non-sized power as a reference cable. This limitation
is due to the fact that the number of conductors in the project cable is a required
parameter before performing the sizing operation.
5. Click the Design Data tab and enter cable length data.
In the absence of a value for the Design length property, the software uses the value in
the Estimated length box.
6. Click the Sizing Data tab and enter data. For full details of the properties for which you must
enter values for sizing, see Required Data for Cable Sizing (on page 151).
If the cable has an associated load, you can copy load data to the cable by clicking
Refresh Data.
7. Click Perform Sizing to perform the sizing calculation.
8. Click Apply Sizing to select the recommended reference cable or cables for use as the basis
for this cable. The software replaces the currently selected reference cable and updates the
cable properties.
If you want to use the shipped reference data provided with the application, please
validate that these values are appropriate for cable sizing. Note that shipped reference data
is provided to you as uncertified samples only.

146

SmartPlant Electrical User's Guide

Cable Management
9. Click Apply to create the sized cable or set of cables in your project.

For full details of the most commonly used properties, see the Cable Common Properties
dialog box (on page 624). Also, you can edit these properties and additional properties in the
Properties window or in the Tabular Editor.
If the cable has an attached load, the software copies the values of sizing data properties from
the load to the cable.
If you have changed the sizing data of a cable to such an extent that the current cable
becomes unsuitable for its function, you need to perform manual resizing of this cable (click
the Perform Sizing button on the Sizing Data tab of the Cable Common Properties dialog
box). The software informs you about this by displaying an appropriate message in the
Calculation information box on the Sizing Data tab of the Cable Common Properties
dialog box and by turning on the Sizing required flag (the software automatically selects the
Sizing required check box on the General tab of the Cable Common Properties dialog
box). For details about the properties that require manual resizing of cables, see Automatic
Switch-On of the Sizing Required Flag (on page 153).
If the software cannot find a single reference cable that is suitable for the needed cable size, it
selects as many parallel cables as required, up to the maximum allowed, which you can
determine in Options Manager. Also in Options Manager, you can select the minimum
conductor size that the software looks for when sizing cables.
You have to resize a power cable if you reassign it to another load or modify the cable
properties. Also, we recommend that you generate a report or use the Tabular Editor to view
which power cables have their Cable Sizing Flag property set to True (same as the Sizing
required check box on the Cable Common Properties dialog box. This enables you to see
the power cables that need resizing.

Batch Size Cables


This procedure explains how to size a group of power cables in batch mode.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables > Power
Cables.
2. Click the Power Cables folder and adjust the size of the panes to view the individual cables in
the list view pane.
3. If required, change the view in the list view pane by clicking View Settings
to toggle
through each view of the items in the list view pane, or click the arrow beside the icon and
select the desired view.
4. Hold CTRL while clicking the cables that you want to size.
5. Click Actions > Cables > Batch Size Cables.
6. In the Batch Size Cables window, do one of the following:
For each cable that you want to size, select the Select check box.
Select the Select all check box if you intend to size all the cables in the list.
7. Click Excel Report to display the information in this window in an Excel file, from where you
can format the layout and print the data as required.
If data required for sizing is missing from a cable, the software cannot size the
cable. We therefore recommend that you print the contents of the window or view the
Comments column to ascertain whether data is missing for any of the cables that you intend
to size. You should open the Cable Common Properties dialog box for each of those cables
and complete the data, and then you can size the cables in batch mode.

SmartPlant Electrical User's Guide

147

Cable Management
8. Click Apply Sizing to perform the sizing for the selected cables.

When the selected set of cables for batch sizing includes parallel cables, only one tag per
parallel cable assembly appears in the display; however the software performs the operation
for all the parallel cables in each assembly.
The cable data in the Batch Size Cables window is read-only. To update property values,
you need to do so for each cable individually.

Define Custom Basic Ampacity for Cable Sizing


SmartPlant Electrical allows you to calculate cable sizing using a custom basic ampacity values
that you define in lookup tables. You can select a custom routing method from the Routing list on
the Sizing Data tab of the Cable Common Properties dialog box. Once you select a custom
routing method, the software calculates the custom basic ampacity value based on the data that
exists in the custom basic ampacity lookup table. The software displays the calculated custom
basic ampacity value on the General tab of the Cable Common Properties dialog box.
Prior to sizing a cable using this method, do the following to preliminary steps to customize basic
ampacity:
1. Update the Routing select list on the Sizing Data tab of the Cable Common Properties
dialog box and add new custom installation method values:
a. On the SmartPlant Electrical menu bar, click Tools > Update Select Lists.
b. On the Update Select List dialog box, select Routing from the Selected list.
c. Add the new routing method select list values as needed and click OK.
Do not modify or overwrite the existing InAir or UnderGround select list items.
2. In Options Manager, open the General Settings and define the name of the new custom
basic ampacity lookup table.
You can add as many new custom basic ampacity lookup tables as you need.
3. In SmartPlant Electrical, create a new lookup table with the same name.
a. In the Reference Data Explorer, expand the Lookup Tables folder.
b. Right-click the Cables folder and select New Lookup Table.
c. Make sure that the name the new lookup table is exactly the same as it appears on the
General Settings in Options Manager.
4. Populate the new lookup table with your data.

For more information on how to define your lookup table, see Example of a Custom Basic
Ampacity Lookup Table (on page 149).
The software does not validate the changes made to custom basic ampacity lookup
tables.
The software does not provide the means to synchronize the lookup tables with the
associated cables.
When copying an electrical network from the Reference Electrical Engineer, the
software does not copy custom installation methods that are defined in the Routing select
list.
You can now use your custom basic ampacity to size cables. For details, see Use Custom Basic
Ampacity to Size Cables (on page 150).

148

SmartPlant Electrical User's Guide

Cable Management

Example of a Custom Basic Ampacity Lookup Table


The following images provide an example of how to define a custom ampacity lookup table.

The Structure Tab


This example provides only those properties that we recommend to include in the
Definition table. You can define the lookup table according to your needs. However, the lookup
table definition must contain the Custom Basic Ampacity property and its output must be Out.

SmartPlant Electrical User's Guide

149

Cable Management
The Data Tab

Use Custom Basic Ampacity to Size Cables


The following procedure explains how to size a cable that uses a custom basic ampacity. For
details about defining a custom basic ampacity, see Define Custom Basic Ampacity for Cable
Sizing (on page 148).
1. Right-click a required cable and then on the shortcut menu, click Cable Common Properties.
2. On the Cable Common Properties dialog box, click the Sizing Data tab.
3. From the Routing list, select an appropriate custom routing definition.
Make sure that you select one of your custom routes and not InAir or
UnderGround. If you select InAir or In Ground, the software will not use the custom
ampacity value to size the cable.
4. In the Sizing results group box, click the Perform Sizing button.
The basic ampacity value that was used to size the cable appears on the General tab
of the Cable Common Properties dialog box, under Custom basic ampacity.

150

SmartPlant Electrical User's Guide

Cable Management

Required Data for Cable Sizing


The software performs cable sizing via a number of stages: thermal sizing, voltage drop
calculation at normal running, and for a motor, voltage drop calculation at starting.
You must enter all the data required for the thermal sizing and voltage drop stages in order for the
software to perform sizing. In addition, you can specify optionally for the software to perform
short circuit sizing. For further details of the data properties, see the Cable Common Properties
dialog box (on page 624) and refer to the appropriate dialog box tab.
You can find this information in the Cable Algorithms.xls file, which resides in SmartPlant
Electrical program folder resdlls > 0009 and from there, double-click the Cable Algorithms.xls file.

The software performs sizing by selecting a matching reference cable from the Reference
Data Explorer, so only those reference cables that you created are available for
selection. You should therefore ensure that you create in the Reference Data Explorer all
possible cable types and sizes that you may want to use.
If you have changed the sizing data of a cable to such an extent that the current cable
becomes unsuitable for its function, you need to perform manual resizing of this cable (click
the Perform Sizing button on the Sizing Data tab of the Cable Common Properties dialog
box). The software informs you about this by displaying an appropriate message in the
Calculation information box on the Sizing Data tab of the Cable Common Properties
dialog box and by turning on the Sizing required flag (the software automatically selects the
Sizing required check box on the General tab of the Cable Common Properties dialog
box). For details about the properties that require manual resizing of cables, see Automatic
Switch-On of the Sizing Required Flag (on page 153).

Thermal Sizing
In the thermal sizing step, the software attempts to locate from the Reference Data Explorer the
smallest size reference cable of the specified type and construction, with a de-rated ampacity
equal to or greater than the full load current of the connected load. If the software cannot find a
single cable that meets this requirement, it continues with groups of identical cables in parallel,
from the minimum conductor size, up to the maximum permitted number of parallel cables. You
can specify the minimum conductor size, the maximum permitted number of parallel cables, and
the default suffix naming method in the Options Manager.
The software requires the following data for this stage of the calculation:
Cable specification (General tab) Specifies the family of cables within which the software
looks for a suitable reference cable.
Conductor arrangement (General tab) Specifies the desired conductor arrangement of the
reference cable.
Full load current [FLA] (Sizing Data tab) Specifies the nominal current for a load associated
with the cable, or a value that you type manually.
Routing (Sizing Data tab) Indicates the appropriate routing type for the current cable: InAir,
UnderGround, or some other custom routing type that you define. The option that you select
affects whether the software uses the ampacity value in air, in the ground, or custom basic
ampacity when sizing a cable.
Conformity to standard (Sizing Data tab) Determines the electrical standard, IEC or NEC,
that the software uses. If you select the NEC standard, the software multiplies the full load
current by a factor of 1.25.

SmartPlant Electrical User's Guide

151

Cable Management
De-rating factor / Utilization factor / Ambient temp. factor (Sizing Data tab) Specifies
properties that the software divides the nominal current by to obtain the de-rated cable ampacity.

Voltage Drop Calculations


The software calculates the voltage drop across the cable under full load conditions, based on the
cable length and other factors and compares it with the maximum allowable voltage drop that you
specify. The software attempts to locate a cable with a sufficiently large conductor size, based on
the thermal sizing, that gives a voltage drop lower than the allowed maximum value. In addition,
the software calculates the maximum cable length for which the voltage drop does not exceed the
maximum allowable value. For a motor, the software also calculates the percentage voltage drop
under starting conditions following the same methodology.
The software requires the following data for this stage of the calculation:
Reference cable (General tab) The reference cable you select provides, in addition to the
basic ampacity values, the values of the Resistance per unit length and Reactance per unit
length properties that the software requires for the voltage drop calculation.
Estimated length / Design length (Design Data tab) Indicates the length of the cable that the
software uses to calculate the voltage drop. The software uses the design length if
available. Otherwise, it uses the estimated length.
Supply (Sizing Data tab) Determines the formula that the software uses for the voltage drop
calculation, depending on whether the supply is alternating current (AC) or direct current (DC).
Phases (Sizing Data tab) Determines the formula that the software uses for the voltage drop
calculation, depending on whether an AC supply is single- or three-phase.
Load voltage (Sizing Data tab) Specifies the nominal voltage for a load associated with the
cable, or a value that you type manually.
Starting current (Sizing Data tab) Specifies the starting current for a load or any other
electrical item associated with the cable, or a value that you type manually for a load or any other
electrical item connected to a power cable.
Power factor at full load (Sizing Data tab) Specifies the power factor under normal running
conditions for a load associated with the cable, or a value that you type manually.
Power factor at starting (Sizing Data tab) Specifies the power factor under starting
conditions for a motor associated with the cable, or a value that you type manually for a motor.
Allowable voltage drop at full load (Sizing Data tab) Specifies the maximum allowed
voltage drop under normal running conditions for the load. To ignore the voltage drop, type a
value of 100% for this property.
Allowable voltage drop at starting (Sizing Data tab) Specifies the maximum allowed voltage
drop under starting conditions for a motor. To ignore the voltage drop, type a value of 100% for
this property.

Short Circuit Sizing


You can specify that you want the software to perform short circuit sizing by selecting the Use
short circuit cable sizing check box on the Sizing Data tab. The software examines each
reference cable that already meets the sizing requirements for the thermal and voltage drop
criteria. Based on the short circuit parameters and conductor short circuit coefficients, the
software calculates the minimum required conductor cross-section area for the cable in cmils and
displays the value in the Required area (cmils) box. The algorithm compares the results of this
calculation with the value in the Conductor Area cmils lookup table for the reference cable in
question to determine whether the reference cable meets the short circuit sizing criteria. The
software checks each reference cable in turn until it finds the smallest size cable that meets the

152

SmartPlant Electrical User's Guide

Cable Management
short circuit sizing criteria. It is important that the lookup tables contain suitable values to enable
the software to perform the calculation successfully.
Note that after changing the short circuit fault values, the software does not re-calculate
the voltage drop automatically. This is a manual process that you have to start yourself.
The software requires the following data for this stage of the calculation:
Material (General tab) Select the desired material for the current-carrying conductors.
Insulation (General tab) Select the desired material used for insulating the current-carrying
conductors.
Use short circuit cable sizing (Sizing Data tab) You must select this check box to enable the
software to perform the short circuit sizing calculation.
Duration (Sizing Data tab) Type the maximum time for which the cable is expected to
withstand a fault short circuit.
Fault current (Sizing Data tab) Type the maximum current that the cable is expected to
withstand in the event of a short circuit fault current.
The software displays in the Calculation information box the message 'Not found' under
the following conditions: when no reference cable exists corresponding to the cable specification
or arrangement, when there are missing values for ampacity, resistance, or reactance, or when
the number of parallel cables exceeds the specified limit in the Options Manager.

Automatic Switch-On of the Sizing Required Flag


Changing one of the following properties automatically switches on (selects) the Sizing required
check box on the General tab of the Cable Common Properties dialog box.

Plant Cable Properties


(The properties of the power cable itself that needs to be resized)
The software automatically recalculates the voltage drop after you change one of the
cable property values for a cable that has already been sized. If the value you enter exceeds the
sizing parameters of the current cable, you will need to resize the cable by clicking the Perform
Sizing button on this tab. The software displays an appropriate message to this effect in the
Calculation information box on this tab and turns on the Sizing required flag on the General
tab of the Cable Common Properties dialog box.
Actual / design / installed length
Number of phases
Rated voltage
Full load current (FLA)
Starting current
Power factor at full load
Power factor at starting
Allowable voltage drop at full load
Allowable voltage drop at starting
Include protection device
De-rating factor
Utilization factor
Code factor
Ambient temperature factor

SmartPlant Electrical User's Guide

153

Cable Management
Reference Cable Properties
(The properties of the reference cable associated with the plant power cable that needs to be
resized)
Basic ampacity in air
Basic ampacity in ground
Custom basic ampacity
Reactance per unit length
Resistance per unit length

Load Properties
(The properties of the load connected to the plant power cable that needs to be resized)
Conformity to standard
Rated voltage
Number of phases
Supply (AC/DC)
Full load current (FLA)
Locked rotor current (for motors only)

Insert a Power Cable Between Equipment Items


Use this procedure to insert a power cable between two equipment items in the Electrical
Engineer. This procedure is useful when two pieces of electrical equipment are logically
connected in the Electrical Engineer. For example, you can insert a cable between a
transformer and a generator.
1. In the Electrical Engineer, select an equipment item and do one of the following:
On the menu bar, click Actions > Cables > Insert Power Cable.
Right-click the selected item, a, and then, on the shortcut menu, click Insert Power
Cable.
2. On the Insert Power Cable dialog box, do one of the following:

Choose Select from cable library and then, click


to open a dialog box where you
can select a cable from a library of reference power cables.
Choose Specify construction and define power cable parameters for later sizing.
3. Click OK to create and insert the power cable under the equipment item you selected in the
Electrical Engineer.

Create Parallel Cables


This procedure explains how to add a number of parallel cables to an existing parallel cable.
1. In the Electrical Index, select a required power cable and open its common properties.
2. On the General tab of the Cable Common Properties dialog box, select a value from the
Total number list in the Parallel cables group box.
3. Click OK.

154

The new parallel cables then appear in the Electrical Index under the power cable to which
you have added the parallel cables.

SmartPlant Electrical User's Guide

Cable Management

Opening the common properties of a parallel cable shows you the number of existing parallel
cables and the parallel cable list.
If you have defined methods and settings for parallel cables in Options Manager, we do not
recommend that you change these parameters in the middle of a project life-cycle in case
there are no naming conventions for parallel cables.

Replace Cables
This procedure explains how to replace the reference cable used for a group of project
cables. The software replaces the project cables with a standard cable that you previously
defined in the Reference Data Explorer.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Expand one of the cable folders: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
3. Click the folder and adjust the size of the panes to view the individual cables in the list view
pane.
4. If required, change the view in the list view pane by clicking View Settings
to toggle
through each view of the items in the list view pane, or click the arrow beside the icon and
select the desired view.
5. Hold CTRL while clicking the cables that you want to replace.
6. Click Actions > Cables > Replace Cables.
7. On the Replace Cables dialog box, do one of the following:
For each cable that you want to replace, select the check box beside the cable name.
Select the Select all check box if you intend to replace all the cables in the list.
8. Select a reference cable to replace in the selected project cables.
If required, select properties under Filter criteria to filter the list of available reference
cables.

The software replaces cables of the same category. For example, you can only replace a
power cable with another power cable.
You cannot replace a cable that has been locked to a cable drum.
The software does not allow you to replace cables in batch mode if the cables that you want to
replace have already been terminated. You can replace a cable manually in the Common
Properties dialog box if the reference cable has the same conductor arrangement as the
cable you want to replace.
The software replaces only the values of the following properties with values from the
reference cable that you select:
Cable Category
Cable Specification
Basic Ampacity in Air
Basic Ampacity in Ground
Reactance
Resistivity
Actual Conductor Size
Additional Conductor Size
Air Ampacity Temperature

SmartPlant Electrical User's Guide

155

Cable Management

156

Armor Type
Bending Radius
Conductor Arrangement
Conductor Material
Conductor Size
Inner Insulation Temperature
Insulation Color
Insulation Material
Insulation Temperature rating
Insulation Thickness
Insulation Voltage Rating
Jacket Color
Jacket Insulation Material
Jacket Insulation Temperature
of Additional Conductors
of Conductors
of Conductors in Group
of Sets
Outside Diameter
Overall Shield
Pull Tension
Weight per Length
Cable Formation
Electrical Equipment Class
Electrical Equipment Sub Class
Electrical Equipment Type
Stores Part Number
The software clears the values of the following properties:
Calc Starting Voltage Drop
Calc Voltage Drop Percent
The software retains the values of all other properties of the selected cables.
When the selected cables for replacing include parallel cables, only one tag per parallel cable
assembly appears in the display; however the software performs the operation for all the
parallel cables in each assembly. If descriptions exist for the individual parallel cables, the
software retains those descriptions.
If you want to replace a group of parallel cables generated by the sizing procedure with cables
having a different formation, for the Reference cable property, you must select Non-sized
power cable. Otherwise, you can only replace parallel cables with another group of cables
that have the same formation. For example, you can only replace three parallel cables of 300
m2
2
mm2 (3*300 m ) with another configuration of 3 parallel cables, such as 3*90 mm , 3*(3*25
2
2
mm +1*10 mm ), and so forth.

SmartPlant Electrical User's Guide

Cable Management

Batch Replace Cable Side Associations


This procedure explains how to replace the cable end connections for a group of non-power
cables. It is useful where a large number of cables are connected to the same marshaling rack or
cabinet.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Select the desired cable folder: Control Cables, Grounding Cables, or Instrumentation
Cables.
3.
4.
5.
6.
7.
8.
9.
10.

You cannot perform this operation for power cables.


In the lower pane, select the desired cables whose end connections you want to replace.
Click Actions > Cables > Batch Cable Side and Gland Association.
On the From or To cable side, clear the Clear existing connection check box to allow
replacement of existing cable associations for the cables that you select.
Beside the check box, click Find to open the Find dialog box.
From the Equipment type list, select the desired equipment type.
Click Find Now.
In the Results data window, select the item that you want to associate with the cable sides,
and click OK.
From the cable list in the Batch Cable Side and Gland Association dialog box, select the
check boxes beside the cables for which you want to make cable side associations.

You can select the Speed up association check box to make the process work faster.
However, if the software encounters a problem with one of the cables, the entire association
process is canceled.
11. Click OK.

Single-Core Cable Assemblies


A single core cable assembly is a grouping of single core cables that SmartPlant Electrical
manages as a whole entity and not individually reducing repetitive work, mistakes, and
inconsistencies. For example, sometimes there is a need to connect 3 phase (3 wire, 4 or 5 wire)
equipment using individual single core cables, one core per phase, often needed when dealing
with high voltage or high current cables.

Create a Single-Core Cable Assembly in the Electrical Index


This procedure shows you how to create a single-core cable assembly in the Electrical Index.
1. In the Electrical Index locate the Wiring Equipment > Cables > Single-Core Cable
Assemblies folder.
2. Right-click the Single-Core Cable Assemblies folder and then click New Single-Core Cable
Assembly on the shortcut menu.
3. On the new Single-Core Cable Assembly icon, do one of the following:
a. Right-click the new cable assembly and from the shortcut menu select Common
Properties.
b. Double-click the new cable assembly.
4. On the Single-Core Cable Assembly Common Properties dialog box, In the Cable
arrangement field, select the required cable arrangement (optional).

SmartPlant Electrical User's Guide

157

Cable Management
5. In the Phase arrangement field, select the required phase arrangement.
6. Type in a description, height, and width in their respective fields (optional).
7. At the side of the Reference cable field, click the ellipsis button
to open the Select
Reference Cable dialog box.
8. On the Select Reference Cable dialog box, select the required reference power cable and
click OK.
9. In the Current carrying cores group box, in the Phase label fields, select the label for each
power cable .
The software does not allow you to select the same label for two different power cables in
the cable assembly.
10. In the Neutral cables group box, click Add to open the Select Reference Cable dialog box.
11. On the Select Reference Cable dialog box, select the required cable and click OK.
The values for the selected neutral cable are added automatically to the fields in the
Neutral cables group box.
12. In the Grounding cables group box, click Add to open the Select Reference Cable dialog
box.
13. On the Select Reference Cable dialog box, select the required cable and click OK.
The values for the selected grounding cable are added automatically to the fields in the
Neutral cables group box.
14. Click OK.

158

When defining a neutral or grounding cable, on the Select Reference Cable dialog box, you
can select a power or grounding cable from the Cable category list. Power cables used as
grounding or neutral cables are automatically connected as phase cables and they appear in
the Electrical Engineer. In cable block diagrams and SLDs, the software displays them as
phase power cables belonging to single-core cable assemblies.
After clicking OK on the Common Properties dialog box, the software automatically displays
an expanded view of the cable assembly and adds the assembly's cables to their relevant
folders in the Electrical Index..
When connecting the power connectors (S, T, R) of a single-core cable assembly to an item of
equipment, the software automatically completes the connection of the power connectors after
the first connection has been made to that item. For example, after connecting the S cable to
a motor the software automatically connects the remaining two power cables (T and R) to the
motor. The grounding and neutral cables are not connected automatically and are connected
by the user.
Changing the tag sequence of one of the cables in an assembly affects the tag sequence of all
of the other cables in that assembly.
Making any other change (for example, changing the sizing, routing, and so forth) in the
properties of one of the cables in an assembly that is connected to bus phases affects only
those cables in the assembly that are connected to the phases of the cable assembly.
Changing the properties of a grounding or neutral cable in an assembly affects only that
particular cable.

SmartPlant Electrical User's Guide

Cable Management

Create a Single-Core Assembly Based on a Predefined Cable


Assembly
This procedure shows you how to create a single-core cable assembly in the Electrical Index
using a predefined cable assembly.
1. In the Electrical Index locate the Wiring Equipment > Cables > Single-Core Cable
Assemblies folder.
2. Right-click on the Single-Core Cable Assemblies folder and click New Single-Core Cable
Assembly.
3. On the new Single-Core Cable Assembly icon, do one of the following:
a. Right-click and from the shortcut menu select Common Properties.
b. Double-click.
4. On the Single-Core Cable Assembly Common Properties dialog box, click Select
Predefined Cable Assembly.
5. On the Find dialog box, click Find Now.
6. In the Results pane select the reference single-core cable assembly required.
7. Click OK, the reference single-core cable assembly values are added to the Common
Properties.
8. Click OK.

After clicking OK on the Common Properties dialog box, the software automatically displays
an expanded view of the cable assembly and adds the assembly's cables to their relevant
folders in the Electrical Index..
When connecting the power connectors (S, T, R) of a single-core cable assembly to an item of
equipment, the software automatically completes the connection of the power connectors after
the first connection has been made to that item. For example, after connecting the S cable to
a motor the software automatically connects the remaining two power cables (T and R) to the
motor. The grounding and neutral cables are not connected automatically and are connected
by the user.
Changing the tag sequence of one of the cables in an assembly affects the tag sequence of all
of the other cables in that assembly.
Making any other change (for example, changing the sizing, routing, and so forth) in the
properties of one of the cables in an assembly that is connected to bus phases affects only
those cables in the assembly that are connected to the phases of the cable assembly.
Changing the properties of a grounding or neutral cable in an assembly affects only that
particular cable.

SmartPlant Electrical User's Guide

159

Cable Management

Create a Reference Single-Core Cable Assembly


This procedure shows you how to create a reference single-core cable assembly in the Reference
Data Explorer.
1. In the Reference Data Explorer locate the Wiring Equipment > Cables > Single-Core
Cable Assemblies folder.
2. Right-click on the Single-Core Cable Assemblies folder and click New Single-Core Cable
Assembly.
3. On the new Single-Core Cable Assembly icon, do one of the following:
a. Right-click and from the shortcut menu select Common Properties.
b. Double-click.
4. On the Single-Core Cable Assembly Common Properties, in the Cable arrangement
field, select the required cable arrangement (optional).
5. In the Phase arrangement field, select the required phase arrangement.
6. Type in a description, height, and width in their respective fields (optional).
7. At the side of the Reference cable field, click the ellipsis button
to open the Select
Reference Cable dialog box.
8. On the Select Reference Cable dialog box, select the required reference power cable and
click OK.
9. In the Current carrying cores group box, in the Phase label fields, select the label for each
power cable .
The software does not allow you to select the same label for two different power cables in
the cable assembly.
10. In the Neutral cables group box, click Add to open the Select Reference Cable dialog box.
11. On the Select Reference Cable dialog box, select the required reference grounding cable
and click OK.
The values for the selected neutral cable are added automatically to the fields in the
Neutral cables group box.
12. In the Grounding cables group box, click Add to open the Select Reference Cable dialog
box.
13. On the Select Reference Cable dialog box, select the required reference grounding cable
and click OK.
The values for the selected neutral cable are added automatically to the fields in the
Grounding cables group box.
14. Click OK.

160

When connecting the power connectors (S, T, R) of a single-core cable assembly to an item of
equipment, the software automatically completes the connection of the power connectors after
the first connection has been made to that item. For example, after connecting the S cable to
a motor the software automatically connects the remaining two power cables (T and R) to the
motor. The grounding and neutral cables are not connected automatically and are connected
by the user.

SmartPlant Electrical User's Guide

Cable Management

When defining a neutral or grounding cable, on the Select Reference Cable dialog box, you
can select a power or grounding cable from the Cable category list. Power cables used as
grounding or neutral cables are automatically connected as phase cables and they appear in
the Electrical Engineer. In cable block diagrams and SLDs, the software displays them as
phase power cables belonging to single-core cable assemblies.
Changing the tag sequence of one of the cables in an assembly affects the tag sequence of all
of the other cables in that assembly.
Making any other change (for example, changing the sizing, routing, and so forth) in the
properties of one of the cables in an assembly that is connected to bus phases affects only
those cables in the assembly that are connected to the phases of the cable assembly.
Changing the properties of a grounding or neutral cable in an assembly affects only that
particular cable.

Copy a Single-Core Cable Assembly from the Reference Data


Explorer
This procedure shows you how to copy a reference single-core cable assembly from the
Reference Data Explorer to the Electrical Index.
1. In the Reference Data Explorer, open the Wiring > Cables > Single-Core Cable
Assemblies folder.
2. Select the required reference single-core cable assembly.
3. Drag the single-core cable assembly to the Electrical Index and drop it into the Wiring >
Cables > Single-Core Cable Assemblies folder.

After dragging a reference single-core cable assembly to the Electrical Index, the software
automatically displays an expanded view of the cable assembly and adds the assembly's
cables to their relevant folders in the Electrical Index. The common properties are also
changed automatically to reflect that the assembly is no longer a reference item.
When connecting the power connectors (S, T, R) of a single-core cable assembly to an item of
equipment, the software automatically completes the connection of the power connectors after
the first connection has been made to that item. For example, after connecting the S cable to
a motor the software automatically connects the remaining two power cables (T and R) to the
motor. The grounding and neutral cables are not connected automatically and are connected
by the user.
Changing the tag sequence of one of the cables in an assembly affects the tag sequence of all
of the other cables in that assembly.
Making any other change (for example, changing the sizing, routing, and so forth) in the
properties of one of the cables in an assembly that is connected to bus phases affects only
those cables in the assembly that are connected to the phases of the cable assembly.
Changing the properties of a grounding or neutral cable in an assembly affects only that
particular cable.

SmartPlant Electrical User's Guide

161

Cable Management

Add a Single-Core Cable Assembly to a Profile


This procedure explains how to include a single-core cable assembly in a profile.
1. In the Reference Data Explorer, expand the Profiles folder and select an appropriate
reference load.
2. Right-click the reference load and then click Common Properties.
3. On the General tab of the Equipment Profile Properties dialog box, under Associated
cables, click Find below the Cable assembly box.
4. On the Find dialog box, click Find Now.
5. In the Results box, select an appropriate cable assembly and then click OK.
The software displays the cable assembly you selected in the Cable assembly box and it
will add it to the current profile after clicking OK on the Equipment Profile Properties dialog box.

Create a Busway
This procedure explains how to create a new busway in the Electrical Index. A busway can be
used in a similar manner to power cable, other than the ability to perform sizing. You can define
the properties of a busway in the Properties window. Also, you can connect a power cable to a
busway if needed.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Busways.
2. Right-click the folder and click New Busway.
3. Rename the busway if you require.
4. In the Properties window, enter values for the desired busway properties.
If the parent folder contains custom folders, the created item is placed in the root folder. If
the items properties match the filter properties of a custom folder a copy of the item is also placed
in the custom folder. Refreshing or closing and re-opening SmartPlant Electrical moves the item
from the root folder to the All Items folder.

162

SmartPlant Electrical User's Guide

Cable Management

Account for the Installed Length of a Cable


This feature allows you to take into account the actual length of a cable that has been installed in
the field. You can enter appropriate values for marked length on side one and side 2 of the cable
and the software calculates the actual installed length of the cable. Alternatively, if you know the
actual installed length of a cable, you can type in the installed length value yourself.
Once the actual installed length has been entered or calculated, you set the cable definition as
installed. This action instructs the software to copy the actual installed cable length to the Actual
design/installed length on the Design Data tab of the Cable Common Properties dialog box.
If you change the installed length of a cable and increase the previous value of an installed cable,
the software makes sure that the new installed length does not exceed the capacity of the drum to
which the cable is assigned.
1. On the Cable Common Properties, dialog box, click the Design Data tab.
2. Do one of the following:
In the Installed data group box, enter the required Marked length values for one or both
sides.
The software will automatically calculate the Installed length value if you enter values for
both sides.
Under Installed length, enter the required value.
3. Select the Cable installed check box to instruct the software to define the cable as installed in
the field and to overwrite the Actual design/installed length value with the value in the
Installed length field.

The software uses the Actual design/installed length value to calculate the cable sizing and
to optimize the cable drum.
The software overwrites the Actual design/installed length value with the Installed length
value after selecting the Cable installed check box. If the new Actual design/installed
length value exceeds the capacity of the drum to which the cable is assigned, the software
displays an appropriate message and prompts you to free some space on the drum by
dissociating some of the cables from the drum.
The installed length is the absolute delta between the Marked length side 1 and Marked
length side 2 values. You do not have to enter Marked length side 1 and Marked
length side 2 values consistently. The software keeps the installed length as a positive
value at all times.

SmartPlant Electrical User's Guide

163

SECTION 11

Cable Routing
The cable routing feature allows you to set up a model of the cable routing in your plant. First, you
need to create reference cableway components. These are catalog components for which you
can specify manufacturer's data. The software allows you to specify one of three possible
categories of reference cableway components: trays, conduits, or miscellaneous. You can make
space reservations by defining cableways and segments (the physical conduits) in your plant, and
later associate the segments with reference components. Alternatively, you can specify the
reference components for the segments at the time when you create them. After you define the
cableways and segments in your plant, you can assign cables to specific routing paths, singly or in
batch mode.
The software allows you to create predefined routing paths as a way of specifying physical
relationships between cableways. Predefined cable routing contains cableway segments that
you select and whose order you specify.
You must define a segregation level for the cables you intend to route, as well as for the cableway
segments. Assignment of segregation levels allows you to specify separate groups of cables that
you would not normally route together along the same path, for example, high and low voltage
cables.
A number of reports that come shipped with the software are available to assist you in managing
your cable routing efficiently. These include:
Segment Width Estimate
Cableway Component Material Take-Off
Cableway Segment Schedule
Segment Fill
For more information, see Shipped Reports (on page 382).

Create a Cableway and Segments


This procedure explains how to create a cableway and its segments in the Electrical Index. In
order to define a routing path to which you can assign cables, you must first create cableways
and their segments. Initially, these cableways and segments can specify space reservations.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cableways.
2. Right-click the Cableways folder, and on the shortcut menu click New Cableway.
3. For each routing segment that you need to create in the cableway, right-click the cableway,
and on the shortcut menu click New Cableway Segment.
4. For each routing segment that you created, select the segment, and in the Properties
window, define the segment length and other properties.
You can select a segregation level only if you have not assigned any cables to the
segment.
5. Right-click the cableway, and on the shortcut menu, click Common Properties.
6. On the Cableway Common Properties dialog box, sort the segments in the desired
sequence by selecting segments and clicking Up or Down.

SmartPlant Electrical User's Guide

165

Cable Routing

Assign Cableway Components to Segments


After you create a cableway, use this procedure to define and edit essential cableway properties.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cableways.
2. Expand the desired cableway, and select the desired segment.
3. Right-click the segment, and on the shortcut menu, click Common Properties.
4. On the Cableway Segment Common Properties dialog box, under Reference component,
click Find.
To filter the selection for a particular reference component category, under Category,
select Tray, Conduit, or Miscellaneous before you click Find.
5. On the Find dialog box, select the desired reference component.
The software fills values for certain properties from the reference component, if available.

Define Routing for a Single Cable


This procedure explains how to define a routing path for a single cable.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables, and the
desired folder among the following: Power Cables, Control Cables, Grounding Cables, or
Instrumentation Cables.
2. Right-click the cable for which you want to define routing, and on the shortcut menu click
Common Properties.
3. In the Cable routing group box, for the first segment, select the cableway and segment from
the relevant lists.
4. For each succeeding segment, click Add, and then select the cableway and segment from the
relevant lists.

Batch Route Cables


This procedure explains how to define routing paths for cables in batch mode. Batch cable
routing is useful when you want to assign multiple cables belonging to the same segregation level
to a routing path.
The software does not verify routing compatibility of cables with varying voltage
levels; therefore you must make sure that your practices permit the cable combinations that you
define for a given routing path. If desired, you can use the Rule Manager to define criteria for the
type of cables that you allow to belong to the same segregation level.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables, and select
the desired folder (Power Cables, Control Cables, Grounding Cables, or Instrumentation
Cables).
2. In the list view pane, press CTRL while selecting the cables that you want to route.

All the cables that you select must have the same segregation level and you must define
the actual cable length (estimated length, design length, or routing length) for each cable
that you add to the routing.
When routing cables of more than one category, create a Tabular Editor view for the
desired cables and select from the view the cables that you want to route.
3. Click Actions > Cables > Batch Route Cables.

166

SmartPlant Electrical User's Guide

Cable Routing
4. On the Batch Route Cables dialog box, make sure that the Clear routing from selected
cables check box is cleared.
5. In the Cable routing group box, for the first segment, select the cableway and segment from
the relevant lists.
6. For each succeeding segment, click Add, and then select the cableway and segment from the
relevant lists.
7. In the lower data window, do one of the following:
For each cable that you want to assign to the routing path, select the check box beside the
cable tag.
To assign all of the displayed cables, select the Select all check box.
The new cable routing overwrites any existing values under Routing Path.
For a parallel cable assembly, when you define a cable routing for one of the cables, the
software automatically copies the routing to all of the cables in the assembly.

Clear Cable Routing


This procedure explains how to clear routing from selected cables.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables, and select
the desired folder (Power Cables, Control Cables, Grounding Cables, or Instrumentation
Cables).
2. In the list view pane, press CTRL while selecting the cables from which you want to clear
routing.
All the cables that you select must have the same segregation level.
3. Click Actions > Cables > Batch Route Cables.
4. On the Batch Route Cables dialog box, select Clear routing from selected cables.
5. In the lower data window, do one of the following:
For each cable from which you want to clear routing, select the check box beside the
cable tag.
To clear routing for all of the displayed cables, select the Select all check box.

Set Different Cable Routes for Parallel Cables


The following procedure describes how to set different cable routing for parallel cables.
1. In Options Manager, click General Settings > Allow the routing of parallel cables via
different routes.
2. Set this option to Yes and close Options Manager.
3. In SmartPlant Electrical, open the Common Properties of each cable in the set and define
their routing as needed.

SmartPlant Electrical User's Guide

167

Cable Routing

Select a Predefined Route for a Cable


The following procedure explains how to set the routing of a cable based on a predefined route.
1. In Electrical Index, expand the Wiring Equipment > Cables hierarchy.
2. Right-click a required cables and then click Common Properties.
3. On the Cable Common Properties dialog box, click the Design Data tab.
4. In the Cable routing box, click the Select predefined route option.
5. From the Segregation level list, select an appropriate segregation level that fits the
segregation level of the predefined route.
6. Click Find and then click Find Now.
7. Select an appropriate predefined route from the Results box and click OK.
If the application does not show any predefined routes in the Results box or if
the predefined routs are not suitable, define new routes using the Predefined Routes
command. For details, see Create a Predefined Cable Route (on page 168).

Create a Predefined Cable Route


The following procedure explains how to create a predefined cable route. You need to make these
definitions if you want to use predefined routes for your cables.
1. On the SmartPlant Electrical menu bar, click Actions > Cables > Predefined Routes.
2. On the Predefined Routes dialog box, click New.
3. On the Route Properties dialog box, define the new route as follows:
a. Under Route, type the name of the new route or accept the displayed name.
b. From the Segregation level list select an appropriate segregation level. Remember that
the segregation level of the route must match the one of the cable.
c. Type a description if needed.
d. In the Cable routing grid, click under Cableway and select an appropriate cableway.
e. Click under Segment and select an appropriate segment or segments.
f. Click OK.
4. Click Close on the Predefined Routes dialog box.

168

SmartPlant Electrical User's Guide

Cable Routing

Copy Cable Routing Definitions from Another Cable


The following procedure explains how to copy the routing of a cable from another cable.
1. In Electrical Index, expand the Wiring Equipment > Cables hierarchy.
2. Right-click a required cables and then click Common Properties.
3. On the Cable Common Properties dialog box, click the Design Data tab.
4. In the Cable routing box, select the Copy route from cable option.
5. From the Segregation level list, select an appropriate segregation level that fits the
segregation level of your cable.
6. Click Find and then click Find Now.
7. Select an appropriate cable from the Results box and click OK.
If the software cannot find an appropriate cable, it means that there are no cables
that have the same segregation level as the one that you selected in the Cable routing box..

Edit Cableway Properties


This procedure explains how to modify cableway properties, including inserting, deleting, and
moving segments.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cableways.
2. Right-click the desired cableway, and on the shortcut menu click Common Properties.
3. If desired, modify the cableway tag and description.
4. Under the Segments section, modify the segments by doing any of the following:
Click Add to insert a new segment at the end of the list.
Click Insert to insert a new segment above the currently selected segment.
Click Remove to remove the currently selected segment from the cableway.
5. Sort the segments in the desired sequence by selecting segments and clicking Up or Down.
If you have assigned cables to the segment, you cannot remove or change the sequence of
the existing segments; you can only insert new segments by clicking Add or Insert. When you
insert a new segment and define its properties, the software automatically updates the routing for
the assigned cables.

Segment Fill Validation


You can perform segment fill validation using one of the two methods, the Conventional or the
National Electric Code (NEC) method. Note that the software can calculate the fill percentage
only if the segment is associated with a reference raceway component.

Conventional Method
The Conventional method is based on the physical properties of raceway components. This
method is commonly used and it has a less restrictive approach than the NEC method. For
details on how to set the desired method (Conventional or NEC), see Set The Method For
Segment Fill Validation (on page 172).

SmartPlant Electrical User's Guide

169

Cable Routing
Tray Fill Calculation
The software calculates tray segment fill according to the following criteria:
When using the Conventional method, the segment fill calculation is based on the type of
reference tray that you select on the Reference Cableway Component Common
Properties dialog box. The following types of reference trays are available:
Covered tray segment - Applies to trays and miscellaneous cableway components. The
software calculates the total area occupied by the cables assigned to the segment. The
software validates this value by ensuring that it does not exceed the allowed area (the product
of tray width, tray depth and Fill factor), SmartPlant Electrical validates the covered tray fill
segment calculation by area. Furthermore, the software ensures that the outer cable diameter
of any cable does not exceed the tray depth. Note that for covered trays the fill factor value
cannot exceed the value of 1.
Uncovered tray segment - Applies to trays and miscellaneous cableway components. The
software calculates the sum of the outer diameters of the cables assigned to the segment.
SmartPlant Electrical validates this value by ensuring that it does not exceed the product of the
segment width, the fill factor, and the number of layers. The software validates the uncovered
tray fill segment calculation by diameter.
The segment fill calculation is based on tray width or tray area. You select the desired criterion
from the Calculation criteria list on the Cableway Segment Common Properties dialog
box. When selecting the Auto option from the Calculation criteria list, SmartPlant Electrical
calculates the segment fill automatically. The software performs the calculation according to
the type of reference tray that you selected on the Reference Cableway Component
Common Properties dialog box. Selecting the Covered check box instructs the software to
calculate the segment fill according to the Area criterion. If you do not select this check box,
SmartPlant Electrical performs the calculation according to Width.
For details on how to set the segment fill calculation criterion, see Set the Segment Fill
Calculation Criterion (on page 172).

Conduit Fill Calculation


The Conduit fill calculation applies to conduits. The software calculates the total area occupied
by the cables assigned to the segment. SmartPlant Electrical validates this value by ensuring that
it does not exceed a quarter of the allowed area of the conduits. The software calculates the
allowed area of the conduit starting from the conduit diameter and the fill factor. The minimum
allowed conduit diameter is based on the following formula:
D= 2*F*SQRT(SIGMA d**2)
Where:
D = Minimum inner conduit diameter
di = Individual cable outer diameter
f = Fill factor (between 0 and 1)

170

For conduits, the fill factor value cannot exceed the value of 1.
You need to define cable diameter and weight per unit length for each associated reference
cable by entering the desired values in the Reference Cableway Component Common
Properties dialog box.
When performing validations based on cable diameter, the software assumes that the cables
are laid side-by-side. Therefore the software does not allow for cables that can pass along the
interstices between larger cables.

SmartPlant Electrical User's Guide

Cable Routing
NEC Validation Method
The NEC method is based on given space factors. Unlike the Conventional tray segment
validations, the NEC method does not allow flexibility like the Conventional method regarding tray
segment fill validation. NEC dictates the fill requirements for various cases of installations, such
as cable formations, cable sizes, insulation voltages and tray widths. The calculation applies to
the cables routed on the segment as part of the routing. Note that the Fill factor values can only
be between 0 and 1, as defined by the NEC code. The software takes into account the fill factor
that you specify and the maximum weight per length unit allowed on tray. If any of the actual fill
values exceed the allowed values, the software rejects them from being routed and displays a
warning message on the Cableway Segment Common Properties box.

The tray fill calculation flowchart is available in the SmartPlant Electrical installation folder in
the following path:
Program Files\SmartPlant\Electrical\Program\resdlls\0009\TrayFillCalcsFlowchart_SPEL.pdf
The Flexible tray type check box is not available When NEC validation is set to Yes.

Conduit Fill Factor


When using the NEC validation method in a conduit, the software sets the fill factor according to
the number of cables in the conduit:
If the number of cables in a conduit = 1, the fill factor = 0.53
If the number of cables in a conduit = 2, the fill factor = 0.31
If the number of cables in a conduit > 2, the fill factor = 0.4
You cannot modify these additional fill factors.
The NEC rules for tray segment fill validation are based on the following primary parameters and
their various combinations:
The insulation voltage rating of the cable that it is carrying. The NEC method divides the
voltage into two groups, above 2000v and 2000v, and below.
Cables arrangement (single core or multi core). The code does not address a combination of
these cable categories, therefore SmartPlant Electrical does not support such a combination.
A combination of power and non-power carrying cables (instrumentation, control, grounding).
Type of tray on which cables are laid; whether it is Ladder, Ventilated trough, Solid bottom
tray, Ventilated channel, Solid channel.
Conductor sizes
Tray dimensions
For each of the possible combinations of the above mentioned parameters, NEC method specifies
(NEC 2005 handbook) one or more of the following criteria:
The allowable number of layers
The allowable fill area
The allowable tray width percentage
All the limiting numbers of the allowable width and cross sectional areas are automatically set in
SmartPlant Electrical and cannot be changed.
SmartPlant Electrical generates a NEC tray fill validation log file that documents tray
validations. For details on how to generate a log file, see Generate Error Log Files (on page
34). In the generated log file you can view the properties of the specific tray fill validation, such as
- Item type, date of validation, Layout ID, and more. The NEC tray fill validation log file is based on
SmartPlant Electrical Tray Fill Calculation Logic, which is based on: NFPA 70 National Electrical
Code 2005 Edition.
For more details see, NEC tables refer to article 392, section 9 and 10 in the NEC 2005 Edition.

SmartPlant Electrical User's Guide

171

Cable Routing

Set the Method for Segment Fill Validation


This procedure describes how to set a method for segment fill validation. You can select one of the
two methods, the Conventional or the NEC (National Electric Code) method.
1. Open the Option Manager.
2. Click Options > General Settings.
3. On the General Settings dialog box, in the Cable fill validation to follow NEC regulations
pane, select from the list one of the following:
Select No (default) if you want to apply the Conventional method.
Select Yes if you want to apply the NEC (National Electric Code) method.
4. Click

to save.

Set the Segment Fill Calculation Criterion


This procedure explains how to set the segment fill calculation criterion for segment fill
validation. Note that when using the NEC validation method, the Calculation criteria list is not
available.
1. In the Option Manager, set the segment fill validation to Conventional, for more details see
Set The Method For Segment Fill Validation (on page 172).
2. In SmartPlant Electrical, on the Electrical Index tree-view, expand the Wiring Equipment
folder.
3. Expand the Cableways folder and select the desired cableway or create a new cableway and
segments, for details see Create a Cableway and Segments (on page 165).
4. Right click a desired segment, on the shortcut menu, click Common Properties.
5. On the Cableway Segment Common Properties dialog box, from the Calculation criteria
list, select the desired calculation criterion (Auto, Area, or Width).
Auto When selecting the Auto option, the calculation is preformed automatically
according to the type of reference tray that you selected on the Reference Cableway
Component Common Properties dialog box.
Area The software calculates the segment fill by area.
Width The software calculates the segment fill by width.

172

SmartPlant Electrical User's Guide

SECTION 12

Cable Drums
SmartPlant Electrical provides for the management of cable drums. You can create cable drums
and assign one or more cables to a cable drum. The cable drum assignment feature helps you
plan cabling tasks and optimize cable drum use. It also allows you to determine cable lengths so
that you can purchase cables while minimizing a shortage or surplus of cable at the end of the
project.
Before you begin, make sure that you have defined cable pulling areas in the Data
Dictionary Manager. For more information, see Data Dictionary Manager Online Help.
You can assign cables to drums manually or automatically.

Manual Assignment
When assigning cables to drums manually, you associate a drum with a specific reference cable.
You can define multiple drum sizes for each reference cable. These drum sizes are based on
various cable lengths that a drum can hold. Once you associate a drum with a reference cable that
has multiple drum sizes, you can select the most appropriate drum size for a particular drum. For
details, see Create a Cable Drum (on page 174).

Automatic Assignment
When assigning project cables to drums automatically, the software optimizes the cable
assignment. SmartPlant Electrical optimizes this assignment based on the drum sizes, the
maximum percentage of free cable length on the drums and the scrap cable length that you have
defined for each reference cable that you select for drum assignment. For more details, see
Optimization of Cable Drum Assignment.
You perform automatic cable assignment by using the Assign Drums to Cables wizard. When
using the wizard, you define the assignment parameters by selecting the following:
All the available reference cables or just one specific reference cable.
One or more pulling area.
The wizard will then assign all the project cables that comply with these parameters. Furthermore,
the software will optimize cable assignment to the drums based on the drum sizes, the maximum
percentage of free cable lengths on the drums, and the scrap cable length that you have defined
for each reference cable that you selected in the wizard. For details, see Batch Assign Cables to
Cable Drums (on page 177).
Although the order may vary, the following activities are essential elements in cable drum
assignment for a given pulling area:
Create reference cables and define sets of cable lengths so that you can optimize cable
assignment to drums.
Create project cables based on the reference cables.
Create cable drums for all of the reference cables used in the pulling area.
Assign all of the project cables in the pulling area to cable drums.
For detailed information about the logic used by SmartPlant Electrical to optimize cable drum
assignment, see Optimization of Cable Drum Assignment.

SmartPlant Electrical User's Guide

173

Cable Drums

Create a Cable Drum


This procedure explains how to create a new cable drum in the Electrical Index. In order to
assign cables to cable drums in your project, you must first create cable drums and associate
them with a reference cable in your project.
Prior to creating new drums, it is crucial that you define appropriate reference cables
that contain drumming data. You need to define the drum types that you require. These drum
types are based on various sets of minimum and maximum cable lengths. When associating a
drum with a reference cable, these sets of cable lengths become available for drum optimization.
For details, see Design Data Tab (Reference Cable Common Properties Dialog Box) (on page
772).
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Drums.
2. Right-click the Drums folder, and on the shortcut menu click New Drum.
3. Right-click the drum that you created, and on the shortcut menu click Common Properties.
4. On the Cable Drum Common Properties dialog box, under Drum Tag, edit the tag name as
necessary.
5. To set the required drum reference cable, beside Reference cable click
to open the
Select Reference Cable dialog box.
6. On the Select Reference Cable dialog box, select an appropriate reference cable.
Make sure that there are appropriate plant cables based on the selected reference cable
and that each of these cables has been assigned to at least one pulling area.
7. In the Drum sizes group box click Select to open the Drum types per cable length dialog
box.
8. Select an appropriate set of cable lengths and click OK.

The sets of cable lengths that are available on the Drum Sizes dialog box are taken from
the Design Data tab of the reference cable that has been set for the current drum. The
Minimum and Maximum values pertain to the Minimum cable length to order and
Maximum drum capacity values that are on the Cable Drum Common Properties
dialog box.
You can add new Minimum and Maximum values and change the existing Minimum
and Maximum values even after assigning plant cables to a drum.
Note that the drums that have the procurement status set to Ordered or Delivered are not
affected by the change that you make.
When changing the Minimum and Maximum values, the software validates that the new
values that you enter are within the range of the cable length definitions according to the
following:
If the Total cable length to order/delivered has been set, the Minimum cable
length to order cannot be greater than the Total cable length to order/delivered
value.
If the Total cable length to order/delivered has not been set, the Minimum cable
length to order can be greater than the Total cable length on the drum value.
9. Enter values for the other cable drum properties. For details, see Cable Drum Common
Properties Dialog Box (on page 639).
For calculation details, see Rules Governing Cable Drum Calculations (on page 181).

174

SmartPlant Electrical User's Guide

Cable Drums

Edit Cable Drum Properties


After you create a cable drum, use this procedure to select a drum reference cable, and to define
and edit other cable drum properties.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Drums.
2. Right-click the Drums folder, and on the shortcut menu click New Drum.
3. Right-click the drum that you created, and on the shortcut menu click Common Properties.
4. On the Cable Drum Common Properties dialog box, under Drum Tag, edit the tag name as
necessary.
5. To set the required drum reference cable, beside Reference cable click
.
6. On the Select Reference Cable dialog box, select the desired reference cable.
7. In the Drum types per cable length group box click Select to open the Drum types per
cable length dialog box.
8. Select an appropriate set of cable lengths and click OK.
The sets of cable lengths that are available on the Drum types per cable length dialog
box are taken from the Design Data tab of the reference cable that has been set for the
current drum.
9. Enter values for the other cable drum properties. For details, see Cable Drum Common
Properties Dialog Box (on page 639).

You cannot change the drum reference cable when cables are assigned to the drum.
You cannot delete a drum if a cable has been assigned to that drum.
For calculation details, see Rules Governing Cable Drum Calculations (on page 181).

Assign Multiple Cables to a Cable Drum


This procedure explains how to assign one or more cables to a cable drum that you created in the
Electrical Index, and for which you set a reference cable.
1. Open the Cable Drum Common Properties dialog box for the cable drum to which you want
to assign cables, and edit the values as needed. For details, see Edit Cable Drum Properties
(on page 175).
2. To set the required drum reference cable, beside Reference cable click
to open the
Select Reference Cable dialog box.
3. On the Select Reference Cable dialog box, select an appropriate reference cable.
Make sure that there are appropriate plant cables based on the selected reference cable
and that each of these cables has been assigned to at least one pulling area.
4. In the Drum sizes group box click Select to open the Drum types per cable length dialog
box.

SmartPlant Electrical User's Guide

175

Cable Drums
5. Select an appropriate set of cable lengths and click OK.

The sets of cable lengths that are available on the Drum Sizes dialog box are taken from
the Design Data tab of the reference cable that has been set for the current drum. The
Minimum and Maximum values pertain to the Minimum cable length to order and
Maximum drum capacity values that are on the Cable Drum Common Properties
dialog box.
You can add new Minimum and Maximum values and change the existing Minimum
and Maximum values even after assigning plant cables to a drum.
Note that the drums that have the procurement status set to Ordered or Delivered are not
affected by the change that you make.
When changing the Minimum and Maximum values, the software validates that the new
values that you enter are within the range of the cable length definitions according to the
following:
If the Total cable length to order/delivered has been set, the Minimum cable
length to order cannot be greater than the Total cable length to order/delivered
value.
If the Total cable length to order/delivered has not been set, the Minimum cable
length to order can be greater than the Total cable length on the drum value.
6. Define at least one pulling area by doing one of the following:
a. To set a single pulling area, select a value from the Pulling area list.

When clicking Add in the Assigned cables group box, the software will look only for
those cables that are associated with the pulling area that you select from this list.
Make sure that the Allow multiple pulling areas check box is not selected.
a. To set multiple pulling area, select the Allow multiple pulling areas check box.
When clicking Add in the Assigned cables group box, this option instructs the software
to look for all the cables that are associated with the current reference cable.
7. Click Add in the Assigned cables data window.
8. On the Find dialog box, click Find Now.
9. In the Results data window, select the cables that you want to assign to the current drum, and
click OK.

You can assign to a particular drum only those cables that are associated with a designated
reference cable and only those cables that belong to one or more pulling areas assigned to the
drum.
For calculation details, see Rules Governing Cable Drum Calculations (on page 181).

Assign a Single Cable to a Cable Drum


This procedure explains how to assign a cable that you are editing to a given cable drum.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Expand the desired folder among the following: Power Cables, Control Cables, Grounding
Cables, or Instrumentation Cables.
3. Right-click the cable that you want to assign, and on the shortcut menu click Common
Properties.

176

SmartPlant Electrical User's Guide

Cable Drums
4. On the Cable Common Properties dialog box, click the Design Data tab.
5. In the Drum Assignment group box, click Find.
The software finds only those cable drums that have been associated with the
same reference cable and pulling area as the current cable.
6. On the Find dialog box, click Find Now.
7. In the Results data window, select the cable drum to which you want to assign the cable, and
click OK.

If a cable exceeds the maximum cable drum capacity, the software automatically defines the
required cable splices for that cable. You can view the specified lengths of the cable cuts on
the Design Data tab of the Cable Common Properties dialog box. Click View in the Drum
assignment group box.
For calculation details, see Rules Governing Cable Drum Calculations (on page 181).

Batch Assign Cables to Cable Drums


This procedure explains how to assign cables to multiple cable drums automatically using the
Assign Drums to Cables Wizard. When assigning project cables to drums automatically, the
software optimizes the cable assignment. SmartPlant Electrical optimizes this assignment based
on the drum sizes, the maximum percentage of free cable length on the drums and the scrap cable
length that you have defined for each reference cable that you select for drum assignment. For
more details, see Optimization of Cable Drum Assignment.
You perform automatic cable assignment by using the Assign Drums to Cables wizard. When
using the wizard, you define the assignment parameters by selecting the following:
All the available reference cables or just one specific reference cable.
One or more pulling area.
The wizard will then assign all the project cables that comply with these parameters. Furthermore,
the software will optimize cable assignment to the drums based on the drum sizes, the maximum
percentage of free cable lengths on the drums, and the scrap cable length that you have defined
for each reference cable that you selected in the wizard.
1. Click Actions > Cables > Assign Drums to Cables Wizard to open the Assign Drums to
Cables Wizard.
2. On the Welcome page, click Next.
3. On the Drum and Cable Options page, select the check boxes as you require for the
following options:
Include cables already assigned to drums.
Create new drums if needed.
Delete empty drums.
4. Do one of the following:

Select a single reference cable - beside Reference cable, click


Reference Cable dialog box (on page 650).
Select the Select all reference cables check box.
5. Do one of the following:
From the Pulling area list, select a single pulling area.
Select the Select all pulling areas check box.
6. Click Next.

SmartPlant Electrical User's Guide

, to open the Select

177

Cable Drums
7. On the Select Cables page, do one of the following:
For each available cable that you want to assign to a drum, select the Select check box
beside the cable tag.
To select all of the cables that are available for assignment, select the Select all check
box.

You can specify the order of the cables that have not been assigned yet and organize
these cables either in a descending or alternate order. You set the sorting method on the
General page in Options Manager. If you select the Descending method, the software
sorts the cables starting with the longest cable and then goes down to the shortest one. If
you select the Alternate method, the software starts with the longest cable, then with the
shortest, then with the second longest and then back to the shortest again, and so on.

8.
9.
10.
11.

You can click the icon at the top right of the page
to display the page in full-screen
mode. You must click the icon again to restore the page to normal view before you can
proceed to the next step.
You cannot select cables for which pulling area or cable length values are missing. To
update the cable data, highlight the cable and click Common Properties.
If you select any cables that have restricted access rights, the software does not assign
them to drums, and the names of those cables appear in the error log.
Click Next.
On the Drum - Cable Assignment Summary page, view the details of the cables you have
selected to assign to cable drums.
Click Next.
On the Completing the Assign Drums to Cables Wizard page, view summary data for the
cable - drum assignment and click Finish to close the wizard.

If a cable exceeds the maximum cable drum capacity, the software automatically defines
the required cable splices for that cable. The Assign Drums to Cables Wizard specifies the
lengths of the cable cuts on the Completing the Assign Drums to Cables Wizard page.

Optimization of Cable Drum Assignment


This topic describes how the software optimizes the assignment of cables to drums. When using
the Assign Drums to Cables wizard, SmartPlant Electrical optimizes the cable assignment to
drums. The optimization process of the software determines the composition of the selected
cables on a given drum in such a way so that the drum capacity is utilized to the maximum. The
software looks for the best composition of cables according to the following:
The various drum sizes available for each reference cable.
The maximum free total length defined in the reference cable.
The list of cables sorted by length.
During the optimization process, the software also takes into account the options that you select in
the Assign Drums to Cables wizard, such as the selected pulling areas, reassigning of assigned
cables, using existing cable drums, creating new cable drums if required, and deleting unused
drums.
The optimization mechanism consists of three main stages which are totally transparent to
SmartPlant Electrical users.

178

SmartPlant Electrical User's Guide

Cable Drums
Collecting the Cable Drum and Cable Data for Drum Assignment
During this stage, the software collects all the available drums and the cables for the assignment
process. The software considers all the existing drums in the current plant and the cables that you
select in the Assign Drums to Cables wizard.
Drums Included in the Optimization Process
The software checks all the available drums and looks for those drums that comply with the
following requirements:
All the drums that have been associated with the pulling areas that you select in the Assign
Drums to Cables wizard.
Drums for which the procurement status is set to Ordered or Delivered. If the procurement
status is not defined, the software uses the Maximum drum capacity values of such drums in
the optimization process.
Drums for which the Total cable length to order/delivered value is defined. If this value is
not defined, the software uses the Maximum drum capacity values of such drums in the
optimization process.
As SmartPlant Electrical collects the cable drum data, it lists all the suitable drums in a virtual list
which is sorted according to the total free space that is available on the drums, starting with those
drums that have the most available free space to the least available free space.
Cable drums that are defined as spare and cable drums that are associated with multiple
pulling areas are not included in the optimization process by SmartPlant Electrical.
Cables Included in the Optimization Process
SmartPlant Electrical includes the following cables in the optimization process:
All the cables that you select in the Assign Drums to Cables wizard and which have not yet
been assigned to any drums.
If you select the Include assigned cables option in the Assign Drums to Cables wizard, the
software includes all the cables that already have been assigned to cable drums and which
you select in the Assign Drums to Cables wizard.
Cables that have been defined as installed or locked, remain assigned to their
original drums and are not re-assigned to other drums during the optimization process.
As SmartPlant Electrical collects the cable data, it lists all cables in a virtual list which is sorted in
descending or alternate order. The optimization process is based on the sorting order that you
define in Options Manager.

Assigning the Cables to the Drums


At this stage, SmartPlant Electrical tries to assign the cables from the virtual cable list to the
collected drums that already exist in the current plant. The assignment process is based on the
following:
The software starts with the first cable on the virtual cable list which is sorted in ascending or
descending order and tries to fit this cable to a drum.
The software checks the free space of the existing drums that have been collected for the
drum assignment.
The software first considers the drum that has the most free space and then moves on to the
next drum.
The software assigns the cables to the existing drums by filling the drums to the maximum of
their capacity or up to the total cable length of a cable that has been defined as ordered (from
a supplier).
Once a cable is assigned to a drum, the software removes this cable from the virtual
assignment list.

SmartPlant Electrical User's Guide

179

Cable Drums

If a particular cable cannot be assigned to a drum at this stage, the software puts it aside and
this cable will be assigned at a later stage.
The software tries to reduce the maximum capacity of the existing drums that have not been
defined as ordered or delivered and those drums whose Total cable length to
order/delivered value is not defined.
At this stage no new drums are created yet. This will be done during the next stage if you
select the Create new drums option in the Assign Drums to Cables wizard.
If a cable is longer than the Maximum free length on drum value that was set for that drum,
the software tries to increase the maximum capacity of that drum according to the available
drum sizes defined for the associated reference cable.
If the software still cannot assign another cable to a drum even after increasing the maximum
capacity of the drum, that cable remains unassigned.
If a cable is longer than the drum maximum capacity and if you selected the Create new
drums option in the Assign Drums to Cables wizard, the software automatically creates the
cable cuts that are required for that cable. The software specifies the length of each cable cut
and assigns it to a different drum as needed. Note that these cable cuts are virtual cuts. The
entire cable will be shown in all the pertinent reports and cable schedules and not the
individual cable cuts.

Optimizing the Drum Assignment


During the optimization stage, the software continues to assign the remaining cables to the
existing drums and to the new drums that it creates. If you select the Create new drums option in
the Assign Drums to Cables wizard, the software creates new drums for the cables that have not
been assigned yet. Also, the software uses the existing drums that have been emptied from the
cables that have been re-assigned to other drums during the assignment stage. If you do not
select the Create new drums option, the cables that do not fit on the existing drums will remain
unassigned.
The software will try to use all the drums for the assignment until a drum becomes "optimized". A
drum is considered "optimized" if:
It has been filled to its maximum capacity.
Its free length is less than or equal to the Maximum free length on drum (%) value that has
been set for the associated reference cable.
The assignment process continues as follows:
The software picks the first cable from the top of the cable list and looks for a drum that has the
largest remaining available capacity on that drum. If the software cannot find a suitable drum
for this cable, it will create a new drum.
When creating new drums, the software uses the values from the Drum sizes list and the
Maximum free length on drum (%) values that are defined for the associated reference
cable.
If a particular drum has not been filled to its optimum, the software retains the assigned cable
composition on that drum and then starts checking if a smaller drum based on the Drum sizes
list can be created and a suitable cable composition can be found for this drum.
If the software finds a suitable cable composition for the new drum that will deem this drum as
"optimized", the software creates this drum and assigns this cable composition to this new
drum.
If the software cannot optimize a particular drum, the best suited cable composition is
assigned to this drum in such a way that the Maximum free length on drum (%) value for that
drum is kept as low as possible.
The software continues assigning the remaining cables to the new drums according to the
same method.

180

SmartPlant Electrical User's Guide

Cable Drums

The software stops looking for the best cable composition for drums when:
A particular cable composition fills the drum to the optimum.
There are no more available drum sizes left in the Drum sizes list of the associated
reference cable.
The next available drum size is shorter than the longest cable in the current cable
composition.
If the Maximum free length on drum (%) value has not been defined for the associated
reference cable, the software tries to find the most suitable cable composition during every
cycle of the cable assignment.
At the end of the process, the software deletes the empty drums if you select the Delete
empty drums option in the Assign Drums to Cables wizard.

Batch Cable Dissociation from Drums


This option allows you to select a number of cable drums and dissociate them from the assigned
cables. This can be useful, for example, when after assigning all cables to drums, you need to
change the length of a cableway or segment.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Drums.
2. Select the drums that you require in the Item Tag pane.
3. Do one of the following:
a. On the main toolbar, click Action > Cables > Batch Cable Dissociation from Drums.
b. Right-click the selected drums and then on the shortcut menu, click Batch Cable
Dissociation from Drums.
4. In the dissociation prompt, click Yes to confirm the dissociation.

Rules Governing Cable Drum Calculations


When you assign cables to cable drums, there are specific rules that govern how the software
determines whether it is possible for you to assign a given cable to a drum. These rules apply
whether you make the assignment from the Cable Drum Common Properties dialog box or from
the Cable Common Properties dialog box.
The following rules apply:
For each cable, SmartPlant Electrical uses the Actual length value.
The value under Total actual length assigned is the sum of the actual lengths of all the
assigned cables.
If assigning a given cable would cause the Total actual length assigned value to be greater
than the value that you set under Maximum cable length, the software does not allow the
cable assignment.
You can make allowance for cable cutting error by entering a value under Drum spare
percent. The software includes this percentage in the Total actual length assigned value.

SmartPlant Electrical User's Guide

181

Cable Drums

Cancel Cable Assignment to a Cable Drum


This procedure explains how to remove cables that are assigned to a drum.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Drums.
2. Right-click the cable drum from which you want to remove cables, and on the shortcut menu
click Common Properties.
3. In the Assigned cables data window, select the desired cable and click Remove.
You can also cancel the assignment of a cable to a cable drum on the Design Data tab of
the Cable Common Properties dialog box.

182

SmartPlant Electrical User's Guide

SECTION 13

Associating Equipment
This section deals with the association of electrical equipment. There are several ways that you
can make electrical associations. The particular method that you choose depends on your
workflow and specific requirements.

In This Section
Electrical Engineer ......................................................................... 183
Create an Electrical Association .................................................... 186
Change an Existing Electrical Association .................................... 191
Dissociate an Item from Its Feeding Item ...................................... 193
Associate Electrical Equipment with Feeders................................ 194
Automatic Creation of Feeder Circuits ........................................... 195
Associate Bus Riser Circuits with Coupler Circuits ....................... 196
Associate a Control Station with an Electrical Item ....................... 196
Associate a Control Station with Cables ........................................ 197
Associate Cables of Control Stations with Equipment Circuits ..... 197
Associate Cables of Instruments with Equipment Circuits ............ 197
Associate a Power Cable with Electrical Equipment ..................... 198
Associate Additional Power Cables with Electrical Equipment ..... 198
Associate a Non-Power Cable with Electrical Equipment ............. 199
Define Parallel Equipment ............................................................. 200
Create a Daisy-Chain Connection Pattern .................................... 202
Move Disconnect Equipment into Circuit ....................................... 203
Move Disconnect Equipment out of Circuit .................................... 203

Electrical Engineer
You use the Electrical Engineer to create and manage electrical associations among equipment
in your plant. You can make new electrical associations or change the existing ones. You can
create electrical associations by dragging items from the Electrical Index to an appropriate place
in the electrical tree of the Electrical Engineer window. For the rules that govern electrical
associations, see Rules for Associating Electrical Equipment (on page 187).
To change an electrical association, drag an item in the Electrical Engineer to another place in
the electrical tree. For more details, see Change an Existing Electrical Association (on page 191)
and Rules for Changing Electrical Associations (on page 192).
The software synchronizes any new electrical relationships that you create in the Electrical
Engineer with the Electrical Index. When creating a new item in the Electrical Index, the
software also adds this item in the Electrical Engineer if appropriate (some items do not appear
the Electrical Engineer).
The Electrical Engineer allows you to generate and display single line diagrams
(SLDs) that show the electrical network distribution powered from an item selected in the
Electrical Engineer.

SmartPlant Electrical User's Guide

183

Associating Equipment
Display Rules
The Electrical Engineer displays electrical items based on their electrical
relationship. Therefore, a power source, for example, is always on a higher hierarchical level
than a load. The Electrical Engineer also shows every item that has an electrical connection with
a selected item. The following rules define which electrical items appear in the Electrical
Engineer:
The Electrical Engineer displays all electrical items that have at least one electrical
association.
Certain items appear automatically in the Electrical Engineer after you create them in the
Electrical Index. These items appear in the Electrical Engineer even if they do not have
any electrical association. These items are generators, buses, circuits, battery banks, battery
chargers, UPSs, and transformers.
The Electrical Engineer automatically displays power cables that the software creates when
you create a load or when you activate the Apply Option command to automatically associate
that load with a feeder.
For a multiple cable assembly, you can hide or display the individual cables by right- clicking
the icon
, and on the shortcut menu, clicking Show Multiple Cables. The software
indicates the display toggle state by a check mark.
Items that have no hierarchical parents appear at the root of the Electrical Engineer provided
that they feed other items.
For equipment items that are connected in parallel, the software uses a special indicator next
to the equipment items that are connected in parallel.
The indicator is
. For example
.
Certain items do not appear in the Electrical Engineer. These items are power distribution
boards, cells, control stations, and their cables. Only the items that are included in single line
diagrams or power distribution networks appear in the Electrical Engineer except for circuit
components that do not appear in the Electrical Engineer at all.
You can display item tags of buses, bus risers, and incomers together with the item tags of the
associated power distribution boards if you set your general preferences accordingly.
The Electrical Engineer window contains the following sections:
Toolbar
Tree view pane
These sections are described below:

Toolbar
The toolbar contains the following options:
Find Click Find
to open the Find dialog box where you can look for a specific item in the
Electrical Engineer. Click the arrow to display a menu with the following options:
Find Opens the Find dialog box where you can look for a specific item in the Electrical
Engineer.
Find in Electrical Index Searches the Electrical Index for the item that is currently
selected in the Electrical Engineer. Note that both the Electrical Engineer and the
Electrical Index have to be open if you want to use this feature.
Close Closes the active Electrical Engineer window.
Refresh Click Refresh
to update the Electrical Engineer display. This feature is useful
where multiple users are working on the same set of data.

184

SmartPlant Electrical User's Guide

Associating Equipment
Buttons Buttons provide a useful shortcut to an item or a group of items. Click Buttons
to toggle show / hide for existing buttons. To create a button for the currently selected item or
folder, click the arrow and click Add Button. To remove a button, select the button to remove,
then click the arrow, and click Remove Button. Note that if you do not select any button to
remove, the software removes the uppermost button in the list.

Tree View Pane


The tree view pane of the Electrical Engineer shows electrical items organized in the Plant
folder. You cannot move, delete, or rename this folder, nor can you add new folders. Each item
contained in the Plant folder contains other items that are associated with it electrically. The
options available on the menus depend on the currently selected item type.
Expand or collapse the hierarchy by clicking the + and - icons respectively or by clicking an item in
the Plant folder hierarchy.
After fully expanding a hierarchy, double-click an item to open its Common Properties dialog
box.

You can open several instances of the Electrical Engineer by clicking Window > New >
Electrical Engineer.
You can right-click any item in the Electrical Index to find it in the Electrical Engineer or click
an item in the Electrical Engineer to find it in the Electrical Index. Both the Electrical
Engineer and Electrical Index have to be open if you want to use this feature.
You can right-click any item in the Electrical Engineer and then click Expand All Sub-Items
on the shortcut menu to display all the existing child items of the selected items. After clicking
this option a second time, click Refresh to expand the items in the Electrical Engineer tree
view.
You can filter the display of the Electrical Engineer and show only the selected branches of
the network structure by clicking Show Only on the View menu.
To display all the existing data in the Electrical Engineer, close the Electrical Engineer and
open a new session by clicking
on the main toolbar.
Also, you can display the selected branches of the network structure in a new Electrical
Engineer window by clicking Show in New Window on the View menu.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

Find Other Parent Items in the Electrical Engineer


This option allows you to find all other parent items that are associated with a selected item on a
higher hierarchy level in the Electrical Engineer. For example, you can select a bus and find all
other incomers that are associated with this bus.
1. In the Electrical Engineer, navigate to the desired item.
2. Right-click the item and click Find Other Parent Items.
3. On the Find dialog box, in the Results data window, select an item and then click Apply.

The software highlights the parent item in the Electrical Engineer. You can repeat the
procedure to find another parent item.
To select a single item and close the Find dialog box, click OK.

SmartPlant Electrical User's Guide

185

Associating Equipment

Show Related Items in a New Electrical Engineer Window


SmartPlant Electrical allows you to select an item in the Electrical Index or Electrical Engineer
and show all the items that are related to the selected item in a new window. For example, if you
select a motor, the software displays the associated control station and feeder circuits grouped
together in a new window. This way you do not need to search for associated items and save
time when wiring your project items.
1. In the Electrical Index or Electrical Engineer right-click an item.
On the shortcut menu, click Show Related Items in a New Window.

Create an Electrical Association


You can make an electrical association by doing one of the following:
Drag an item from the Electrical Index to an appropriate place in the electrical tree of the
Electrical Engineer.
In a cable block diagram, connect two items using a cable or a connector. For details, see
Working with Smart Data and Auxiliary Graphics in a CBD (on page 320).
Note that electrical associations are governed by a strict set of rules. For details, see Rules for
Associating Electrical Equipment (on page 187).
The following procedure explains how to make electrical associations among equipment by
dragging items from the Electrical Index to the Electrical Engineer.
The software does not allow you to make parallel connections or change existing
parallel connections of cables in the Electrical Engineer. Parallel cable connections or changes
of parallel associations can be carried out only in cable block diagrams.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icon or by doubleclicking the parent folder.
2. Highlight the item that you want to associate.
3. In the Electrical Engineer, expand the item hierarchy where you want to make the new
association. Click the + icon or click the relevant item.
4. Drag the highlighted item from Electrical Index to the Electrical Engineer and drop it onto
the desired target item.

186

There are specific rules that govern electrical associations. These rules determine electrical
associations of items in the Electrical Engineer. For more information, see Rules for
Associating Electrical Equipment (on page 187).
You also can make electrical associations in a cable block diagram. For details, see Place and
Connect Items in a Cable Block Diagram (on page 324).

SmartPlant Electrical User's Guide

Associating Equipment

Rules for Associating Electrical Equipment


You can make an electrical association by doing one of the following:
Drag an item from the Electrical Index to an appropriate place in the electrical tree of the
Electrical Engineer.
In a cable block diagram, connect two items using a cable or a connector. For details, see
Working with Smart Data and Auxiliary Graphics in a CBD (on page 320).
Note that electrical associations are governed by a strict set of rules. You can associate electrical
items according to the rules that are specified in the following table:
Source Item in
Electrical Index

Target Item in
Result
Electrical Engineer

Cables

Generators

The source item


The source item has no
becomes the child item parent item in the
of the target generator in Electrical Engineer.
the Electrical Engineer.

Cables

Battery banks

The source item


becomes the child item
of the target battery bank
in the Electrical
Engineer.

The source item becomes


the child item of the target
battery bank in the
Electrical Engineer.

Cables

UPSs

The source item


becomes the child item
of the target UPS in the
Electrical Engineer.

The source item has no


parent item in the
Electrical Engineer.

Cables

Capacitors

The source item


The source item has no
becomes the child item parent item in the
of the target capacitor in Electrical Engineer.
the Electrical Engineer.

Cables

Secondary
The source item
The source item has no
transformer windings becomes the child item parent item in the
of the target secondary Electrical Engineer.
transformer winding in
the Electrical
Engineer. The dragged
item inherits all the target
transformer relations.

Cables

Battery chargers

SmartPlant Electrical User's Guide

Preconditions

The source item


The source item has no
becomes the child item parent item in the
Electrical Engineer.
of the target battery
charger in the Electrical
Engineer.

187

Associating Equipment
Source Item in
Electrical Index

Target Item in
Result
Electrical Engineer

Cables

Variable frequency
drives (VFDs)

The source item


The source item does not
becomes the child item have a parent cable in the
of the target VFD in the Electrical Engineer.
Electrical
Engineer. The dragged
item inherits all the target
VFD relations.

Cables

Panel-circuits

The source item


The source cable has no
becomes the child item parent items.
of the target panel-circuit
in the Electrical
Engineer. The dragged
item inherits all the target
panel-circuit relations.

Cables

Junction boxes, local The source cable


panels
becomes the child item
of the target item in the
Electrical
Engineer. The dragged
cable inherits all the
target junction box or
local panel relations.

Cables (non- parallel


power cables)

Miscellaneous
electrical equipment

Motors, heaters,
Generators
resistors, capacitors,
harmonic filters,
battery banks, heat
traces, UPSs, primary
transformer windings,
battery chargers,
miscellaneous
electrical equipment,
other converting
equipment, disconnect
electrical equipment,
auxiliary contacts

188

Preconditions

The source item has no


parent items. The target
item has no child items in
the Electrical Engineer.

The source cable


becomes the child item
of the target
miscellaneous electrical
equipment item in the
Electrical
Engineer. The dragged
cable inherits all the
target miscellaneous
electrical equipment item
relations.
The source item
becomes the child item
of the target generator in
the Electrical Engineer.

The source item has a


parent cable in the
Electrical Engineer and
that cable has no
electrical parent item.

SmartPlant Electrical User's Guide

Associating Equipment
Source Item in
Electrical Index

Target Item in
Result
Electrical Engineer

Preconditions

Motors, heaters,
resistors, harmonic
filters, heat trace,
UPSs, miscellaneous
electrical equipment,
disconnect electrical
equipment, auxiliary
contacts

Battery banks

The source parent cable


becomes the child item
of the target battery bank
in the Electrical
Engineer.

The source item has a


parent cable in the
Electrical Engineer and
that cable has no
electrical parent item.

The source parent cable


becomes the child item
of the target UPS in the
Electrical Engineer.

The source item has a


parent cable in the
Electrical Engineer and
that cable has no
electrical parent item.

Resistors, capacitors,
harmonic filters, heat
traces, UPSs, battery
charger, VFDs,
miscellaneous
electrical equipment,
disconnect electrical
equipment, auxiliary
contacts

Secondary
The source item
transformer windings becomes the child item
of the target secondary
transformer winding in
the Electrical
Engineer. The dragged
item inherits all the target
transformer relations.

The source item has a


parent cable in the
Electrical Engineer and
the target transformer is
associated with a circuit.

Capacitors, harmonic
filters, battery banks,
disconnect electrical
equipment

Battery chargers

The source parent cable


becomes the child item
of the target battery
charger in the Electrical
Engineer.

The source item has a


parent cable and the
parent cable has no
parent item in the
Electrical Engineer.

The source parent cable


becomes the child item
of the target VFD in the
Electrical
Engineer. The dragged
item inherits all the target
VFD relations.

The source item has a


parent cable and the
parent cable has no
parent item in the
Electrical Engineer.

Motors, heaters,
UPSs
resistors, harmonic
filters, battery banks,
heat traces, variable
frequency drives
(VFDs), miscellaneous
electrical equipment,
disconnect electrical
equipment, auxiliary
contacts

Motors, heaters,
VFDs
capacitors, harmonic
filters, transformer
windings,
miscellaneous
electrical equipment,
other converting
equipment, disconnect
electrical equipment,
auxiliary contacts

SmartPlant Electrical User's Guide

189

Associating Equipment
Source Item in
Electrical Index

190

Target Item in
Result
Electrical Engineer

Preconditions

Motors, heaters,
Circuits
resistors, capacitors,
harmonic filters,
battery banks, heat
traces, UPS, primary
transformer windings,
battery chargers,
VFDs, cables, other
converting equipment,
disconnect electrical
equipment, auxiliary
contacts

The source item


becomes the child item
of the target circuit in the
Electrical
Engineer. The software
assigns the dragged item
to the parent item of the
target circuit: bus, cell, or
PDB.

The source item is not


associated with the target
circuit. The circuit must
be a feeder.

Motors, heaters,
Cables
resistors, capacitors,
harmonic filters,
battery banks, battery
chargers, heat traces,
UPSs, primary
transformer windings,
VFDs, cables,
miscellaneous
electrical equipment,
other converting
equipment, disconnect
electrical equipment,
auxiliary contacts

The source item


becomes the child item
of the target cable in the
Electrical
Engineer. The dragged
item inherits all the target
cable relations.

The source item has no


parent item and the target
cable has no child items in
the Electrical Engineer.

Panel-circuits

Cables

The source item


becomes the child item
of the target cable in the
Electrical
Engineer. The dragged
item inherits all the target
cable relations.

The source panel circuit


has no parent item. The
target cable has no child
items.

Junction boxes, local


panels

Cables

The source item


becomes the child item
of the target cable in the
Electrical
Engineer. The dragged
item inherits all the target
cable relations.

The source item has no


child items and the target
cable has no child items in
the Electrical Engineer.

SmartPlant Electrical User's Guide

Associating Equipment
Special Conditions
The software creates the following electrical items automatically in the Electrical Engineer when
you create them in the Electrical Index. These items appear at the root of the Electrical
Engineer tree view after you create them in the Electrical Index even if they do not have an
existing electrical relation.
Buses
Generators
Battery banks
UPSs
Battery chargers
Transformers
You can connect electrical items in a daisy-chain pattern. For more information, see Create a
Daisy-Chain Connection Pattern (on page 202).
You cannot dissociate the following items, that is, you cannot drag them to the root of the
Electrical Engineer:
Buses
Feeder circuits
Coupler circuits
Transformer secondary winding

Change an Existing Electrical Association


You can change an existing electrical association by doing one of the following:
Drag an item in the Electrical Engineer to another item in the electrical tree of the Electrical
Engineer.
In a cable block diagram, connect two items using a cable or a connector. For details, see
Working with Smart Data and Auxiliary Graphics in a CBD (on page 320).
Note that such changes are governed by a strict set of rules. For more details, see Rules for
Changing Electrical Associations (on page 192).
The software does not allow you to make parallel connections or change existing
parallel connections of cables in the Electrical Engineer. Parallel cable connections or changes
of parallel associations can be carried out only in cable block diagrams.
To change an electrical association in the Electrical Engineer, do the following:
1. In the Electrical Engineer, navigate to the item whose association you want to change.
2. Expand the item hierarchy to the location of the new association. Click the + icon or click the
items.
To facilitate the drag-and- drop operation and to eliminate the need to scroll up or down
in the Electrical Engineer, open another Electrical Engineer window and navigate to the
desired location in the tree view before you start dragging an item.
3. Drag the desired item to the new location in the Electrical Engineer and drop it on the item
with which you want to associate it.

SmartPlant Electrical User's Guide

191

Associating Equipment
The following notes apply to making electrical associations either in the Electrical
Engineer or cable block diagram.
Whenever you drag a load or any equipment item from one bus to another, the software
automatically creates a new feeder circuit. The old feeder circuit from which you dissociated
the dragged item remains in its original place. For more information, see Automatic Creation
of Feeder Circuits (on page 195).
If you choose to automatically create a feeder circuit with a cell, make sure that in the
Properties window for the new cell, you select the In Use setting for the Cell Usage property.
If you want to dissociate a load from a circuit and this is the last associated load, make sure
that in the Properties window for the appropriate cell, you select the Installed Spare setting
for the Cell Usage property.
For details on how to create a new electrical association, see Create an Electrical Association
(on page 186).

Rules for Changing Electrical Associations


You can change an existing electrical association by doing one of the following:
Drag an item in the Electrical Engineer to another item in the electrical tree of the Electrical
Engineer.
In a cable block diagram, connect two items using a cable or a connector. For details, see
Working with Smart Data and Auxiliary Graphics in a CBD (on page 320).
Note that such changes are governed by a strict set of rules.
There are specific rules that govern the change of electrical associations. Note that the software
allows you to connect electrical items even if there is no interconnecting power cable between
these items. In a way, this is similar to the way loads are assigned to circuits.
The software does not allow you to make parallel connections or change existing
parallel connections of cables in the Electrical Engineer. Parallel cable connections or changes
of parallel associations can be carried out only in cable block diagrams.
The following rules apply when dragging an item within the Electrical Engineer:
Source Item

192

Target Item

Result

Loads, converting electrical


Feeder circuits, cables
equipment, primary transformer
windings, cables, incomer circuits,
junction boxes, local panels,
miscellaneous electrical
equipment

The source item becomes the


child of the target item in the
Electrical Engineer.

Bus riser circuits

Coupler circuits

The source item becomes the


child of the target item in the
Electrical Engineer.

Panel - Circuits

Cables

The source item becomes the


child of the target item in the
Electrical Engineer.

Cables

Panel - Circuits

The source item becomes the


child of the target item in the
Electrical Engineer.

SmartPlant Electrical User's Guide

Associating Equipment
Source Item

Target Item

Result

Cables, incomer circuits

Generators, battery banks, The source item becomes the


UPSs, battery chargers,
child of the target item in the
Electrical Engineer.
converting electrical
equipment, secondary
transformer windings

Cables associated with loads

Loads

The software creates a daisychain connection pattern


between the loads.

Any item that has an electrical


parent item (except for buses)

The root of the Electrical


Engineer tree view

The software dissociates the


source item from its parent item.

Special Conditions
Changing the association of a terminated power cable by dragging it to another equipment item in
the Electrical Engineer, disconnects this cable from the terminal strip of that equipment. The
software disconnects the cable without displaying a warning message.
If the dragged item has no hierarchical parent item:
The system creates a new relation with the parent item.
The system copies all the existing associations from the target item to the dragged item. The
copied associations include the highest item in the hierarchy, such as a load or an incomer
circuit.
If the dragged item has a hierarchical parent item:
Dragging it to another item that is not its parent item dissociates the dragged item from its
current parent item.
The dragged item acquires a new electrical relation with the item to which it is dragged. The
copied associations include the highest item in the hierarchy, such as a load or an incomer
circuit.
The system copies all the existing associations from the target item to the dragged item. The
copied associations include the highest item in the hierarchy, such as a load or an incomer
circuit.
You can connect electrical items in a daisy-chain pattern. For more information, see Create a
Daisy-Chain Connection Pattern (on page 202).

Dissociate an Item from Its Feeding Item


This procedure shows you how to dissociate an item from its feeding item in the Electrical
Engineer.
1. In the Electrical Engineer, navigate to the item that you want to dissociate.
2. Do one of the following:
Right-click an item, and on the shortcut menu, click Dissociate.
Select the item you want to dissociate and drag it to the root of the tree view of the
Electrical Engineer.
3. At the prompt, click Yes to confirm the dissociation.

The dissociated item moves to the root of the tree view of the Electrical Engineer provided
that it is associated with at least one other electrical item. If the dissociated item has no other

SmartPlant Electrical User's Guide

193

Associating Equipment

electrical associations, it disappears from the Electrical Engineer. Note that the software
also dissociates from the feeding item all the items that are associated with the dissociated
item.
When dissociating the last load from a circuit, select the Installed Spare setting for the Cell
Usage property.
The software can create undesired and unpredictable associations when you try to dissociate
a load that is connected to its feeder through more than one branch (for example, a cable or
junction box), or when you move one of the feeding branches to another electrical item. To
avoid unwanted associations, you must first dissociate the load. Only then can you dissociate
the remaining items in the multiple branches. If you do not dissociate the load first, the
software may leave undesired associations in the Electrical Engineer.

Associate Electrical Equipment with Feeders


This procedure shows how to associate an electrical item with a feeder using the Electrical Motor
Common Properties, Static Load Common Properties, or Converting Equipment Common
Properties, dialog box. On the appropriate dialog box, the Feeder Data tab options allow you to
associate the selected electrical item with a power distribution board, bus, cell, and circuit as
required.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Loads > Motors
or Static Electrical Equipment or Miscellaneous Electrical Equipment and select an
electrical equipment item.

You can only associate equipment that is not already assigned to an existing circuit. To
verify whether an association exists, right- click the item and click Find in Electrical
Engineer.
You can also associate a load with a feeder by dragging the load to the appropriate feeder
circuit in the Electrical Engineer. For details of this procedure, see .Create an Electrical
Association (on page 186).
2. Right-click the selected electrical item and click Common Properties to open the appropriate
dialog box.
3. Click the Feeder Data tab.
4. In the Location group box, under Power distribution board, select a power distribution
board.
If you select a PDB without specifying a bus, on clicking Apply or OK, the software
creates the new electrical item without a circuit.
5. Under Bus, select a bus with which you want to associate the current electrical item.
If required, you can select a cell in the Cell list to filter the circuits located in that cell.
6. Do one of the following to associate the new item with a feeder circuit:
Under Circuit, select an existing circuit with which you want to associate the current
electrical item.
Select the Create circuit check box to automatically create a new feeder circuit based on
the last applied typical circuit. The software creates an empty circuit without any circuit
components if the current electrical item is not associated with a typical circuit. If you do
not select this check box, the software only associates the selected bus with the loads
without creating any circuits. Where a last applied typical circuit is indicated, the software
creates the new circuit based on the typical circuit. Also, you can select the Create cell
check box to automatically create a cell when the software creates the new feeder circuit.

194

SmartPlant Electrical User's Guide

Associating Equipment
If you select a cell without selecting an existing circuit, the software automatically
creates a new circuit when you click Apply or OK.
7. Continue defining the feeder data as required and click OK when done.

If you choose to automatically create a feeder circuit with a cell, make sure that in the
Properties window for the new cell, you select the In Use setting for the Cell Usage property.
After specifying a circuit, applying the change, and exiting the dialog box, you can no longer
change the feeder data values from the dialog box.
A circuit can feed more than one electrical item.
It is possible to connect a number of heat tracers and Miscellaneous Electrical Equipment
items in a daisy-chain pattern.

Automatic Creation of Feeder Circuits


The software automatically creates a feeder circuit when you associate a load or any equipment
item with a bus. This automatic creation of feeder circuits occurs when you do one of the
following:
Drag a load or an equipment item from the Electrical Index to the Electrical Engineer.
Drag a load or an equipment item from one bus to another in the Electrical Engineer.
Select the Create circuits option on the Batch Load Association dialog box.
Select the Create circuit option on the Feeder Data tab of the Common Properties dialog
box for any motor, static load, converting equipment, and other equipment.
Select a PDB, bus, and cell without selecting an existing circuit on the Feeder Data tab of the
Common Properties dialog box for any motor, static load, converting equipment, and other
equipment.
Whenever you associate a load or an equipment item with a bus for the first time by dragging an
item from the Electrical Index to the Electrical Engineer, the software automatically creates a
feeder circuit for the dragged item. Also, whenever you change an existing association in the
Electrical Engineer, the software automatically creates a new feeder circuit and circuit
components on the bus to which you dragged the load or equipment item. In this case, the old
feeder circuit that belonged to the dissociated item remains in its original place. You can delete it
if you want to or leave it as a spare feeder circuit to associate with another equipment item.
Regardless of whether you drag a load to a bus from the Electrical Index to the Electrical
Engineer or within the Electrical Engineer, the software also creates circuit components for the
new feeder. In this case, you must ensure that you define the cell properties correctly. In the
Properties window for a cell, select the In Use setting for the Cell Usage property. When
dissociating the last load from a circuit, select the Installed Spare setting for the Cell Usage
property.
Note the following:
If the load that you drag is associated with a typical circuit, the software creates the necessary
circuit components as they are defined in the typical circuit.
If the item that you drag is not associated with a typical circuit, the software creates a feeder
circuit without any circuit components.
If the item that you drag is not a load, the software creates a feeder circuit without any circuit
components.
Also, you can instruct the software to automatically create a feeder circuit and a cell when you set
the Feeder options on the Common Properties dialog box of any load or equipment item. You
also can do this when associating loads with buses in batch mode. For more information about
batch load association, see Associate Loads with a PDB in Batch Mode (on page 205).

SmartPlant Electrical User's Guide

195

Associating Equipment

Associate Bus Riser Circuits with Coupler Circuits


This procedure shows how to associate bus riser circuits with coupler circuits to create a bus tie.
1. In the Electrical Engineer, find the bus riser and coupler circuits that you want to associate.
2. Select the bus riser circuit and drag it to the coupler circuit.

Also, you can use a cable to connect a bus riser with a coupler. To do this, in the Electrical
Engineer, drag the desired cable to a coupler. Then, drag a sectionizer to that cable. Note
that you can use only a single cable and not a series of cables for this purpose.
To facilitate the drag-and- drop operation and to eliminate the need to scroll up or down in the
Electrical Engineer, open another Electrical Engineer window and navigate to the desired
location in the tree view before you drag an item.

Associate a Control Station with an Electrical Item


This procedure shows how to associate a control station with an electrical item. Note that this
association does not appear in the Electrical Engineer. For instructions on how to associate a
control station with cables, see Associate a Control Station with Cables (on page 197).
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels > Control
Stations.
2. Right-click a control station and click Common Properties to open the Control Station
Common Properties dialog box.
3. Beside Associated load, click Find to open the Find dialog box.
4. From the Equipment type list, select the desired equipment type.
5. Click Find Now.
6. From the data window, highlight an item tag.
7. Click OK to associate the item tag with the current control station.

196

You can also associate a control station with an electrical item using the Apply Options
feature for the electrical item with which you want to associate a control station. If you apply a
control station to an item that is connected to a circuit, the software associates the control
station cables (instrumentation and control) with the circuit automatically when you select the
appropriate Options Manager setting. If you do not use this setting, you need to make the
association manually. For details, see Associate Control Station Cables with Equipment
Circuits (see "Associate Cables of Control Stations with Equipment Circuits" on page 197).
You can associate only one control station with an electrical item.

SmartPlant Electrical User's Guide

Associating Equipment

Associate a Control Station with Cables


This procedure explains how to associate a control station with cables.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels > Control
Stations.
2. Right-click a control station and click Common Properties to open the Control Station
Common Properties dialog box.
3. Click Add.
4. On the Find dialog box, click Find Now to display the available cables.
5. Select a cable to associate with the current control station and click Apply.
6. Repeat the previous step for each additional cable that you want to associate with the control
station.

The Find dialog box displays only control and grounding cables that have at least one
unassociated side.
You can associate one control station with more than one cable.
You cannot associate a control station with a power cable.

Associate Cables of Control Stations with Equipment


Circuits
This procedure explains how to manually associate instrumentation or control cables (belonging
to control stations) with the circuit belonging to the equipment that the control station operates or
monitors. You can also specify automatic association of control station cables with equipment
circuits from the Options Manager.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Panels > Control
Stations.
2. In the lower pane, select one or more control stations.
3. Click Actions > Cables > Associate Cables with Equipment Circuits.

Associate Cables of Instruments with Equipment


Circuits
This procedure explains how to manually associate instrumentation or control cables (belonging
to instruments) with the circuit belonging to the equipment that the instrument operates or
monitors. You can also specify automatic association of instrument cables with equipment
circuits from the Options Manager.
1. In the Electrical Index, expand the folder hierarchy Electrical Equipment > Instruments.
2. In the lower pane, select one or more control stations.
3. Click Actions > Cables > Associate Cables with Equipment Circuits.

SmartPlant Electrical User's Guide

197

Associating Equipment

Associate a Power Cable with Electrical Equipment


This procedure explains how to associate a power cable with an electrical item by making the
association in the Electrical Engineer.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Under the folder Power Cables, select the desired cable and drag it under a feeder circuit
in the Electrical Engineer.
3. In the Electrical Engineer, right- click the cable, and on the shortcut menu, click Common
Properties.
4. Click the Design Data tab and note that the circuit path appears under From, in the Tag box.
5. Close the dialog box, and in the Electrical Index, select the item of electrical equipment with
which you want to associate the cable.
You can select any load that does not already have an association in the Electrical
Engineer. For the rules that govern the conditions under which you can drag items onto
other items, see .Rules for Associating Electrical Equipment (on page 187).
6. Drag the item under the cable in the Electrical Engineer.
7. Open the dialog box for the cable again and on the Design Data tab, note that the item tag for
the equipment appears under To, in the Tag box.

If an item already appears in the Electrical Engineer, you can drag a cable onto the item
where this is allowed.
You can associate a power cable with a motor by defining a motor profile with that cable and
then applying the profile to the desired motor.
Changing the association of a terminated cable by dragging it to another equipment item in the
Electrical Engineer, disconnects this cable from the terminal strip of that equipment. The
software disconnects the cable without displaying a warning message.

Associate Additional Power Cables with Electrical


Equipment
This procedure explains how to add a power cable to an electrical item in parallel to an existing
power cable in the Electrical Engineer.
1. In the Electrical Engineer, expand the hierarchy to the load to which you want to add one or
more cables.
2. Right-click the cable associated with the load, and on the shortcut menu, click Add Cable.
3. On the Find dialog box, click Find Now to display the available power cables.
4. From the list of power cables, while holding CTRL, highlight each cable that you want to add.
5. Click OK.
6. In the Electrical Engineer, right- click a cable that you added.
7. On the shortcut menu, click Common Properties.
8. Click the Design Data tab and note that the associated load and feeder path appear in the
From and To sections, in the Tag boxes.

198

Cables that you associate in this way do not appear in the parallel cable list in the Cable
Common Properties dialog box of other cables connected to the same load.

SmartPlant Electrical User's Guide

Associating Equipment

If you dissociate a cable from the feeder, the software automatically dissociates that cable
from the load and dissociates all the other parallel cables from the feeder; however, those
cables remain associated with the load.
Changing the association of a terminated cable by dragging it to another equipment item in the
Electrical Engineer, disconnects this cable from the terminal strip of that equipment. The
software disconnects the cable without displaying a warning message.
When defining naming conventions for parallel cables, you can determine where in the cable
tag name you want to include the parallel cable suffix. In Options Manager, on the Define
Naming Conventions dialog box (Options > Naming Conventions > Define), define the
parallel cable suffix in the Segment definitions section. You can move the parallel cable
suffix property up or down the list to set the position of this property in the segment definition.
If you do not select this check box, the suffix for the parallel cables will appear at the end of the
cable tag name.

Associate a Non-Power Cable with Electrical


Equipment
This procedure explains how to associate a control, grounding, or instrumentation cable with an
electrical item using the Cable Common Properties dialog box.
1. In the Electrical Index, expand the folder hierarchy Wiring Equipment > Cables.
2. Expand one of the folders Control Cables, Grounding Cables, or Instrumentation Cables
and select a cable.
3. Do one of the following:
Click Edit > Common Properties.
Right-click the cable and on the shortcut menu, click Common Properties.
Press CTRL + F2.
4. On the Cable Common Properties dialog box, click the Design Data tab.
5. Click the ellipsis button
beside the From property to define one side of the cable.
6. On the Find dialog box, from the Equipment type list, select the desired equipment type, and
click Find Now.
7. From the data window, highlight an item to select it, and click OK.
8. Click the ellipsis button

beside the To property to define the other side of the cable.

Changing the association of a terminated cable with another equipment item on the Cable
Common Properties dialog box, disconnects this cable from the terminal strip of that
equipment. The software disconnects the cable without displaying a warning message.

SmartPlant Electrical User's Guide

199

Associating Equipment

Define Parallel Equipment


This option allows you to define a parallel relationship between equipment items.

The definition of a parallel relationship between items is subject to certain rules. For details,
see Rules Governing Parallel Relations (on page 201).
The software does not allow you to make parallel connections or change existing parallel
connections of cables on the Cable Common Properties dialog box. Parallel cable
connections or changes of parallel associations can be carried out only in cable block
diagrams.
1. Do one of the following:
Click Actions > Manage Parallel Equipment.
On the Actions toolbar, click
.
2. On the Parallel Equipment Assistant dialog box, under Show parallel equipment data,
select one of the following filtering options to determine what data you want to see in the
Parallel equipment definition grid:
Show all existing parallel pairs shows all the existing parallel equipment items that
have been defined as pairs in the current plant.
Parallel pairs placed on the current cable block diagram only shows only those
paired equipment items that have been placed on the current cable block diagram.
Parallel pairs not placed on any cable block diagram shows only those paired
equipment items that have not been placed on any cable block diagram.
3. In the Parallel equipment definition grid, click Add to append a new empty row.
4. Select the new row and then click
under Item 1 and Item 2 to find appropriate equipment
items.
5. Under Input/Output, click the list arrow and select In or Out to set the parallel connection on
the inlet or outlet side of the equipment.
The list arrow and
appear only after selecting a row.
To cancel a parallel definition, select a row and click Remove.
6. Do one of the following:
Click Apply if you want to define or change another pair of items.
Click OK to accept all your definitions and close the Parallel Equipment Assistant.

200

After completing the definition of the parallel pairs and opening a cable block diagram, all the
parallel pairs become available in the Parallel pairs list on the Modify Connector ribbon.
This ribbon becomes available after clicking a cable that has been placed on a cable block
diagram. For details, see Connect Equipment Items in Parallel (on page 202).

SmartPlant Electrical User's Guide

Associating Equipment

In the Electrical Index and Electrical Engineer, a special indicator


equipment items that are connected in parallel.
For example
.

appears next to the

Rules Governing Parallel Relations


This topic provides detailed information about what electrical equipment items can exist in a
parallel relation with other equipment items.
Item Type

Can Be Connected With Input / Output

Example

Loads

Any item belonging to the Only the IN side


Loads electrical
equipment subclass

A motor can be connected to


a heater.

Converting equipment

The items that belong to


the same electrical
equipment subclass only

Transformers
only the IN side.
All other
converting
equipment types
can be
connected on
both sides.

A transformer primary can be


connected only to another
transformer primary.
A transformer cannot be
connected to a VFD.

Transformer
components

Another transformer
component only.

Only the OUT


side

A transformer tertiary can be


connected with another
transformer tertiary.

Offsite power supplies Offsite power supplies


only

Only the OUT


side

Generators

Generators only

Only the OUT


side

Incomer circuits

Incomer circuits only

Only the IN side

Junction boxes

Junction boxes only

Both sides: IN to
IN and OUT to
OUT

Local panel

Local panels only

Both sides: IN to
IN and OUT to
OUT

Panel circuits

Panel circuits only

Both sides: IN to
IN and OUT to
OUT

Standalone disconnect The items that belong to


equipment
the same electrical
equipment subclass only

Both sides: IN to A starter can be connected to


IN and OUT to
another starter. A starter
OUT
cannot be connected to a
fuse.

You can use the following items between equipment items connected in parallel:
Cables.
Standalone disconnect electrical equipment.

SmartPlant Electrical User's Guide

201

Associating Equipment

Connect Equipment Items in Parallel


This procedure explains how to make parallel connections of equipment items in a cable block
diagram. Before you can make any parallel connections in a cable block diagram, you must first
define parallel pairs of equipment items. For details, see Define Parallel Equipment (on page 200).
1. Open a cable block diagram and place the equipment items and cables that you require.
2. Select a cable that you want to use.

For parallel connection, you can only select a cable that is not connected on either end.
Once you click a cable or a connector, the software opens the Modify Connector ribbon.
For details on the various commands that are available on this ribbon, see Modify
Connector Ribbon (on page 834).
3. On the Modify Connector ribbon, from the Parallel Pairs list, select the pair of items that you
want to connect in parallel. The software displays the connection points on all the symbols of
the pertinent equipment items.

The Parallel Pairs list contains the items that have been placed on the current cable
block diagram and that have been defined as parallel pairs in the Parallel Equipment
Assistant. For details, see Define Parallel Equipment (on page 200).
Some of the paired equipment items that appear on the Parallel Pairs list may appear
disabled. This means that at least one of the items belonging to this pair has already been
connected in parallel with another equipment item.
4. Drag an end of the selected cable to a connection point on an equipment item symbol.

Create a Daisy-Chain Connection Pattern


This topic provides the rules for connecting electrical items in a daisy-chain pattern.
It is possible to connect a number of electrical items in a daisy-chain pattern. You connect
electrical items in a daisy- chain pattern by dragging an item to another item of the same type from
the Electrical Index to the Electrical Engineer or within the Electrical Engineer. You can
connect the following items in a daisy-chain pattern:
Loads drag a load associated with a cable to another load in the Electrical Engineer.
Heat traces drag a heat trace to another heat trace in the Electrical Engineer. You can
also drag a heat tracer to a junction box but not to a circuit in a junction box. Heat traces and
miscellaneous electrical equipment items do not require associated cables to male
daisy-chain connections.
Miscellaneous electrical equipment items drag a socket outlet, lighting fixture, welding
outlet, and so forth to another item belonging to the Miscellaneous Electrical Equipment
type. Also, you can drag an item belonging to the Miscellaneous Electrical Equipment type to
a junction box but not to a junction box circuit.
Junction boxes drag a junction box (but not its circuit) to a heat trace or to an item
belonging to the Miscellaneous Electrical Equipment type. There is no need for a cable to be
associated with a junction box.

202

On the Batch Load Association dialog box, the software displays items connected in a
daisy-chain pattern as if they are all connected in a parallel pattern. The software handles
both parallel and daisy-chain connections in the same way.

SmartPlant Electrical User's Guide

Associating Equipment

On the Common Properties dialog box, items connected in a daisy-chain pattern appear as if
they are fed from the same feeder circuit.
You cannot drag loads that are connected in a daisy-chain pattern to the same circuit to create
a parallel connection. However, you can drag them to other circuits.

Move Disconnect Equipment into Circuit


Use this procedure to move stand-alone disconnect equipment into a circuit so that it becomes a
circuit internal.
1. In the Electrical Engineer, select a stand-alone disconnect equipment item.
2. On the shortcut menu, click Move to Circuit.
3. Do one of the following:
If there is only one available circuit, click Yes when prompted to move the disconnect
equipment.
If the disconnect equipment item appears between two circuits, on the Select Circuit
dialog box, select the target circuit and then click OK.
In the circuit, the equipment that you moved receives sequence number 1. You can
change the sequence in group manually if needed.

Move Disconnect Equipment out of Circuit


Use this procedure to move a circuit internal out of the circuit and place it under the circuit in the
Electrical Engineer as stand-alone disconnect equipment.
1. In the Electrical Engineer, select and right-click a circuit.
2. On the shortcut menu, click Common Properties.
3. On the Circuit Common Properties dialog box, click Associated Items.
4. Under Circuit internals, select a circuit whose Order value is 1.
It is only possible to move out an internal whose Order value in the Circuit internals
pane is 1.

SmartPlant Electrical User's Guide

203

Associating Equipment

204

SmartPlant Electrical User's Guide

SECTION 14

Load Association
This section deals with PDB/bus load associations and balancing load data.

Associate Loads with a PDB in Batch Mode


This procedure explains how to associate a number of loads with a selected power distribution
board. The software makes the associations and then sums up the electrical consumption and
the full load current that the associated loads require. This calculation facilitates the power
distribution board design at an early planning stage. Note that you can choose one of the
following calculation modes:
Calculate the total consumed power only for those loads that are connected directly to the
current bus.
Calculate the total consumed power for all the loads fed by the current bus as well as the loads
that are fed by the buses that are connected to the current bus (as specified in Options
Manager).
1. In the Electrical Index, expand the Electrical Equipment folder hierarchy and navigate to
the desired folder, such as Motors, Static Electrical Equipment, Converting Equipment,
and so forth.
2. In the list view pane, select the items that you require.

3.
4.
5.
6.
7.
8.
9.

You can also associate a single load without selecting a batch of loads in the Item Tag
pane of the Electrical Index. This way you can associate different loads belonging to
any load category in the Electrical Index. For more details, see Associate a Single Load
with a PDB (on page 208).
Also, you can select the desired loads in the Tabular Editor.
Click Actions > Batch Load Association.
On the Batch Load Association dialog box, under Power distribution board, select the
desired power distribution board.
From the Bus list, select a bus with which you want to associate the loads.
On the Bus tab, specify the rated data for the selected bus as needed and click Apply.
Click the Loads tab.
Click Add Selected Loads to add the items to the Associated loads list. (You selected
these items in the list view pane of the Electrical Index.)
In the Associated loads box, scroll to the right and define the phase assignment of the
current load by selecting the appropriate Phase check boxes.

For a single-phase load, select one of the Phase check boxes.


If you want a single-phase load to simulate a two-phase load which is connected to a
three-phase bus, select two of the Phase check boxes.
For a three- phase load, select all three Phase check boxes.

SmartPlant Electrical User's Guide

205

Load Association
10. Under Create circuits and cells, select the Create circuits check box to automatically
create a circuit for each associated load that has not been assigned to a circuit. Note that this
option does not affect the loads that have already been assigned to circuits.

If you do not select the check boxes under Create circuits and cells, the software
associates the selected loads with a power distribution board or a bus. You can create
circuits at a later time.
Note that circuits have a property called CircuitMode with values Connected and
Disconnected. If you set this property to Disconnected, the drill down algorithm will
stop the calculation there and will not roll up the loads connected to this feeder.
11. Select the Create cell check box to automatically create a cell where the new feeder circuit for
the associated load will be created.
Make sure that in the Properties window for the new cell, you select the In Use setting
for the Cell Usage property.
12. Click Add to add other loads to the association.
13. On the Find dialog box, in the Results data window, select the loads that you require.

For further details about selecting items, see the Find dialog box.
The software finds only those items that have the Is Load property in the Properties
window set to True or if this item is defined as a Consumer in the Common Properties
dialog box. Also, the Find dialog box displays only those load items that aren't
connected to a bus.
14. Under Electrical consumption using coincidence factors, select one of the following
calculation modes:
For direct loads only to calculate the total consumed power only for those loads that
are connected directly to the current bus.
For all feeders to calculate the total consumed power for all the loads fed by the
current bus as well as the loads that are fed by the buses that are connected to the current
bus (as specified in Options Manager). When you select this option, the Circuits tab
becomes available.
You can set a preference that instructs the software to take into account any existing
transformer power losses. For details, see Customize All Feeder Load Summary Report
Preferences (on page 31).
15. Click Re-Calculate to refresh the display of the calculated values.
When selecting a PDB that contains a large downstream electrical distribution system, it
may take some time for the software to perform all the calculations before it displays all the
values. To avoid this situation, when opening the Batch Load Association dialog box, the
software displays the values that were stored in the database during the last
calculation. Clicking the Re- Calculate button allows you to re-calculate and refresh the
display the current calculation values.
16. To associate loads that have been associated only with a PDB and not with a bus, click the
Unassigned Loads tab.
17. Under Unassigned loads, select the item tag type and the Select check box for each load
that you want to associate.
18. Click Assign to Bus.
The software moves the selected load to the Loads tab.
19. Click Apply.

206

SmartPlant Electrical User's Guide

Load Association
20. Click the Bus tab and define the bus rated data.
If, after calculating the rated power for all feeders, you move to the Bus tab and change
the bus data, make sure that you click Apply before you switch back to the Loads tab.
21. Click the Loads tab and set the load phases.
22. Continue adding loads as you require and then click OK when done.
For information about associating a load with a different bus, see Balance Bus Loads (on
page 212).
The following table summarizes the information presented on the Loads and
Circuits tabs of the Batch Load Association dialog box:
Item Type

Associated Loads Grid

Calculated Results

Loads connected
directly to the
selected bus.

Shown as
non-compensated values.

Accounts for and shows Not applicable


consumed compensated
values.

Converting
equipment

Shown when defined as


loads and presented as
non-compensated values.

Accounts for and shows Shown only if the converting


consumed compensated equipment is not defined as a
values.
load.

Converting
equipment losses

When this preference is


Accounts for and shows
selected, the item tag is
non-compensated
shown without any values. values.

Local panels and


junction boxes

Shown when defined as


loads and presented as
non-compensated values.

Accounts for and shows Not applicable


consumed compensated
values.

Cabinets and
instruments

Shown as
non-compensated values.

Accounts for and shows Not applicable


consumed compensated
values.

Feeder circuit that


feeds a
downstream bus
or converting
equipment.

Not applicable

Accounts for and shows Shown if it feeds an incomer


consumed compensated circuit or converting
values.
equipment that is not defined
as a load.

Coupler circuit

Not applicable

Accounts for and shows Shown if it feeds a bus riser.


consumed compensated
values.

Circuits Tab

Shown only if the converting


equipment is not defined as a
load.

Electrical items are included in calculations if they are defined as consumers. In addition to
loads, you can define converting equipment items, cabinets, local panels, and junction boxes
as consumers. To define an electrical item as a consumer, you have to set the Is Load
property in the Properties window for that item to True or define the electrical item as a
Consumer in the relevant Common Properties dialog box.
If you define a converting equipment item, local panel, or junction box as a consumer and
perform a drill-down calculation, the software uses the rated and consumed electrical load
values of the equipment as the load values, the software ignores the entire branch that is
connected downstream from the equipment. Note that you enter the pertinent rated and
consumed electrical load values on the Common Properties dialog box of the equipment
item.

SmartPlant Electrical User's Guide

207

Load Association

You can assign a load to a particular phase only if you defined the properties of the current bus
as having an AC supply and you set a value for the number of phases.
The software displays the calculated consumption values according to the loads associated
with each bus for the selected phase. If you do not select any bus from the Bus list, the
software calculates the consumption for the entire power distribution board.
The software can take into account converting equipment power losses if you have set your
report preferences accordingly. For details, see Customize All Feeder Load Summary Report
Preferences (on page 31).
If you associate a capacitor, the software subtracts the consumed kVAr value of that capacitor
from the total connected consumed kVAr value. Therefore, the consumed electrical power
(kVAr) may display a negative value. This means that there is a lagging power factor.
When performing bus load association and assigning a load to another bus on the Cached
Loads tab of the Bus Load Association dialog box, the software checks if the selected load
is associated with a heater that is connected through an auxiliary contact that is fed from the
same circuit as the selected load. If the software detects such a heater, it will prompt you to
move the associated circuit together with the load. If you click Yes, the software will move the
load and its heater together with the associated circuit to another bus. If you click No, the
software will only move the selected load without moving the heater or the circuit. In this case,
you will have to move the associated heater manually.
If a particular load associated with a selected PDB or bus contains incomplete data, the
software displays an appropriate message in the Note box.
To cancel an association of an item, under Associated loads, select a row and click Remove.
You cannot dissociate a load if it is connected to a circuit.

Associate a Single Load with a PDB


This procedure explains how to associate a single load with a selected power distribution board or
bus. The software makes the associations and sums up the electrical consumption and the full
load current that the associated load requires. This calculation facilitates the power distribution
board design at an early planning stage.
1. Click Actions > Batch Load Association.
2. On the Batch Load Association dialog box, under Power distribution board, select a
power distribution board.
3. From the Bus list, select a bus with which you want to associate the loads.

4.
5.
6.
7.

You do not have to select a bus if you do not want to associate any loads with a specific
bus under the selected PDB. In this case, the software calculates the load consumption for
the entire power distribution board rather than for a specific bus.
Click the Loads tab.
Click Add to open the Find dialog box.
From the Equipment type list, select the desired equipment type.
Click Find Now.

The software finds only those load items that have the Is Load property in the
Properties window set to True or if this load is defined as a Consumer in the Common
Properties dialog box. In addition to loads, you can define other electrical items as
consumers. These items are converting equipment items, local panels, and junction boxes.
Also, the Find dialog box displays only those load items that are not connected to a bus.
8. From the data window, highlight the desired load item tag.
9. Click OK to associate the load with the selected PDB.

208

SmartPlant Electrical User's Guide

Load Association
10. Under Create circuits and cells, select the Create circuits check box to automatically
create a circuit for each associated load that has not been assigned to a circuit. Note that this
option does not affect the loads that have already been assigned to circuits.
If you do not select the check boxes under Create circuits and cells, the software
associates the selected loads with a power distribution board or a bus. You can create
circuits at a later time.
11. Select the Create cell check box to automatically create a cell where the software will create
the new feeder circuit for the associated load.
Make sure that in the Properties window for the new cell, you select the In Use setting
for the Cell Usage property.
12. Under Associated loads, scroll to the right and define the phase association of the current
load by selecting the appropriate Phase check boxes.

13.
14.
15.
16.
17.
18.
19.

For a single-phase load, select one of the Phase check boxes.


If you want a single-phase load to simulate a two-phase load which is connected to a
three-phase bus, select two of the Phase check boxes.
For a three- phase load, select all three Phase check boxes.
Click Apply and then click the Bus tab.
Define the bus rated power as needed.
To associate loads with a bus that have been associated only with a PDB, click Unassigned
Loads.
Under Unassigned loads, select the item tag type and the Select check box for each load
that you want to associate.
Click Assign to Bus.
Click Apply and then select another PDB or another bus.
Continue adding loads as you require and then click OK when done.
For information about associating a load with a different bus, see Balance Bus Loads (on
page 212).

The following table summarizes the information presented on the Loads and
Circuits tabs of the Batch Load Association dialog box:
Item Type

Associated Loads Grid

Calculated Results

Loads connected
directly to the
selected bus.

Shown as
non-compensated values.

Accounts for and shows Not applicable


consumed compensated
values.

Converting
equipment

Shown when defined as


loads and presented as
non-compensated values.

Accounts for and shows Shown only if the converting


consumed compensated equipment is not defined as a
values.
load.

Converting
equipment losses

When this preference is


Accounts for and shows
selected, the item tag is
non-compensated
shown without any values. values.

Local panels and


junction boxes

Shown when defined as


loads and presented as
non-compensated values.

SmartPlant Electrical User's Guide

Circuits Tab

Shown only if the converting


equipment is not defined as a
load.

Accounts for and shows Not applicable


consumed compensated
values.

209

Load Association
Item Type

Associated Loads Grid

Calculated Results

Cabinets and
instruments

Shown as
non-compensated values.

Accounts for and shows Not applicable


consumed compensated
values.

Feeder circuit that


feeds a
downstream bus
or converting
equipment.

Not applicable

Accounts for and shows Shown if it feeds an incomer


consumed compensated circuit or converting
values.
equipment that is not defined
as a load.

Coupler circuit

Not applicable

Accounts for and shows Shown if it feeds a bus riser.


consumed compensated
values.

210

Circuits Tab

You can assign a load to a particular phase only if you defined the properties of the current bus
as having an AC supply and you set a value for the number of phases.
To cancel an association of an item, under Associated loads, select a row and click Remove.
You cannot dissociate a load if it is connected to a circuit.
The software displays the calculated consumption according to the loads associated with each
bus. If you do not select any bus from the Bus list, the software calculates the consumption
for the entire power distribution board.
When performing bus load association and assigning a load to another bus on the Cached
Loads tab of the Bus Load Association dialog box, the software checks if the selected load
is associated with a heater that is connected through an auxiliary contact that is fed from the
same circuit as the selected load. If the software detects such a heater, it will prompt you to
move the associated circuit together with the load. If you click Yes, the software will move the
load and its heater together with the associated circuit to another bus. If you click No, the
software will only move the selected load without moving the heater or the circuit. In this case,
you will have to move the associated heater manually.
If you associate a capacitor, the software subtracts the rated kVAr value of that capacitor from
the total connected rated kVAr value. Therefore, the rated electrical power (kVAr) may
display a negative value. This means that there is a lagging power factor.
If a particular load associated with a selected PDB or bus contains incomplete data, the
software displays an appropriate message in the Note box.

SmartPlant Electrical User's Guide

Load Association

Display Bus Load Data


1. Click Actions > Batch Load Association.
2. On the Batch Load Association dialog box, under Power distribution board, select a
power distribution board.
3. From the Bus list, select a specific bus.
4. Click the Loads tab.
5. Under Bus phases, select All phases to see all the calculated electrical data for all the
associated loads.

The software displays the calculated electrical consumption for the selected bus.
To view the calculated electrical consumption for a particular phase, select the check boxes as
you require in the Bus phases group box.

Balancing Loads
Load balancing is an operation that you can perform at any stage of your project. However, it is
recommended that you perform load balancing before you create feeder cables between loads
and their circuits, and before you apply profiles to the loads. The reason for this is that when you
move loads between buses, associated power cables remain attached to the previous feeder
circuits.

Validate Bus Loads


This procedure shows how to define current settings and requested spare capacity for bus load
lines and to perform validations of bus loads.
1. Associate loads with buses individually or in batch mode. For more information, refer to
Related Topics.
2. Click Actions > Batch Load Association.
3. On the Batch Load Association dialog box, under Power distribution board, select a
power distribution board.
4. From the Bus list, select a specific bus.
5. Click the Bus tab.
6. Type values in the Line current and Overload percentage boxes.
7. Enter or modify other values as desired.
8. On the Loads tab, click Recalculate to ensure that calculations for Total running load and
Total peak load are up to date.
9. Close the Batch Load Association dialog box.
10. In the Electrical Index, select one or more PDBs or buses.
If Step 8 of this procedure has not been performed on some PDB buses, click
Actions > Calculate Bus Loads.
11. Click Actions > Total Bus Load Validation.
The software calculates the load data for the selected buses and displays the results on
the Total Bus Load Validation dialog box (on page 761).

SmartPlant Electrical User's Guide

211

Load Association
12. If desired, click Excel Report to view the results in an Excel file.

The software uses the total bus amperes as the basis for calculating the total bus load,
including any loads connected downstream. The input for the calculation comes from the
consumed active and reactive loads.
The software does not perform bus load validation for loads that have incomplete data, that is,
where any of the following properties has a value of zero:
The consumed active load.
The consumed reactive load.
The coincidence factor (X, Y, Z, or ZZ) that applies for the load.
Operating mode (governs the coincidence factor used in consumed electrical power
calculations.
Demand factor.
Power factor at Demand
Efficiency at Demand.

Balance Bus Loads


This procedure shows how to move loads between different buses in your project.
1. Click Actions > Batch Load Association.
2. On the Batch Load Association dialog box, under Power distribution board, select a
power distribution board.
3. From the Bus list, select the required bus.
4. Click the Loads tab.
5. Select the loads that you want to move.
You can select multiple rows if you need to move several loads.
6. Click Move to Cache.
7.
8.
9.
10.

The software moves the load from Associated loads list to the Cached Loads tab.
Repeat the two previous steps for each load that you want to dissociate from the currently
selected bus.
Click the Cached Loads tab.
Click Apply.
From the Power distribution board and Bus lists, selected the desired PDB and bus to
which you want to move the cached loads.

On performing this step, the software prompts you to save the changes. If you click Yes,
the software dissociates the cached loads from the bus to which they were assigned, and
you can now reassign them.
Also, the software displays a message allowing you to move the selected bus together
with its feeding circuit and the circuit internal items. However, if the load that you want to
move is connected to the bus through converting equipment, the feeding circuit cannot be
moved with the load.
11. Do one of the following:
For each load that you want to reassign, select the check box in the Item Tag column.
To reassign all of the loads in the list, select the Select all check box.

212

SmartPlant Electrical User's Guide

Load Association
12. Click Assign to Bus.
When performing bus load association and assigning a load to another bus on
the Cached Loads tab of the Bus Load Association dialog box, the software checks if the
selected load is associated with a heater that is connected through an auxiliary contact that is
fed from the same circuit as the selected load. If the software detects such a heater, it will
prompt you to move the associated circuit together with the load. If you click Yes, the
software will move the load and its heater together with the associated circuit to another bus.
If you click No, the software will only move the selected load without moving the heater or the
circuit. In this case, you will have to move the associated heater manually.
13. If you have not assigned all the items to new buses, repeat the three previous steps for each
load that you want to reassign.
The Cached Loads tab behaves as a temporary data store only; the software removes all
loads from the list when you close the dialog box.

SmartPlant Electrical User's Guide

213

Calculating Bus Load Summaries

SECTION 15

Calculating Bus Load Summaries


SmartPlant Electrical enables you to calculate bus load totals on a specific power distribution
board, bus, or on all the buses in the plant. This calculation facilitates the sizing of electrical
equipment such as generators, distribution transformers and their feeder cables, buses, UPSs
and so forth. After completing the calculation, SmartPlant Electrical stores the results in the
database. You can calculate the bus load totals for all the existing buses in the plant or just for
those PDBs or buses that you select in the Electrical Index or the Electrical Engineer. Once
the software completes the calculation, you can generate a load summary report for the calculated
loads based on the calculated and stored properties.

The software takes into account any existing equipment that is connected in parallel.
When making calculations, SmartPlant Electrical considers the worst case scenario in its
calculation results and does not take into account any load flow that would be taken into
account by a power analysis application such as ETAP. That is, for calculation purposes,
SmartPlant Electrical always assumes that the total connected load is supplied from one
source only. If there are multiple sources that supply the same connected load, SmartPlant
Electrical assumes that each source has the capability to supply the connected load.
SmartPlant Electrical, unlike any power analysis application, does not account for multiple
sources that share a load. Consequently, in SmartPlant Electrical, the total load for a
distribution network can appear artificially high unless the Circuit Mode property is set to either
Connected or Disconnected as desired on specific circuits.

Calculation Process: Drill-Down and Roll-Up


The calculation process consists of two parts, drill-down and roll-up.
Drill-Down The calculation starts from the highest level of a particular power flow that you
select in the Electrical Engineer. Then the calculation process continues down the power
flow all the way to the electrical consumers at the lowest level of the Electrical Engineer
hierarchy. The software performs this process automatically. You can tweak the calculation
process by switching the specific circuits on or off as you require. Also, you can define
converting equipment PDBs as consumers. In these cases, the drill-down process does not
continue beyond the pertinent converting equipment or PDBs. Also, in the Properties window,
you can change the Is Load property of an electrical item to False. Note that the software
does not include in the drill-down process any items below the circuits that have been
switched off. Nor does it include any converting equipment items that have not been defined
as consumers.
Roll-Up During this calculation process, the software collects the information from the
lowest level of a particular power flow that you select in the Electrical Engineer and goes up
the flow through the wiring, converting equipment, and feeder circuits all the way to the buses
connected by couplers or risers and up to their incomer circuits. Then, the software gathers
the values from the buses on the lower level of the electrical hierarchy and adds them to the
values of the buses on a higher level all the way to the top of the selected electrical hierarchy.
Note that the software stores the incomer totals in the calculation properties of the incomer
circuits in the Properties window of the incomers.

214

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


Electrical Load Data
When performing a load summary calculation, the software uses the values of the following load
properties:
Rated active (kW at rated/nominal/100% load conditions) Prated
Rated reactive (kVAR at rated/nominal/100% load conditions) Qrated
Consumed active (kW at operating point/consumed load conditions) Pcomsumed
Consumed reactive (kVAR at operating point /consumed load conditions) Qcomsumed
Operating mode (Continuous, Intermittent, Standby or Spare)
Coincidence factors for each and every mode of operation (x,y,z,zz)

Motor Power Calculation Mechanism


For most types of load SmartPlant Electrical calculates the electrical reactive and apparent
power values as a vector sum based on the mechanical power and the power factor (cos ). This
is the common electrical formula derived from the power triangle shown below. The software
displays the calculated values in the Active power, Reactive power, and Apparent power fields.
You can enter values in the Rated power, Break power, Demand factor, and Power factor
fields only.
The software performs active, reactive, and apparent load calculations twice for rated and
consumed (brake) power. For motors (dynamic loads), the power factor and efficiency values that
are used for consumed power calculation are derived from a three-point graph which is
interpolated from the given power factor and efficiency values at 100%, 75% and 50%.
Example:
Let's assume that a three-phase motor working as an intermittent load has the following values:
Rated power = 100 kW (the nameplate mechanical power that is derived by a particular motor)
Brake power (also called shaft power) = 80 kW (80% of the rated power)
Y = 0.5
Power factor at full load = 0.85
Efficiency at full load = 0.9
Power factor at break point = 0.826 (at 80 % of the rated active power)
Efficiency at break point = 0.884 (at 80 % of the rated active power). These calculated values
are the result of calculating the power factor at 75% = 0.82 and efficiency at 75% = 0.88.
For motors, these values are interpolated from three given points. For static loads the values
are provided only once.

Active power (electrical):

P
= P mechanical / ( efficiency at working point))
Prated = 100 kW/0.9 = 111.1kW
Pconsumed = 80 kW/0.884 = 90.5kW
Reactive power:
Q
= P * tan (arcos (cos ))
Qrated = 111.1 * tan (arcos 0.85) = 68.9 kVAR

SmartPlant Electrical User's Guide

215

Calculating Bus Load Summaries

Qconsumed = 90.5 * tan (arcos 0.826) = 61.8 kVAR


Apparent power:
2
2
S = (P + Q )

Srated (111.1 + 68.9 ) = 130.7 kVA


2
2)
Sconsumed = (90.5 + 61.8 = 109.6 kVA
Full load current (FLC) for a three-phase load (with 380 VAC line voltage):
FLC = Srated / (U * 3)
FLC = 131000 / (380 * 3) = 198.6 A
2

Static Load Power Calculation Mechanism


For static loads, the power calculation is rather simple. No interpolation is performed by the
software to find the power factor and efficiency values at work point. The software calculates the
rated power kW, kVAR, and kVA values using efficiency and power factor values once at 100% of
a full load and once at demand (working) work point. However, you have to enter the power
factor and efficiency values yourself. The rest of the calculation is the same as for motors.

Special Cases (Junction Boxes and Cabinets)


For some item types, such as junction boxes and other panels, the software does not perform the
triangular power calculation even if their Is Load property has been set to True.. For these items,
you need to enter the active and reactive power values manually. SmartPlant Electrical does not
calculate apparent power for these items.
SmartPlant Electrical does not calculate compensated values for loads. These
calculations are performed for circuits and buses.

Compensated and Uncompensated Electrical Load Values


As opposed to individual loads, for which only uncompensated values are calculated and retained,
for circuit and buses, the software operates with two sets of load data values:
Uncompensated values rated and consumed electrical load kW, kVAR, and kVA values
without applying coincidence factors. The software rolls up these values from the loads
connected to specific circuits or buses.

216

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Compensated values rated and consumed electrical load kW, kVAR, and kVA values
multiplied by coincidence factors. It is possible to instruct the software to use one of the
following coincidence factors as shown on the Reports tab of the Preferences dialog box:

Use each load coincidence factor coincidence factor values of individual loads
Use Bus PDB coincidence factor bus coincidence factor values

Example
Let's assume that an intermittent load has the following values:
Rated active power = 11.1 kW
Rated reactive power (calculated or entered manually) = 6.9 kVAR
Consumed active power = 8.5 kW
Consumed reactive power = 5.9 kVAR
Operating mode = intermittent
Y = 0.5 (intermittent coincidence factor)
The uncompensated values would be as follows:
Uncompensated rated active power = 11.1 kW
Uncompensated rated reactive power = 6.9 kVAR
Uncompensated consumed active power = 8.5 kW
Uncompensated consumed reactive power = 5.9 kVAR
The compensated power values would be as follows (uncompensated values multiplied by the
coincidence factor):
Compensated rated active power = 5.55 kW
Compensated rated reactive power = 3.45 kVAR
Compensated consumed active power = 4.25 kW
Compensated consumed reactive power = 2.95 kVAR

Bus and circuit totals depend on the settings of your preferences. Therefore, run the bus load
calculation to update the total values in the bus, circuit, and load properties.
Electrical items are included in calculations if they are defined as consumers. In addition to
loads, you can define converting equipment items, cabinets, local panels, and junction boxes
as consumers. To define an electrical item as a consumer, you have to set the Is Load
property in the Properties window for that item to True or define the electrical item as a

SmartPlant Electrical User's Guide

217

Calculating Bus Load Summaries


Consumer in the relevant Common Properties dialog box. See the Bus Load Configuration
Examples.pdf., pages 12 and 23.
If you define a converting equipment item, local panel, or junction box as a consumer and
perform a drill-down calculation, the software uses the rated and consumed electrical load
values of the equipment as the load values, the software ignores the entire branch that is
connected downstream from the equipment. Note that you enter the pertinent rated and
consumed electrical load values on the Common Properties dialog box of the equipment
item. See the Bus Load Configuration Examples.pdf., pages 12 and 23.
It is also possible to instruct the software not to perform a drill-down and roll-up of a bus. You
can do this by setting the Drill Down Enable Flag property to False in the Properties
window. In this case, the software will take into account only the manually entered consumed
/ rated active or reactive values of that particular bus.
Loads associated with PDBs are taken into account whether or not they are connected via
circuits. See the Bus Load Configuration Examples.pdf., pages 5 - 9, 20, 12, and 22 - 27.
Circuit connection mode (Connected or Disconnected) affects the calculation
results. Disconnecting a circuit excludes the downstream connected load from the
calculation.
The circuit properties store the total value of the load that is connected to it as follows:
The properties of feeder circuits that feed direct loads store the load data. See the Bus
Load Configuration Examples.pdf., pages 5 - 9 and 12 -14.
The properties of feeder circuits that feed downstream buses whether directly or through
converting equipment store the downstream bus load total values. Practically, these
values will be the same as for the buses that are fed by these circuits. See the Bus Load
Configuration Examples.pdf., page 16.
The properties of coupler circuits store the total values of the bus is connected to the
corresponding riser provided that your preferences have been set do so. If your
preferences are set to exclude the couplers, the calculation results for the coupler circuits
will be null. See the Bus Load Configuration Examples.pdf., page 17.
The properties of riser circuits store the total values of the bus that is connected to the
feeding coupler. If your preferences are set to exclude risers, the calculation results for
riser circuits will be null. See the Bus Load Configuration Examples.pdf., pages 17 - 18.
If your preferences are set to take into account converting equipment losses, the circuit total
calculation results will include the kVAR and kW losses as continuous values. See the Bus
Load Configuration Examples.pdf., page 10.
It is also possible to calculate a bus load summary for a freestanding bus.
For more information, see the following topics:
Connectivity Across Buses (see "Connectivity Between Buses" on page 219)
Calculating Bus Loading (on page 224)
Correcting Bus Power Factors Using Capacitor Banks (on page 247)
Bus Load Calculation Preferences (on page 248)
Handling Special Cases of Bus Load Calculations (on page 248)
Calculating Electrical Consumption During Batch Load Association (see "Calculating
Electrical Consumption After Batch Load Association" on page 249)
Flow of Activities for Bus Load Calculations (on page 249)
Bus, Circuit, and Converting Equipment Properties (on page 250)

218

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Connectivity Between Buses


Calculating bus loading amounts to summing up all the loads that are connected a specific bus.

Circuit Mode
The calculation of bus load summary depends on the mode of the circuits. The circuit mode
property can be Connected or Disconnected and it controls whether the loads are connected or
disconnected to the bus. You set the circuit mode on the Circuit Common Properties dialog
box or in the Properties window. Setting the circuit mode to Connected means that power flows
through the circuit and it acts as a connecting line between the power source and the consumer
device. Setting the circuit mode to Disconnected interrupts the circuit connectivity and it means
the power is not flowing therefore, the downstream connected loads or buses are not taken into
account in the calculation.
The following situations can arise when identifying the buses that are connected to a particular
bus:

Loads Connected Directly to a Bus


As shown in the diagram below, the loads are connected directly to the bus, which means that
they are connected to the bus via a circuit or directly even without a cable. A load can be
connected via a junction box or any other connecting item such as a panel, bus way, and so forth,
all of which are transparent to the bus load association. Example:

SmartPlant Electrical User's Guide

219

Calculating Bus Load Summaries

In the Electrical Engineer:

In a single line diagram:

The software also takes into account loads that are connected in parallel and loads that are
connected in a daisy chain. For details, see Configuration H: Loads Connected in Parallel (see
"Configuration I: Multiple Loads Connected by a Junction Box" on page 241) and Configuration I:
Loads Connected in a Daisy-Chain Pattern (see "Configuration J: Loads Connected in a
Daisy-Chain Pattern" on page 243).

220

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


Loads Connected Indirectly to a Bus (Via Converting Equipment)
In this case, the loads are connected to a bus indirectly. That is, the loads are connected through
a transformer, a variable frequency drive, or any other converting equipment item within the circuit
internals or external to the circuit.

SmartPlant Electrical User's Guide

221

Calculating Bus Load Summaries


In a single line diagram:

222

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


Buses Connected Via Feeder-Incomer Circuits
The image below shows a configuration of buses that feed downstream buses through a pair of
feeder-incomer circuits.

As shown above, the loads that connect the upper bus are the direct loads as well as all the
downstream connected buses which in turn also have loads that are connected to them
directly. Any calculation of the upper bus also takes into account the downstream connected
loads. Note that the software does not set any limitation on the number of downstream levels of
buses for a network. The software makes a recursive calculation.

SmartPlant Electrical User's Guide

223

Calculating Bus Load Summaries


Buses Connected Via Coupler-Riser Circuits
Buses can also be connected to each other by sets of coupler-riser circuits. Such a connection is
usually used for connecting buses of the same voltage level mainly for redundancy and backup
purposes when one bus can take over the loads of the coupled bus in case there is a power
source loss in one of the adjacent buses.

Bus 400V, 500A, 3PH and bus 120V, 500A,3PH are coupled (connected) by the coupler and riser
circuits which in principle serve as mutual backups for power supply.

Calculating Bus Loading


Calculating bus loading amounts to summing up all the loads that are connected a particular
bus. When calculating the total loads connected to a bus, the software calculates the bus totals,
stores the individual subtotals in the database as calculated properties and then makes these
calculated properties accessible for reporting. During this stage, you can sum them up any way
you see appropriate.
In general, the total load of a bus is a variation of the sum of its active and reactive
vectors. SmartPlant Electrical calculates these totals for each load by adding up the direct and
downstream rolled up loads. Then, SmartPlant Electrical stores these results in the database.

224

The software takes into account any existing equipment that is connected in parallel.
When making calculations, SmartPlant Electrical considers the worst case scenario in its
calculation results and does not take into account any load flow that would be taken into
account by a power analysis application such as ETAP. That is, for calculation purposes,

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


SmartPlant Electrical always assumes that the total connected load is supplied from one
source only. If there are multiple sources that supply the same connected load, SmartPlant
Electrical assumes that each source has the capability to supply the connected load.
SmartPlant Electrical, unlike any power analysis application, does not account for multiple
sources that share a load. Consequently, in SmartPlant Electrical, the total load for a
distribution network can appear artificially high unless the Circuit Mode property is set to either
Connected or Disconnected as desired on specific circuits.

Bus Values Used in Calculations


Bus Rated Power Values
Total uncompensated continuous active power
Total uncompensated continuous reactive power
Total uncompensated intermittent active power
Total uncompensated intermittent reactive power
Total uncompensated standby active power
Total uncompensated standby reactive power
Total uncompensated spare active power
Total uncompensated spare reactive power
Total compensated continuous active power
Total compensated continuous reactive power
Total compensated intermittent active power
Total compensated intermittent reactive power
Total compensated standby active power
Total compensated standby reactive power
Total compensated spare active power
Total compensated spare reactive power
Bus Consumed Power Values
Total uncompensated continuous active power
Total uncompensated continuous reactive power
Total uncompensated intermittent active power
Total uncompensated intermittent reactive power
Total uncompensated standby active power
Total uncompensated standby reactive power
Total uncompensated spare active power
Total uncompensated spare reactive power
Total compensated continuous active power
Total compensated continuous reactive power
Total compensated intermittent active power
Total compensated intermittent reactive power
Total compensated standby active power
Total compensated standby reactive power
Total compensated spare active power
Total compensated spare reactive power

SmartPlant Electrical User's Guide

225

Calculating Bus Load Summaries


Circuit Load Calculation
SmartPlant Electrical stores downstream load totals in the respective circuit items. The following
rules apply to the data that a circuit stores:
Feeder circuits hold the values of the total downstream connected load (if there is more
than one load connected to a circuit, the circuit stores the total values for all the connected
loads).
Incomer circuits store the total load of the bus that the incomer circuit is feeding. Note
that the incomer circuit values and total bus values should be the same.
Coupler circuit stores the values of the load of the coupled bus.
Riser circuits store the values of the bus that has the coupler, opposite the riser
circuit. That is, each coupler-riser paired circuit stores the values of its counterpart.

Calculating the Total Bus Loading


SmartPlant Electrical calculates the following grand totals of bus loading for each set of the bus
rated power values and bus consumed power values:

Rated Power (Compensated and Uncompensated)

Total running bus active load


Total running bus reactive load
Total running bus apparent load
Running bus power factor
Total peak bus active load
Total peak bus reactive load
Total peak bus apparent load
Peak bus power factor

Consumed Power (Compensated and Uncompensated)

Total running bus active load


Total running bus reactive load
Total running bus apparent load
Running bus power factor
Total peak bus active load
Total peak bus reactive load
Total peak bus apparent load
Peak bus power factor

Bus Run Power Grand Total


The total running load is defined as the sum of the continuous and intermittent loads,
compensated or uncompensated, respectively. Active and reactive loads are summarized and
stored in separate properties. Rated and consumed values are also stored in separate properties.

Uncompensated Run Power Total


(Prun) = (Pcontinuous) + (Pintermittent)
(Qrun) = (Qcontinuous) + (Qintermittent)

226

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


Compensated Run Power Total Using Individual Load Coincidence Factors
The coincidence factor of each load is taken into account separately.
(Prun) = (X * Pcontinuous) + (Y * Pintermittent)
(Qrun) = (X * Qcontinuous) + (Y * Qintermittent)

Compensated Run Power Total Using Bus Load Coincidence Factors


The software uses the bus coincidence factors to make the calculation. The coincidence factor of
each load has no effect on the calculation.
(Prun) = (Pcontinuous) * X bus + (Pintermittent) * Y bus
(Qrun) = (Qcontinuous) * X bus + (Qintermittent) * Y bus

Bus Peak Power Grand Total


The total peak load is defined as the sum of the continuous, intermittent, standby, and spare loads
- compensated and uncompensated respectively.

Uncompensated Peak Power Total


(Ppeak) = (Pcontinuous) + (Pintermittent) + (Pstandby) + (Pspare)
(Qpeak) = (Qcontinuous) + (Qintermittent) + (Qstandby) + (Qspare)

Compensated Peak Power Total Using Individual Load Coincidence Factors


The coincidence factor of each load is taken into account separately.
(Ppeak) = (X * Pcontinuous) + (Y * Pintermittent) + (Z * Pstandby) + (ZZ * Pspare)
(Qpeak) = (X * Qcontinuous) + (Y * Qintermittent) + (Z * Qstandby) + (ZZ * Qspare)

Compensated Peak Power Total Using Bus Load Coincidence Factors


The software uses the bus coincidence factors to make the calculation. The coincidence factor of
each load has no effect on the calculation.
(Ppeak) = (Pcontinuous) * XB + (Pintermittent) * YB + (Pstandby) * ZB +(Pspare) * ZZB
(Qpeak) = (Qcontinuous) * XB + (Qintermittent) * YB + (Qstandby) * ZB +(Qspare) * ZZB

Calculating Bus Grand Total Apparent Power


3

The bus grand total apparent power is calculated 2 = 8 times (for run and peak, compensated
and uncompensated, rated versus consumed power) as a vector sum of grand total of active and
reactive power:
(S) = ((P)) + (Q)) )
Where:
2

P) active power total


Q) reactive power total

SmartPlant Electrical User's Guide

227

Calculating Bus Load Summaries


Calculating Bus Power Factor
The following formula is used to calculate bus power factors (PF):
PF = (P) / (S)
Where:
(P) active power total
(S) apparent power total
This calculation is also performed eight times: for (run and peak) * (compensated and
uncompensated) * (rated and consumed).

Calculating Bus Line Current


The following formula is used to calculate bus line current:
I = (S) / (U * 3) in amperes
Where:
(S) compensated apparent power
(U) bus rated voltage (line voltage)
This calculation is performed only four times. It is made for compensated values only: (run and
peak) * (rated and consumed).

Bus Load Configuration Examples


The following configurations provide calculation examples that illustrate various calculation flows
and processes performed by the software. The calculation charts are contained in a PDF file
located in your SmartPlant Electrical installation folder, for example C > Program Files >
SmartPlant > Electrical >Program > Bus Load Configuration Examples.PDF

Configurations A and B: A Single Load Connected to a Bus


The following explanation refers to the Bus Load Configuration Examples.pdf., pages 5 - 9.
The example below illustrates a configuration in which a single load with different operation modes
is connected to a bus with or without a circuit.

Load Power Parameters


A three-phase asynchronous motor loaded at 75% of its rated power connected to a bus by a
feeder circuit. The following parameters have been used:
Motor rated power = 10 kW
Break power = 7.5 kW
Coincidence factors:
X=1
Y = 0.5
Z = 0.1
ZZ = 0.05
Efficiency and power factor at full load = 0.82
You can connect the motor to the bus via a feeder (indirect connection) or without a feeder (direct
connection).

228

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


The following two images show the connection of Motor M-30 without a feeder.
In the Electrical Engineer:

In a single line diagram:

The following two images show the connection of Motor M-2 to Bus A through a feeder.

SmartPlant Electrical User's Guide

229

Calculating Bus Load Summaries


In the Electrical Engineer:

In a single line diagram:

The calculation results remain the same in both cases, regardless of whether the
connection is direct or indirect.

230

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Configuration C: Bus Totals with or without Converting


Equipment Losses
The following explanation refers to the Bus Load Configuration Examples.pdf., pages 10 - 12.
The example below illustrates a configuration in which a single load is connected to a bus through
a feeder circuit and a VFD.
The load parameters are as follows:
Motor rated power = 10 kW
Break power = 7.5 kW
Standby operation mode (Z = 0.1)
Efficiency at full level = 0.9
Power factor at full load = 0.85
When operating as a converting equipment device, the VFD parameters are as follows:
Resistive power losses = 1 kW
Reactive power losses = 1 kVAR
Continuous operational mode (X = 1.0)
When operating as a load, the VFD parameters are as follows:
Rated active power = 8 kW
Rated reactive power = 2 kVAR
Consumed reactive power = 1.5 kVAR
Continuous operating mode (X = 1.0)
The following two images show the connection of Motor M-9.
In the Electrical Engineer:

SmartPlant Electrical User's Guide

231

Calculating Bus Load Summaries


In a single line diagram:

Accounting for Converting Equipment Power Losses


When running bus load calculations, you can instruct the software to take into account converting
equipment power losses. The software adds these power losses to the upstream feeding bus
and circuits. The software treats them as continuous loads and includes their values in both
compensated and uncompensated calculations. The same losses are also taken into account in
the All Feeder Load Summary and PDB Load Summary reports.

232

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


To account for converting equipment power losses, select the Account for converting
equipment power losses check box on the Reports tab of the Preferences dialog box.

See pages 10 and 11 of the Bus Load Configuration Examples.pdf., file for bus total calculation
configuration examples with and without the converting equipment losses.

Defining Converting Equipment as Consumers


You can define converting equipment items as consumers. This allows you to include these items
in the calculations of load summaries, load associations, and when generating enhanced all
feeder load summary reports.
For details, see Define Converting Equipment as Consumers (on page 104).
Once you define the VFD as a consumer, the load properties of the converting equipment replace
the load parameters of the loads that are connected downstream of the VFD. The operation mode
and coincidence factors that are used for the bus totals are now derived from the VFD and not
from the downstream loads. See page 12 of the Bus Load Configuration Examples.pdf., for
calculation examples with converting equipment defined as consumers.

Configuration D: Bus Totals Accounting for Load or Bus


Coincidence Factors
The following explanation refers to the Bus Load Configuration Examples.pdf., pages 13 - 14. This
example is based on a configuration of multiple loads with different operation modes connected to
the same bus.
SmartPlant Electrical enables you to calculate compensated loads in two ways. You can do one of
the following:
Use the coincidence factor of each individual load. When calculating the compensated load
values, the software multiplies the raw uncompensated load kW and kVAR values by the load
coincidence factors. See the Bus Load Configuration Examples.pdf., page 12.
Use the average coincidence factors of the bus. When calculating the compensated load
values, the software multiplies the raw uncompensated load kW and kVAR values by the
coincidence factors as defined in the properties of the buses that these loads are connected

SmartPlant Electrical User's Guide

233

Calculating Bus Load Summaries


to. Make sure that you specify these coincidence factors for each bus. See the Bus Load
Configuration Examples.pdf., page 13.
Loads that are connected to a bus through circuits that are defined as disconnected do not
contribute to the bus load summary calculation.

Configuration E: A Bus with Mixed Loads


The following explanation refers to the Bus Load Configuration Examples.pdf., page 16.
This example illustrates how SmartPlant Electrical handles the calculation of a bus load summary
of several loads that have a variety of load parameters.
In the images below, note that the power parameters are rolled up to the bus from the loads that
are connected to the bus in various ways: directly, through converting equipment, and the total
from another bus on a lower level.
In the Electrical Engineer:

234

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


In a single line diagram:

SmartPlant Electrical User's Guide

235

Calculating Bus Load Summaries

Configuration F: Coupled Buses


The following explanation refers to the Bus Load Configuration Examples.pdf., pages 17 - 19.
The images below display a typical situation in which two buses that have the same voltage are
tied by coupler and riser circuits.
In the Electrical Engineer:

236

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


In a single line diagram:

SmartPlant Electrical makes it possible to calculate the total of bus loads for coupled buses in one
of three ways depending on your report preference setting:
Do not include coupled buses Includes in the calculation only those loads that are connected
to the current bus and does not include the loads that are connected on the redundant buses.
See the Bus Load Configuration Examples.pdf., page 17.
Include coupled buses connected by couplers only Includes in the calculation the loads
connected on the current bus as well as loads connected on all the redundant buses that are
connected to the current bus by a coupler circuit. See the Bus Load Configuration
Examples.pdf., page 18.
Include coupled buses connected by couplers and risers Includes in the calculation the
loads of the current bus as well as the loads on all the redundant buses that are connected to the
current bus by coupler and riser circuits. See the Bus Load Configuration Examples.pdf., page
19.

SmartPlant Electrical User's Guide

237

Calculating Bus Load Summaries

Configuration G: Loads Powered by an Alternative Power


Source
The following explanation refers to the Bus Load Configuration Examples.pdf., page 20.
SmartPlant Electrical allows you to specify two power sources for equipment: a primary source
and an alternative source. When calculating a bus load summary, note the following:
Alternative source circuit mode is automatically set to Disconnected by the software.
Loads that are connected to circuits for which the circuit mode value is Disconnected appear
in bus load summaries, but the software does not take those loads into account in the total
load calculation.
If a load is connected to a dual power source that originates from the same feeding upstream
bus, the software does not count such a load twice and accounts for it correctly in load
summaries and other load calculations.
For batch load association calculations, a load connected to a circuit in Disconnected mode
is only displayed in the Associated loads data window of the Bus Load Association dialog
box. Such a load does not appear in the Calculation results group box. There is no need to
set the circuit mode as Connected or Disconnected for loads that have an alternative power
source. The software automatically sets the circuit mode of these loads to Disconnected.
For more information, see Using Dual Source Power Supplies (on page 119) and Associate a Dual
Power Supply with an Equipment Item (on page 120).
The following is an example of a load connected to a dual power supply where load M2 is
connected to the main feeder F-11 and an alternative feeder F-12 on the same bus.
In the Electrical Engineer:

238

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


In a single line diagram:

Configuration H: Loads Connected in Parallel


The following explanation refers to the Bus Load Configuration Examples.pdf., page 21.
Starting from v2009 SP3, SmartPlant Electrical supports parallel connection of loads. (For details,
see Define Parallel Equipment (on page 200).) Once a number of loads have been connected to
the same feeder, the software treats them as loads connected directly to a given bus. These loads
are taken into account whenever you perform a bus load calculation.
The example below illustrates a configuration in which three motors have been connected to the
same feeder

SmartPlant Electrical User's Guide

239

Calculating Bus Load Summaries


In the Electrical Engineer:

In a single line diagram:

240

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Configuration I: Multiple Loads Connected by a Junction Box


The following explanation refers to the Bus Load Configuration Examples.pdf., pages 22- 23.
The example below illustrates a configuration in which three motors have been connected to the
same feeder circuit through a junction box or local panel. Such a connection is treated as a type of
parallel connection. As in a parallel connection, each load is connected through a junction box or
local panel and the operating mode of each load is different from the operating mode of the other
loads connected to that junction box.
In the Electrical Engineer:

SmartPlant Electrical User's Guide

241

Calculating Bus Load Summaries


In a single line diagram:

242

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Configuration J: Loads Connected in a Daisy-Chain Pattern


The following explanation refers to the Bus Load Configuration Examples.pdf., page 24.
SmartPlant Electrical makes it possible to connect several loads in a daisy-chain pattern. (For
details, see Create a Daisy-Chain Connection Pattern (on page 202).) Once a number of loads
have been connected in a daisy-chain pattern, the software treats them as loads connected
directly to a given bus. These loads are taken into account whenever you perform a bus load
calculation.
The example below illustrates a configuration in which three motors have been connected in a
daisy-chain pattern.
In the Electrical Engineer:

SmartPlant Electrical User's Guide

243

Calculating Bus Load Summaries


In a single line diagram:

244

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Configuration K: A Space Heater Connected to an Auxiliary


Contact
The following explanation refers to the Bus Load Configuration Examples.pdf., page 25.
The following example refers to a situation where a space heater is connected to an auxiliary
contact. The space heater and the auxiliary contact are powered from a bus that does not feed
the main equipment. The space heater bus and the main equipment bus do not have to belong to
the same PDB. These two buses can belong to different PDBs if needed.
In the Electrical Engineer:

SmartPlant Electrical User's Guide

245

Calculating Bus Load Summaries


In a single line diagram:

246

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Correcting Bus Power Factors Using Capacitor Banks


When running batch load association and calculating the electrical consumption for a bus, the
software allows you to calculate the power factor of a capacitor bank that needs be associated
with the selected bus so that you can correct the power factor of that bus. Creating a capacitor
bank that has the power factor you just calculated and associating this capacitor bank with the
current bus corrects the bus power factor when calculating the electrical consumption of the bus.
The formula that SmartPlant electrical uses to calculate the required correction factor is as follows:

Where:
Qcb = Reactive Power of the Capacitor Banks to be connected to the bus in order to have the
desired cosd.
P = The active power drawn from the bus.
Q = The reactive power drawn from the bus before connecting the power factor compensating
capacitor.
1. On the Bus tab of the Batch Load Association dialog box, type a value under Required
power factor. This value determines the required power factor for the selected bus.
2. Click the Loads tab.
3. Under Electrical consumption using coincidence factors, select the For all feeders
option in order to make sure that the software performs a calculation that includes all
downstream loads and not only the ones that are connected directly. Also, the software will
recalculate the electrical consumption and the required corrective reactive power for the
selected bus.

4.
5.
6.
7.
8.
9.
10.
11.

If you choose to close the Batch Load Association dialog box at this time, you can also
run this calculation by clicking Actions > Calculate Bus Loads > Selected PDBs or Buses.
On the Batch Load Association dialog box, click the Loads tab.
Under Required capacitor correction [kVAR], copy the calculated value. You can copy
either total running load or the total peak load value as you require.
Click OK on the Batch Load Association dialog box.
In the Electrical Index, create a new capacitor bank. For details, see Create Static Electrical
Equipment (on page 85).
On the Common Properties dialog box for the new capacitor bank, click the Load Data tab.
Under Rated power, paste in the Required capacitor correction [kVAR] value that you
copied from the Batch Load Association dialog box.
Click the Feeder Data tab and associate the current capacitor bank with the bus for which you
ran the electrical consumption calculation.
Click OK to accept the values you entered and close the Common Properties dialog box.

You can now open the Batch Load Association dialog box and recalculate the bus load
consumption for that bus. Under Power factor@Run and Power factor@Peak, You can see
the newly calculated power factor values for the current bus associated with the new capacitor
bank while the value under Required capacitor correction value is zero or close to zero.

SmartPlant Electrical User's Guide

247

Calculating Bus Load Summaries

Handling Special Cases of Bus Load Calculations


You should pay special attention to the way SmartPlant Electrical treats and takes into account
certain item types when calculating bus loading.
Three-winding transformers A bus feeding a two-winding transformer takes into account
both the secondary and tertiary connected loads and buses.
Transfer switch (a special PDB with two incomers and one feeder) Make sure that you
connect the incomer circuit that you require.
Equipment connected to an alternative power source The software treats equipment
with two power sources as one load for each of the power paths. See the Bus Load
Configuration Examples.pdf., page 20.
Bus Drill Down Enabled property If, in the Properties window, you set this property to False,
the software does not roll up any of its connected direct or indirect loads. Instead, the software
takes into account the rated and consumed power values that you have entered manually in the
Properties window of each respective bus.

Bus Load Calculation Preferences


SmartPlant Electrical calculates bus load summaries according to the preferences that you set on
the Reports tab of the Preferences dialog box. The options are as follows:
Use each load coincidence factor When calculating the compensated load values, the
software multiplies the raw uncompensated load kW and kVAR values by the load coincidence
factors. See the Bus Load Configuration Examples.pdf., page 13.
Use Bus PDB coincidence factor When calculating the compensated load values, the
software multiplies the raw uncompensated load kW and kVAR values by the coincidence
factors as defined in the properties of the buses that these loads are connected to. Make sure
that you specify these coincidence factors for each bus. See the Bus Load Configuration
Examples.pdf., page 14.
Do not include coupled buses When calculating bus totals, the software ignores adjacent
coupled buses (regardless of whether they are connected via couplers or risers). The
software does not take into account these adjacent buses and treats them as if they are
disconnected. See the Bus Load Configuration Examples.pdf., page 17.
Include coupled buses connected by couplers only When calculating bus totals, the
software includes adjacent bus loads connected via couplers and excludes the buses
connected via risers. See the Bus Load Configuration Examples.pdf., page 18.
Include coupled buses connected by couplers and risers When calculating bus totals,
the software includes adjacent bus loads connected via couplers and risers (full redundancy).
See the Bus Load Configuration Examples.pdf., page 19.
Account for converting equipment power losses When running bus load calculations,
allows you to instruct the software to calculate the total electrical consumption taking into
account converting equipment power losses. The software adds these power losses to the
upstream feeding circuits and bus and takes them into account as continuous loads. The
same losses are also taken into account in the All Feeder Load Summary and PDB Load
Summary reports. See the Bus Load Configuration Examples.pdf., page 10.
Disconnected Circuits If the mode of a circuit is set to Disconnected, SmartPlant
Electrical ignores this circuit in the calculation regardless of the preference settings. See the
Bus Load Configuration Examples.pdf., page 15.

248

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Calculating Electrical Consumption After Batch Load


Association
When running batch load association and calculating electrical consumption for all the feeders,
SmartPlant Electrical uses the same algorithm as the bus loading calculation. Note that all the
values for the electrical consumption in batch load association are consumed and compensated
for their coincidence factors whether for individual loads or the current bus as set in the
preferences.
Also, the software calculates line current and power factors at run and peak conditions using
consumed values.
SmartPlant Electrical calculates electrical consumption for a selected bus, all the rolled up buses,
and the loads associated with that bus.
The software takes into account any existing equipment that is connected in parallel.
The software makes all the calculations based on the phase filter in the batch load association.
As with bus load calculations, SmartPlant Electrical stores the calculated electrical consumption
results in the database.

Flow of Activities for Bus Load Calculations


The following is a suggested flow of activities for bus load calculations.
1. In the Electrical Index or Electrical Engineer, select the buses or power distribution boards
(PDBs) for which you want to calculate a bus load summary. You can select one bus or
multiple buses as the starting point of the calculation.
2. Do one of the following to start the calculation process:
Calculate the bus loads for the selected buses or PDBs. (see "Calculate Bus Loads for
Selected Buses or PDBs" on page 253)
Calculate the bus loads for all the buses in the current plant. (see "Calculate Bus Loads
for All the Buses in the Plant" on page 253)
Generate a calculation report for the buses you selected (see "Generate an Enhanced All
Feeder Load Summary Report" on page 254).
The displayed calculation results are correct only for a specific situation. That is, the
results are true only for the loads that you selected and the property values that you entered for
these loads. The preference settings that you chose for these loads also affect the calculation
results. The calculation results do not change automatically if you add a load, change a load
property, or select a different preference setting.. To get up-to-date results, you have run the
calculation again.

You can customize the Enhanced All Feeder Load Summary report according to your needs.
For details, see Customizing the Enhanced All Feeder Load Summary Report (on page 390).
You use the calculation results as a basis for equipment sizing.

SmartPlant Electrical User's Guide

249

Calculating Bus Load Summaries

Bus, Circuit, and Converting Equipment Properties


After calculating bus loading, SmartPlant Electrical uses the following bus, circuit, and converting
equipment properties to store the calculation results:

Bus Properties
Calculated Line Currents @ Using Coincidence Factor Compensated Load Data

LineCurrent_Normal_Consumed
LineCurrent_Peak_Consumed
LineCurrent_Normal_Rated
LineCurrent_Peak_Rated

Calculated Total Rolled Up Bus Loading @ Using Consumed Load Data Compensated by
Coincidence Factors

ComplRolledupRunActiveLoad_Consumed
CompRolledupRunReactiveLoad_Consumed
CompRolledupRunApparentLoad_Consumed
CompRolledupRunPowerFactor_Consumed
CompRolledupPeakActiveLoad_Consumed
CompRolledupPeakReactiveLoad_Consumed
CompRolledupPeakApparentLoad_Consumed
CompRolledupPeakPowerFactor_Consumed

Calculated Total Rolled Up Bus Loading @ Using Rated Load Data Compensated by
Coincidence Factors

CompRolledupRunActiveLoad_Rated
CompRolledupRunReactiveLoad_Rated
CompRolledupRunApparentLoad_Rated
CompRolledupRunPowerFactor_Rated
CompRolledupPeakActiveLoad_Rated
CompRolledupPeakReactiveLoad_Rated
CompRolledupPeakApparentLoad_Rated
CompRolledupPeakPowerFactor_Rated

Calculated Total Rolled Up Bus Loading @ Using Consumed Load Data Without
Compensation of Coincidence Factors

250

UncompRolledupRunActiveLoad_Consumed
UncompRolledupRunReactiveLoad_Consumed
UncompRolledupRunApparentLoad_Consumed
UncompRolledupRunPowerFactor_Consumed
UncompRolledupPeakActiveLoad_Consumed
UncompRolledupPeakReactiveLoad_Consumed
UncompRolledupPeakApparentLoad_Consumed
UncompRolledupPeakPowerFactor_Consumed

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries


Calculated Total Rolled Up Bus Loading @ Using Rated Load Data Without Compensation
of Coincidence Factors

UncompRolledupRunActiveLoad_Rated
UncompRolledupRunReactiveLoad_Rated
UncompRolledupRunApparentLoad_Rated
UncompRolledupRunPowerFactor_Rated
UncompRolledupPeakActiveLoad_Rated
UncompRolledupPeakReactiveLoad_Rated
UncompRolledupPeakApparentLoad_Rated
UncompRolledupPeakPowerFactor_Rated

Calculated Total Rolled Up Bus Loading per Operating Modes @ Using Consumed Load
Data with Compensation of Coincidence Factors

CompRolledupContinuousActiveLoad_Consumed
CompRolledupContinuousReactiveLoad_Consumed
CompdRolledupIntermittentActiveLoad_Consumed
CompRolledupIntermittentReactiveLoad_Consumed
CompRolledupStandbyActiveLoad_Consumed
CompRolledupStandbyReactiveLoad_Consumed
CompRolledupSpareActiveLoad_Consumed
CompRolledupSpareReactiveLoad_Consumed

Calculated Total Rolled Up Bus Loading per Operating Modes @ Using Rated Load Data
with Compensation of Coincidence Factors

CompRolledupContinuousActiveLoad_Rated
CompRolledupContinuousReactiveLoad_rated
CompdRolledupIntermittentActiveLoad_Rated
CompRolledupIntermittentReactiveLoad_Rated
CompRolledupStandbyActiveLoad_Rated
CompRolledupStandbyReactiveLoad_Rated
CompRolledupSpareActiveLoad_Rated
CompRolledupSpareReactiveLoad_Rated

Calculated Total Rolled Up Bus Loading per Operating Modes @ Using Consumed Load
Data Without Compensation of Coincidence Factors

UncompRolledupContinuousActiveLoad_Consumed
UncompRolledupContinuousReactiveLoad_Consumed
UncompRolledupIntermittentActiveLoad_Consumed
UncompRolledupIntermittentReactiveLoad_Consumed
UncompRolledupStandbyActiveLoad_Consumed
UncompRolledupStandbyReactiveLoad_Consumed
UncompRolledupSpareActiveLoad_Consumed
UncompRolledupSpareReactiveLoad_Consumed

SmartPlant Electrical User's Guide

251

Calculating Bus Load Summaries


Calculated Total Rolled Up Bus Loading per Operating Modes @ Using Rated Loads Data
Without Compensation of Coincidence Factors

UncompRolledupContinuousActiveLoad_Rated
UncompRolledupContinuousReactiveLoad_Rated
UncompRolledupIntermittentActiveLoad_Rated
UncompRolledupIntermittentReactiveLoad_Rated
UncompRolledupStandbyActiveLoad_Rated
UncompRolledupStandbyReactiveLoad_Rated
UncompRolledupSpareActiveLoad_Rated
UncompRolledupSpareReactiveLoad_Rated

Circuit Properties
Calculated Total Rolled Up Circuit Loading per Operating Modes @ Using Consumed Load
Data Without Compensation of Coincidence Factors

UncompRolledupContinuousActiveLoad_Consumed
UncompRolledupContinuousReactiveLoad_Consumed
UncompRolledupIntermittentActiveLoad_Consumed
UncompRolledupIntermittentReactiveLoad_Consumed
UncompRolledupStandbyActiveLoad_Consumed
UncompRolledupStandbyReactiveLoad_Consumed
UncompRolledupSpareActiveLoad_Consumed
UncompRolledupSpareReactiveLoad_Consumed

Calculated Total Rolled Up Circuit Loading per Operating Modes @ Using Rated Load Data
Without Compensation of Coincidence Factors

UncompRolledupContinuousActiveLoad_Rated
UncompRolledupContinuousReactiveLoad_Rated
UncompRolledupIntermittentActiveLoad_Rated
UncompRolledupIntermittentReactiveLoad_Rated
UncompRolledupStandbyActiveLoad_Rated
UncompRolledupStandbyReactiveLoad_Rated
UncompRolledupSpareActiveLoad_Rated
UncompRolledupSpareReactiveLoad_Rated

Converting Equipment Properties


Converting Equipment Properties

252

ActiveLosses
ReactiveLosses

SmartPlant Electrical User's Guide

Calculating Bus Load Summaries

Calculate Bus Loads for Selected Buses or PDBs


To facilitate the sizing of electrical equipment such as generators, distribution transformers and
their feeder cables, buses, UPSs and so forth, SmartPlant Electrical enables you to calculate bus
load totals and store the results in the database. The software provides for a fast way to calculate
the bus load totals for all the existing buses in the plant. Alternatively, you can select the PDBs or
buses for which you want to perform the bus load calculation. SmartPlant Electrical stores the
calculation results in the database thus allowing you to generate an all feeder load summary
report for the calculated loads. The following procedure shows how to calculate load totals for
selected buses or PDBs.
1. In the Electrical Index, select the buses or PDBs for which you want to make the calculation.
2. Click Actions > Calculate Bus Loads > Selected PDBs or Buses.

The software makes the calculation and stores the results in the database.
You can now generate an enhanced all feeder load summary for the selected PDBs or buses.
The software takes into account any existing equipment that is connected in parallel.

Calculate Bus Loads for All the Buses in the Plant


To facilitate the sizing of electrical equipment such as generators, distribution transformers and
their feeder cables, buses, UPSs and so forth, SmartPlant Electrical enables you to calculate bus
load totals and store the results in the database. The software provides for a fast way to calculate
the bus load totals for all the existing buses in the plant. Alternatively, you can select the PDBs or
buses for which you want to perform the bus load calculation. SmartPlant Electrical stores the
calculation results in the database thus allowing you to generate an all feeder load summary
report for the calculated loads. This procedure shows how to calculate load totals for all the buses
in your plant.
Click Actions > Calculate Bus Loads > All Plant Buses.

The software makes the calculation and stores the results in the database.
You can now generate an enhanced all feeder load summary for the plant PDBs or buses.
The software takes into account any existing equipment that is connected in parallel.

SmartPlant Electrical User's Guide

253

Calculating Bus Load Summaries

Generate an Enhanced All Feeder Load Summary


Report
This procedure shows how to generate an enhanced all feeder load summary report for the
selected PDBs or buses. The software generates the report based on the values that it calculated
for the PDBs or buses that were saved to the database after the calculation.
1. In the Electrical Index, do one of the following:
Select all power distribution boards in your plant.
Select the buses or PDBs for which you ran the bus load calculation.
2. Click Reports > Plant Reports.
3. On the Plant Reports dialog box, select All Feeder Load Summary Report (Enhanced)
and click OK.
4. On the Report Preferences dialog box, select the following options:
To take into account the coincidence factors, select Compensated values. The
calculation results will be multiplied by the coincidence factor of each load or by the
coincidence factor of the bus depending on the selected preference option.
To ignore coincidence factors, select Uncompensated values. The calculation results
will not be multiplied by the coincidence factor of each load or by the coincidence factor of
the bus.
To display rated electrical consumption, select Rated values. The calculation results will
be based on the rated values of the electrical consumption values of the selected load.
To display consumed electrical consumption, select Consumed values. The calculation
results will be based on the consumed values of the electrical consumption values of the
selected load.
5. Click OK.
The software takes into account any existing equipment that is connected in parallel.

254

SmartPlant Electrical User's Guide

SECTION 16

Drawing Templates
Drawing templates are required for single line diagrams and schematics. A drawing template
specifies the page size and orientation of the drawing, and can include a border and title
block. Several standard drawing templates are delivered with the software. You usually create a
new drawing based on one of these existing templates. However, you can create new templates
or customize existing templates to meet your particular needs. This is accomplished inside
SmartPlant Electrical.
The default storage locations for single line diagram and schematic templates are specified in
Options Manager. If you create a new template, you store it on the server in order for it to be
available for drawing creation.
Also, the software comes with a set of files containing borders and title blocks that fit the delivered
drawing templates. If you create a new template, you may also need to create a new title block
that fits your template correctly and that contains the appropriate information. You can create title
blocks in Catalog Manager or in a suitable graphics application such as SmartSketch.
The software embeds symbols that you insert in the template. For this reason, if you
modify a border or title block symbol and you want the change to appear in all of your templates,
you must reinsert the symbol in each template individually.

Create a Drawing Template


1. Click File > New > Template.
2. Select the new blank template and click File > Sheet Setup.
3. On the Sheet Setup dialog box, select the desired page size and orientation for the template
from the list; for example, A4 Wide.
4. To add a border or title block, click Edit > Insert > Symbol.

5.
6.

7.
8.
9.

You must create the border or title block file in advance with suitable dimensions for the
template using Catalog Manager or a suitable graphics application such as SmartSketch.
The inserted symbol is embedded in the template. For this reason, if you modify a border
or title block symbol and you want the change to appear in all of your templates, you must
reinsert the symbol in each template individually.
On the Select Symbol File dialog box, navigate to the desired file and click Open to display it
in the drawing view.
To position the border on the template, do one of the following:
Press the ESCAPE key to lock the border on to the template in the correct position relative
to the origin.
Drag and drop the border in the position you require.
To add text to the template, click Edit > Insert > Text.
You can add other drawing objects in the appropriate file format or text if required by clicking
Edit > Insert > Symbol.
Click File > Save and type a name for the file in the desired location.

SmartPlant Electrical User's Guide

255

Drawing Templates
Drawing templates are saved in a special format that is recognized only in SmartPlant
Electrical. Files in the format have an .spe extension, and you can only create them in SmartPlant
Electrical.

Open a Drawing Template


1.
2.
3.
4.

Click File > Open > Template.


Navigate to the location where your templates are stored and select the desired template.
To edit the template, click File > Sheet Setup.
On the Sheet Setup dialog box, select the desired page size and orientation for the template
from the list; for example, A4 Wide.
5. To add a symbol to the template, click Edit > Insert > Symbol.

6.
7.
8.
9.
10.

You must create the drawing object in advance using Catalog Manager or a suitable
graphics application such as SmartSketch.
On the Select Symbol File dialog box, navigate to the desired file and click Open to display it
in the drawing view.
Move the drawing object to the desired position on the template.
To add text to the template, click Edit > Insert > Text.
Add or delete other drawing objects and text as required.
Click File > Save As and choose a name and location for the file.

Title Block Macros


You specify macros in your title block by adding SmartText from the Catalog Manager and
defining the appropriate macro in the user properties. For all the available properties in each
macro category, you should refer to the Data Dictionary. This topic describes a number of
examples of macros that you can use in SmartPlant Electrical drawing title blocks.

Plant Group Macros


The following macros specify the plant group properties in your title blocks. You can specify any
plant hierarchy level according to the settings of your project that you defined in the Data
Dictionary. Plant hierarchy macros use the syntax [Plant Group Name].[Property]. The following
examples illustrate the use of this syntax for the name property:

256

Macro

Notes

&Plant.name

Retrieves plant name

&Area.name.

Retrieves area name

&Unit.name.

Retrieves unit name

&Subsystem.name.

Retrieves subsystem name

SmartPlant Electrical User's Guide

Drawing Templates

Document Property Macros


Document property macros use the syntax Document.[Property]. The following macros are
available for specifying document properties:
Macro

Notes

&Document.ItemTag

Document drawing number as defined in the Data


Dictionary

&Document.Description

Document description

&Document.LastRevision

The latest revision of a document

&Document.DocumentCategory

Document category as defined in the Data


Dictionary

&Document.DocumentType

Document type as defined in the Data Dictionary

&Document.ItemStatus

Document status as defined in the Properties


window for a document

&Document.YYY

User-defined field name where YYY is any other


property defined in the Data Dictionary.

Document Revision Macros


Document revision macros use the syntax Revision.[Property].[Sequence], where [Sequence] is a
number that specifies the sequence of the revision. This way, you can arrange revisions in
ascending or descending order in the title block. Use the following macros to specify the
document revisions in your document title blocks:
Macro

Notes

&Revision.RevisionNumber.x

Revision number

&Revision.RevisionDate.x

Revision date

&Revision.CreateBy.x

Created by

&Revision.CheckBy.x

Checked by

&Revision.RevisionDescription.x

Revision description

&Revision.ZZZ.x

User-defined field name where ZZZ is any other


property defined in the Data Dictionary.

SmartPlant Electrical User's Guide

257

Drawing Templates

Macros for Multi-Sheet Schematics


Multi-sheet schematic macros include the total number of sheets in a schematic drawing, the
sequence number of a particular sheet, and a sheet description. Use the following macros to
specify properties of multiple sheets in the title blocks of your schematic drawings:
Macro

Notes

&Sheet.Quantity

Defines the total number of sheets in a multi-sheet


schematic

&Sheet.Number

Defines the sequence number of a particular sheet

&Sheet.Name

Sheet name

When generating a report, for the correct macros to be retrieved on the title block of your
drawing, your working environment must be the same as the drawing. For example, if the objects
on your drawing were created in a section of your plant named Unit 1, you must be working in the
Unit 1 environment when generating the report, otherwise the software cannot retrieve the correct
macros.

Enable the Renaming of Sheet Tabs in a Drawing


The following procedure explains how to add a new macro to an appropriate drawing template.
This macro will then enable you to rename the Sheet tabs in SmartPlant Electrical drawings so
that you can have different page names in multi-page drawings.
Do the following to add the name macro to a template:
1. In Catalog Manager, open the title block symbol that is used in one of your templates.
The symbol files are located in your reference data folder.
2. Add the following macro to the title block in the symbol:
&Sheet.Name
3. Save the symbol and close Catalog Manager.
4. Insert the title block symbol into an appropriate template.
You can now rename the Sheet tabs in the drawings that use the template into which you inserted
the new macro.
For details see:
Rename the Sheet Tabs in a Schematic Drawing (on page 262)
Rename the Sheet Tabs in an SLD Drawing (on page 315)
Rename the Sheet Tabs in a CBD Drawing (on page 320)

258

SmartPlant Electrical User's Guide

SECTION 17

Schematics
A schematic is a graphical representation of wiring and motor control systems. You create a
schematic by assembling it from typical blocks.
A block is a graphical representation of an electrical item. Blocks are parts of a complete
drawing. To create a block, start by creating an entire drawing in Catalog Manager or any CAD
application such as SmartSketch, AutoCAD, or MicroStation. Once the complete drawing is
ready, you select a part of the drawing and turn it into a block.
You can generate schematics for the following item types:
All loads
All converting equipment
All disconnect equipment
Circuits
Buses
Generators
Battery banks
Instruments
The software can generate a schematic by retrieving data for power related items from one block
or several blocks. If your generated schematic drawings contain the same information (that is,
the information repeats itself in identical sections of different schematic drawings), you should
consider creating a schematic block for the repeated parts so that this single block can be used by
several other schematic drawings. Note that you can create schematic drawings that include
several sheets. Multi-sheet schematics are mostly used when you need to display complex
electrical equipment for which a single sheet is not enough to show all the relevant wiring details of
the equipment.
After creating a block, you define the macros for that block. A macro is the smart text that you
attach to the block graphic. The software retrieves this smart text from the database and attaches
it to the block, thus making it part of the block file. You can create your macros in Catalog
Manager, SmartSketch, AutoCAD, or MicroStation.
Also, you must attach your blocks to templates. A template contains the definition for the desired
title block, border, and page size. You attach your blocks to templates in Catalog Manager,
SmartSketch, or any other CAD application.
Before generating a schematic drawing, you create a typical block and a typical schematic that
you will attach to a load for which you want to generate a schematic drawing. For a detailed
workflow for generating and using schematic drawings, see Recommended Workflow for
Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

259

Schematics

Recommended Workflow for Generating Schematic


Drawings
The following is a recommended workflow for generating schematics.

1. Create the graphical block files.


Create a complete drawing that includes all the needed graphical objects. You will then use this
complete drawing to create separate graphical blocks. Make sure that the complete drawing
includes a title block. Define the smart text labels (macros) and place them next to the specified
objects of the drawing. Create the individual schematic blocks and set their X and Y
displacement coordinates from the page origin. You can use Catalog Manager or SmartSketch to
create your schematic blocks, that is, symbols (files with the .sym extension). Also, You can use
any other CAD application such as AutoCAD or MicroStation to create .dwg or .dgn files. For
more information, see:
Create Schematic Blocks in Catalog Manager (on page 279)
Create Schematic Blocks in SmartSketch (on page 280)
Guidelines for Creating Schematic Blocks in AutoCAD and MicroStation (on page 281)
Macro Definition Guidelines (on page 262)

2. Create and define a new typical block.


In the Reference Data Explorer, create a new typical block. Edit the properties of the new
typical block and associate it with a file that contains the graphical representation of the current
typical block. For more information, see Create Typical Schematic Blocks (on page 51).

3. Create and define a new typical schematic.


In the Reference Data Explorer, create a new typical schematic. Edit the properties of the new
typical schematic and select the typical blocks that will comprise the typical schematic. Define the
displacement from the page origin for each block and set the block sequence if two or more blocks
are associated with the same block type. Also, select a suitable template. For more information,
see Create a Typical Schematic (on page 53).

4. Create and define a new profile.


In the Reference Data Explorer, create a new profile for the pertinent item type. Edit the
properties of the new profile and associate it with a typical schematic. For more information, see
Create a Profile (on page 45).

5. Apply the new profile to a selected electrical item.


Select an electrical item in the Electrical Index and use the Apply Options feature to apply the
new profile to the selected load. For more information, see Apply a Profile to an Item (on page
130).

260

SmartPlant Electrical User's Guide

Schematics
6. Generate a schematic for the selected electrical item.
Select an electrical item in the Electrical Index and generate the new schematic. For more
information, see Generate a Schematic (on page 273). For information about creating multi-item
schematics for more than one tag, see Generate a Multi-Item Schematic (on page 274).

As an alternative to steps 4, 5, and 6, you can select an electrical item in the Electrical Index
and open the Generate Schematic dialog box where you can select a typical schematic and
then generate the drawing. If the selected typical schematic contains more than one block of
the same item type for which you have not predefined a sequence, you can now associate
each point with its proper project item.
Sometimes the software generates a schematic block with a scaling incompatibility between
the schematic blocks and the template used to generate the schematic drawing. This scaling
incompatibility occurs if you have used AutoCAD or MicroStation to create your graphical
block files. To correct this problem, you have to set the units of measure (inches or
millimeters) for the generated schematic drawing. For more information, see Set Units of
Measure for Generated Schematic Drawings (on page 277).

Working with the Elements of a Schematic Drawing


The software allows you perform various actions with an open schematic drawing. Apart from
regular actions in a drawing such as zooming, selecting, saving, and so forth, you can do the
following:
Action

Description

Moving items

You can only move macros in a schematic drawing. You


cannot move blocks. Click a macro to select it and then drag it
to another place in the drawing and then save the
drawing. Note that this does not affect the data in your
database.
In a typical schematic, you can move a block by changing its X
and Y coordinates.

Inserting annotations and redlining Add text labels, symbols, or watermarks to your schematic as
annotations. Add text, linked symbols, circles, rectangles,
and lines to your schematic as redlining. For more
information, see Managing Annotations and Redlining (see
"Annotations and Redlining" on page 349).
Renaming a document and
entering revisions

Open your schematic and on the Edit menu, click Document


Properties.

Saving a schematic as an external With an open schematic, on the File menu, click Save
As. For more information, see Save a Schematic as an
file
External Document (see "Save a Schematic as an External
File" on page 279).
Printing a schematic

SmartPlant Electrical User's Guide

On the File menu, click Print.

261

Schematics

Rename the Sheet Tabs in a Schematic Drawing


The following procedure explains how to rename the Sheet tabs in a generated drawing. This
enables you to have different page names for each of the pages in a multi-page drawing. Note that
you make the change in the typical schematic that is used for the schematic drawing that you want
to modify.
Prior to renaming the Sheet tabs, you have to add the &Sheet.Name macro to the
drawing template. For details, see Enable the Renaming of Sheet Tabs in a Drawing (on page
258).
1. In the Reference Data Explorer, open the Typical Schematic Common Properties dialog
box for the typical schematic that you require.
2. Click the Sheets button.
3. On the Schematic Sheet Properties dialog box, select a sheet number in the Sheets group
box.
4. Under Sheet details, type the new tab name in the Sheet name field.
5. Click OK.
6. Repeat the above steps for all the sheets that you want to rename in the typical schematic.

Macro Definition Guidelines


You can generate schematics for the following item types:
All loads
All converting equipment
All disconnect equipment
Circuits
Buses
Generators
Battery banks
Instruments
You place macros on each block to retrieve relevant information from the database. Also, macros
define default values that appear in the drawing if no data for a particular property is found in the
database. Macros are text labels with a preceding ampersand (&). You can define macros in
Catalog Manager or one of the following CAD applications: SmartSketch, AutoCAD, or
MicroStation.

262

SmartPlant Electrical User's Guide

Schematics

Macros Defined in Catalog Manager


In Catalog Manager, you define each block as a symbol (.sym) file. In addition to using text labels
as macros, you can also place SmartText labels in a symbol. The advantage of using a
SmartText label to define a macro is that instead of having to remember the item type property and
typing it, you can select the property you require from a list. However, you can only use
SmartText labels to specify properties of the specific electrical item that you specified for the
symbol. For example, if the symbol was created for a cable, you can only select cable properties;
if you want to retrieve properties for an associated item such as a motor, you must use a text label
for the macro.
Note that for all SmartText labels used in a symbol, you have to set the Unit Space property to
World.

Macro Syntax
The macro text has to contain the SmartPlant Electrical item name, the name of the desired item
property, and a sequence number, according to the syntax:
&[ItemType].[Property].[Sequence]
For example, if you want to specify a name of a motor, the text label has to be:
&Motor.ItemTag.1
If a particular block contains several items of the same item type (that is, several cables, control
stations, and so on), you have to use the sequence number to ensure item uniqueness. For more
details, see Sequencing Items in Block Macros (on page 265).
You can also add the Unit or Area name to an item by using the following syntax:
&[ItemType].Unit.Name or &[ItemType].Area.name

Note the following for multi-item schematics:


The logic of the macro syntax for single-item schematics also applies to the macro syntax for
multi-item schematics. The macro syntax of multi-item schematics is almost the same as the
macro syntax of single-item schematics. The only difference is that for multi-item schematics
there is no definition of blocks. Therefore, you have to include the block name in the macro
syntax of multi-item schematics. The software retrieves the data from the block type even if the
associated item differs from the one that is associated with a particular schematic.
The software resolves the macros according to each item that has been associated with the
current schematic drawing on the Document Properties dialog box. Note that if the item type is
Bus, the associated items are only circuits.
For more details about multi-item schematics, see Generate a Multi-Item Schematic (on page
274).

SmartPlant Electrical User's Guide

263

Schematics

Panel Macros
Use the following syntax to create macros for local panels or junction boxes that include circuits:
&Circuit.Panel.[Property].[Sequence]

Cable Macros
Use the following syntax to create macros for cables:
&Cable.[Property].[Sequence] for power cables
&ControlCable.[Property].[Sequence] for control cables
&GroundingCable.[Property].[Sequence] for grounding cables
&InstrumentationCable.[Property].[Sequence] for instrumentation cables

Supported Electrical Items


Each drawing block can support the following electrical items and their properties:

Loads
Load blocks can include all the items that appear connected between a particular load and its
feeder circuit in the Electrical Engineer hierarchy. Also, load blocks include load-related object
properties regardless of whether these objects appear in the Electrical Engineer or not:
Direct load properties.
Related power cable properties.
Related grounding cable properties.
Related control cable properties.
Related instrumentation cable properties.
Related feeder circuit properties.
Related circuit internal properties (disconnect equipment)
Related bus properties.
Related cell properties.
Related power distribution board properties.
Related control station properties.
Related I/O signal item properties.

Circuits

264

Direct circuit properties.


Related circuit component properties (circuit breakers, fuses, and so on.). If data for more
than one item of the same type (for example, two circuit breakers) has to be retrieved, the
macro name ends with a sequence number such as "& CircuitBreaker.ItemTag.1".
Related electrical parent item properties: circuit - bus, circuit - power distribution board, circuit
- cell, and so on.
Related I/O signal item properties.

SmartPlant Electrical User's Guide

Schematics

Control Stations

Direct control station properties.


Related control cable properties. If data for more than one cable has to be retrieved, the
macro name ends with a sequence number, for example "&Cable.ItemTag.1".
Related I/O signal item properties.

Converting Equipment

The properties of all electrical items connected above the converting equipment item up to the
first feeding bus and then down up to the first incomer circuit or load.
Related I/O signal item properties.

Power Source Items, Generators and Battery Banks

The properties of all electrical items connected below the power source item up to the first
incomer circuit.
Related I/O signal item properties.
Now you can do one of the following:
Continue with the next step in the recommended workflow for generating a schematic drawing
and learn how to create typical schematic blocks (on page 51).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Sequencing Items in Block Macros


You use a sequence number if a particular item type appears more than once in a specific
block. The sequence numbers define the item uniqueness and the order in which the items
appear in the generated schematic drawing. The sole function of the sequence numbers is to
help the software identify the project items and retrieve the appropriate data from the right tags.
The sequence numbers are unique per item type. You add these sequence numbers to the
macros so that the software can retrieve the correct data belonging to the appropriate project
item. You sequence the items belonging to the same type in the ascending order starting from
the first item that appears right before the load and continue up to the feeder circuit. These
numbers represent the order in which the various items are connected in the Electrical Engineer
or circuit internals in the Electrical Index. Note that these sequence numbers do not correspond
or relate to the Sequence in group values entered in the Properties window.
Also, the sequence numbers do not have to be consecutive (for example, 1,2,3), but they have to
be in ascending order, for example 1, 5, 12, 20 and so forth.
In order to match the macros with the appropriate project items, the software creates lists of
project item types. These lists contain items that are ordered according to their electrical
connections in the Electrical Engineer starting from the load and up to the feeder circuit. The
lists also include all the associated internals that exist in the circuits (either panel or feeder circuits)
that may exist along the electrical path. Once the lists are complete, the software matches each
project item on the list with the macro that contains the appropriate sequence number. The
software matches the first project item on the list with the macro that has the lowest sequence
number then with the macro that has the next number, and so on.

SmartPlant Electrical User's Guide

265

Schematics

Handling Load Feeders with Parallel Branches


If there are several electrical paths/branches from a load to its feeder (for example,
forward/reverse power paths), the software starts creating the lists starting with the branch that
has the lowest sequence number. You define the branch order by setting the value in the
Sequence in group property of the item closest to the load of the pertinent branch.
After completing the list of the items of the first branch (including the feeder and its internals), the
software goes on to list the items of the next branch. The next branch is the one that has the next
numeric value in the Sequence in group property of the item closest to the load in that
branch. Note
that the second list does not include the circuit and its internals as they are already included in the
first list.

Handling Incomer and Feeder Circuit Internals


Make sure that you define the sequence numbering of circuit internals in the following manner:
For incomer circuit internals and riser circuit internals - descending order, starting with the item
closest to the bus.
For feeder circuit internals and coupler circuit internals - ascending order, starting with the item
closest to the bus.

Handling Converting Equipment Items


The software handles converting equipment macros starting with the items that appear at the
bottom of the schematic based on the design in the Electrical Engineer. For a transformer that
has cables and circuits connected to both primary and secondary windings, the software first
resolves the items that have the lowest sequence in group numbers. After resolving the items
that are connected to the first secondary winding, the software continues resolving the items for
the primary winding from the bottom of the schematic up to the feeding bus. Then, the software
returns to the bottom of the schematic and continues resolving the items that are connected to the
other secondary winding (if one exists).

Handling Non-Power Related Items of Schematic Drawings


After completing the list of the items along all the existing electrical paths from the load to the
feeder, the software looks for the associated control stations. If several control stations are
associated with the load, the Sequence in group value of the controls stations determines the
macro that is associated with that control station.
Example A (on page 267)
Example B (on page 268)
Example C (see "Macro Sequencing Example C" on page 269)
Example D (see "Macro Sequencing Example D" on page 270)
Example E (see "Macro Sequencing Example E" on page 271)
Example F (see "Macro Sequencing Example F" on page 272)

266

SmartPlant Electrical User's Guide

Schematics

SmartPlant Electrical User's Guide

267

Schematics

268

SmartPlant Electrical User's Guide

Schematics

Macro Sequencing Example C

SmartPlant Electrical User's Guide

269

Schematics

Macro Sequencing Example D

270

SmartPlant Electrical User's Guide

Schematics

Macro Sequencing Example E

SmartPlant Electrical User's Guide

271

Schematics

Macro Sequencing Example F

272

SmartPlant Electrical User's Guide

Schematics

Generate a Schematic
1. In the Electrical Index, expand the Electrical Equipment folder and select an item for which
you want to generate a schematic.
The software allows you to generate schematics for the following item types:
All loads
All converting equipment
All disconnect equipment
Circuits
Buses
Generators
Battery banks
Instruments (for single instruments only)
2. Do one of the following:
Click Actions > Generate Schematic.
Right-click the selected item and then click Generate Schematic.
Click
on the toolbar.
3. On the Generate Schematic dialog box, under Typical schematic, select an appropriate
typical schematic that you created in the Reference Data Explorer.
4. Under Drawing name, type a name for the new schematic.
Examine the block data in the data window. Make sure that the typical blocks are
defined correctly and their displacement from the page origin is set correctly.
5. Click the Macros tab. Examine the macros in the data window. Make sure that each macro
is associated with a correct item. To associate a macro with another item, select a macro in
the data window and then under Macro details, select another item from the Macro item
name list.
6. Click the Unresolved Items tab to check whether there are item tags for which there are no
corresponding items in the associated typical schematic.
7. Click OK to generate the schematic.
The software can only generate schematic drawings for items that have predefined typical
schematics.

Generate a Schematic for an Instrument


The software allows you to generate a schematic for a selected instrument.
1. In the Electrical Index, expand the following the Electrical Equipment > Instruments
hierarchy.
2. Select an instrument for which you want to generate a schematic and do one of the following:
Click Actions > Generate Schematic.
Click
on the toolbar.
3. On the Generate Schematic dialog box, under Typical schematic, select an appropriate
typical schematic that you created in the Reference Data Explorer.

SmartPlant Electrical User's Guide

273

Schematics
4. Under Drawing name, type a name for the new schematic.
Examine the block data in the data window. Make sure that the typical blocks are
defined correctly and their displacement from the page origin is set correctly.
5. Click the Macros tab. Examine the macros in the data window. Make sure that each macro
is associated with a correct item. To associate a macro with another item, select a macro in
the data window and then under Macro details, select another item from the Macro item
name list.
6. Click the Unresolved Items tab to check whether there are item tags for which there are no
corresponding items in the associated typical schematic.
7. Click OK to generate the schematic.

The items that can be included in a schematic for an instrument are:


The feeder and all the upstream items, up and including the bus.
All the associated equipment, cables, and the existing signal.
It is not possible to generate a multi-item schematic for an instrument. Nor is it possible to
generate multiple schematics for instruments in batch mode.
It is not possible to apply a typical schematic to an instrument.

Generate a Multi-Item Schematic


1. Create symbol (.sym) files for the following:
Multi-tag header block type for the main drawing page.
Multi-tag header block type for subsequent pages (usually the same as the multi-tag
header for the main drawing page, but placed at the center of the drawing sheet).
Multi-tag macro block type.

274

Ensure that the column widths, the number of columns, and the properties that the
macros represent match the corresponding characteristics of the headers.
Since at this stage, the macros are not associated with a specific item type, the syntax of
the macro needs to include an expression representing the block type to which the item
type refers, as follows:
[ItemType].[Property].[Sequence].[BlockType].[BlockSequence]
The logic of the macro syntax for single-item schematics also applies to the macro syntax
for multi-item schematics. The macro syntax of multi-item schematics is almost the same
as the macro syntax of single-item schematics. The only difference is that for multi-item
schematics there is no definition of blocks. Therefore, you have to include the block name
in the macro syntax of multi-item schematics. The software retrieves the data from the
block type even if the associated item differs from the one that is associated with a
particular schematic.
The software resolves the macros according to each item that has been associated with
the current schematic drawing on the Document Properties dialog box. Note that if the
item type is Bus, the associated items are only circuits.

SmartPlant Electrical User's Guide

Schematics

Macro examples:
Macro

Explanation

&Cable.ActualLength.1.Motor.1

Shows the actual length of the first


power cable that is connected to
Motor1. Motor1 is the first motor
connected to the circuit if the
schematic is generated for a circuit.

&Cable.ActualLength.2.Motor.1

Shows the actual length of the


second power cable that is
connected to Motor1. Motor1 is the
first motor connected to the circuit if
the schematic is generated for a
circuit.

&ControlStation.ItemTag.1.ControlStati
on.1

Shows the item tag of the first


control station that is associated with
the motor for which the schematic is
generated.

&ControlStation.ItemTag.1.ControlStati
on.2

Shows the item tag of the second


control station that is associated with
the motor for which the schematic is
generated.

2. For each of the symbol files that you created, define a typical block using the following block
types:
Multi-Tag Header on Drawing Page for the pages without drawings
Multi-Tag Header for the page where the drawing is placed (needed depending on the
typical schematic definitions)
Multi-Tag Macros for the macros that will appear in the schematic drawing

3.
4.
5.

6.

7.
8.
9.
10.

If you want to include a drawing on the first page of a schematic, you have to
create a typical block with a drawing. You can choose any block type for the drawing.
In the Reference Data Explorer, create a typical schematic that includes all the typical blocks
that you defined in the previous steps.
On the Typical Schematic Common Properties dialog box, select a multi-tag block type and
click Multi-Tag Options.
On the Multi-Tag Schematic Options dialog box, select whether to include a list on the main
drawing sheet, and specify the numbers of rows of data to appear on the main and
subsequent drawing sheets.
Apply this typical schematic to the tags that you want to appear in the multi-item schematic.
The tags must belong to the same subclass, for example, motors, heaters, or
transformers, and so forth.
In the Electrical Index, expand the Documents folder, and right-click the Schematic
Drawings folder.
Click New Multi-Tag Schematic.
Right-click the newly-created schematic, and on the shortcut menu, click Document
Properties.
On the Document Properties dialog box, from the Multi-tag typical schematic list, select
the typical schematic that you created in step 3.

SmartPlant Electrical User's Guide

275

Schematics
11.
12.
13.
14.

From the Multi-tag typical schematic list, select an appropriate multi-tag typical schematic.
Click the Associated Items tab.
Select an appropriate item type.
If you selected Bus from the Item type list, select an appropriate power distribution board and
bus.
15. If you did not select Bus from the Item type list, click the Associate button.
16. On the Find dialog box, click Find Now to find all the items belonging to the selected item type
that are associated with the current typical schematic.
17. In the Results box, select the items that you require and click OK.

All the items that you selected in the Results box appear in the Associated Items list.
You can dissociate the items that you don't need.
If you selected Bus from the Item type list, the Associated Items list automatically
displays all the circuits belonging to the current bus. You can sort these circuits either
according to their item tags or sequence in group values. The software updates this list
automatically if circuits have been added or deleted.
For more information about multi-item schematics for buses, see Generate a Multi-Item
Schematic for a Bus (on page 276).
18. Click OK.
19. In the Electrical Index, do one of the following to generate the schematic:
Double-click the schematic document.
Right-click the schematic, and on the shortcut menu, click Open.
Right-click any of the associated items, and on the shortcut menu, click Generate
Schematic. Ensure that in the dialog box that opens, under Drawing name, you select
the appropriate multi-item drawing.
When saving a multi-tag schematic as an external file, you need to save each page of the
schematic as a separate drawing.

Generate a Multi-Item Schematic for a Bus


This feature allows you to generate a schematic for a bus and include all the connected electrical
items in the schematic drawing. The generated schematic includes a typical drawing on the first
sheet followed by a table with data so that each row represents one circuit and the properties of
each item that are included in the circuit. The items that are included in the schematic are not
limited to a particular item type. They can be motors, generators, power cables, circuit breakers,
circuit internals, and so forth.
1. In the Electrical Index, right-click a bus and then click Apply Options.
2. On the Apply Options dialog box, click the Typical Schematic tab.
3. Select the Enable typical schematic check box and then click Find.
4. On the Find dialog box, click Find Now.
5. In the Results box, select an appropriate typical schematic.
6. In the Apply to box, select an option for applying the typical schematic. For details, see
Typical Schematic Tab (Apply Options Dialog Box) (on page 671).
7. Click OK.
For detailed information on how to create a typical schematic, see Create a Typical
Schematic (on page 53).

276

SmartPlant Electrical User's Guide

Schematics
8. In the Electrical Index, expand the Schematic Drawings folder and select an appropriate
multi-tag schematic.
9.
10.
11.
12.
13.

Alternatively, you can click New Multi-Tag Schematic to create a new one.
Right-click the selected schematic drawing and then click Document Properties.
From the Multi-tag typical schematic list, select an appropriate multi-tag typical schematic.
Click the Associated Items tab.
From the Item type list, select Bus.
Select an appropriate power distribution board and bus.

The Associated Items list shows all the circuits belonging to the current bus. You can
sort these circuits either according to their item tags or sequence in group values.
The software updates this list automatically if circuits have been added or deleted.
14. Click OK.
15. In the Electrical Index, double-click the schematic document to open it.

The table in the schematic document displays all the circuits that belong to the current bus and
are sorted according to the setting you made on the Document Properties dialog box.
For information about macros that are used for this type of schematic, see Generate a
Multi-Item Schematic (on page 274).

Set Units of Measure for Generated Schematic


Drawings
1. With the schematic drawing open, expand the folder hierarchy Tools > Options.
2. On the Options dialog box, click the Foreign Data tab.
3. Under Format, click MicroStation or AutoCAD depending on the application that you used to
create graphical block files.
4. Under Import, select the desired unit of measure from the File units list.
5. Click OK.
6. Close the schematic drawing.
7. Regenerate the schematic drawing.

Including Enhanced SmartLoop Reports with


Schematics
When generating a schematic drawing for an electrical item, you can also specify the display of an
Enhanced SmartLoop report containing loop wiring data, provided the signal for the item for which
you display the schematic is associated with a loop. The loop data comes from SmartPlant
Electrical after you publish the signal data to SmartPlant Instrumentation, make the appropriate
wiring and loop associations, and publish the data back to SmartPlant Electrical.

SmartPlant Electrical User's Guide

277

Schematics

Include Enhanced SmartLoop Reports with


Schematics
1. In SmartPlant Electrical Options Manager, under General Settings, do the following:
Beside Include Enhanced Reports in Schematics, select Yes.
Beside Default SmartPlant Instrumentation Domain Name, type the name of the
source domain.
2. In SmartPlant Electrical, click File > Open > Template.
3. Select the template that you want to use for displaying the Enhanced SmartLoop report.
4. Click View > Display > Working Area.
5. On the template drawing sheet, use the grab handles to define the size of the working area in
which the Enhanced SmartLoop report is to appear.
6. Save the template.
7. For the item for which you intend to generate the schematic, publish signal data to SmartPlant
Instrumentation.
The item for which you want to include the Enhanced SmartLoop report must have a
related signal.
8. In SmartPlant Instrumentation, create loops and associate them with the retrieved signal data.
9. Publish the data back to SmartPlant Electrical, and generate the schematic for the item using
the template that you modified.

The software displays the schematic on the initial drawing sheets and Enhanced SmartLoop
reports on subsequent drawing sheets, with one or more sheets per loop.
The software supports multi- sheet Enhanced SmartLoop reports.

Generate Schematics in Batch Mode


1. In the Electrical Index, expand the Electrical Equipment folder that contains items for which
you want to generate a schematic.
The software allows you to generate schematics for the following item types:
All loads
All converting equipment
All disconnect equipment
Circuits
Buses
Generators
Battery banks
2. In the list view, select several items.
3. Click Actions > Generate Schematic.
4. On the Batch Options for Schematics dialog box, select the Save files to disk check box if
you want to save the generated schematics as files.

278

SmartPlant Electrical User's Guide

Schematics
5. Under Path, type the exact path where the files will be saved, or click the ellipsis button
to browse to the desired folder.
You can accept the displayed default path which you set in Options Manager.
6. From the Save as type list, select a file format.
7. Select the Print drawings check box if want to print out the generated schematics.
8. Click OK to generate the schematics.
The software can only generate schematic drawings for items that have pre- defined typical
schematics.

Open a Schematic Drawing


1. In the Electrical Index, expand the hierarchy Documents > Schematic Drawings.
2. Select a schematic drawing.
3. Click File > Open > Drawing.
Also, you can right-click a schematic drawing and on the shortcut menu, click Open.

Save a Schematic as an External File


1.
2.
3.
4.

With the schematic drawing open, click File > Save As.
On the Save As dialog box, navigate to the desired folder.
Type the file name and select the desired file type.
Click OK.

If the schematic contains annotations, save it as a .spe file.


When saving a drawing in AutoCAD format, you must specify the AutoCAD version prior to
saving. To set the AutoCAD version, open a drawing and then click Tools > Options. On
the Options dialog box, click the Foreign Data tab and select AutoCAD from the Format
list. Then, click Options in the Export box. On the AutoCAD Export Options dialog box,
select the appropriate AutoCAD version.

Create Schematic Blocks in Catalog Manager


1.
2.
3.
4.
5.

Open Catalog Manager.


Select the symbol folder in which you want to store the new symbol.
Create a new symbol in the Catalog.
Open the symbol drawing and set the Default layer to active.
Select a suitable sheet size for your drawing.

Use the Grid Display and Grid Snap commands to place the origin properly.
Edit the origin properties and set the origin layer as hidden objects.
6. Draw your block. Make sure that you make the Default layer as the active layer.

SmartPlant Electrical User's Guide

279

Schematics
7. Add the SmartText.
If the SmartText requires repositioning, change the active layer to Label.
Do not forget to change the layer back to Default when you return to the drawing.
8. Add the macro text to retrieve the attributes that are not available for SmartText. For more
information about macro text, see Macro Definition Guidelines (on page 262).
9. Save the graphic as a symbol (.sym) file.
10. If the new symbol file is a complete typical schematic drawing, use it to create individual
schematic blocks. For more information, see Use a Complete Symbol File to Create
Schematic Blocks in Catalog Manager (on page 280).

Now you can do one of the following:


Continue with the next step in the recommended workflow for generating a schematic drawing
and learn how to create typical schematic blocks (on page 51).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Use a Complete Symbol File to Create Schematic


Blocks in Catalog Manager
1. Open the complete schematic symbol file. (See step 9 in Create Schematic Blocks in Catalog
Manager (on page 279).)
2. Delete all the graphics, SmartText, and text labels that are not part of the desired drawing
block.
3. Save the remaining graphics, SmartText, and text labels to a new symbol file. Use the Save
As command.
4. Repeat steps 1 through 3 to create the rest of the schematic drawing blocks.

Create Schematic Blocks in SmartSketch


1. Open SmartSketch.
2. Create a new drawing file (.igr) or open an existing schematic drawing.
You can open CAD files created in AutoCAD (.dwg) or MicroStation (.dgn).
3. Set the following parameters for an open drawing:
Set all the layers in use to visible.
Set the Default layer as the active layer.
Move all the graphic objects from their original layer to the Default layer.
Select a suitable sheet size for your drawing.
Move the drawing origin to the bottom left corner of the sheet (0.0).
Add all the macros for the desired entities by defining the text labels starting with an
ampersand.
4. Save the .igr drawing.
5. Open the drawing and set the Default and Label layers to visible. Hide all the other layers.

280

SmartPlant Electrical User's Guide

Schematics
6. If the .igr file is a complete typical schematic drawing, use it to create individual schematic
blocks by doing the following:
a. Select a set of graphics and macros that will comprise the new block symbol.
b. Click the Create Symbol icon.
Make sure that the new symbol does not include any SmartSketch group (a
collection of objects). If your symbol does include a group, you must ungroup these
objects.
c. Move the symbol origin to the bottom left corner of the drawing sheet.
d. Save the new drawing as a symbol file in your default symbol folder.

Now you can do one of the following:


Continue with the next step in the recommended workflow for generating a schematic drawing
and learn how to create typical schematic blocks (on page 51).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

Guidelines for Creating Schematic Blocks in AutoCAD


and MicroStation
1. There is no need to create blocks or cells. SmartPlant Electrical recognizes .dwg and .dgn
files and treats each drawing as a SmartPlant Electrical block file.
2. Set the drawing sheet origin at the bottom left corner of the drawing sheet (0.0).

When saving a drawing in AutoCAD format, you must specify the AutoCAD version prior to
saving. To set the AutoCAD version, open a drawing and then click Tools > Options. On
the Options dialog box, click the Foreign Data tab and select AutoCAD from the Format
list. Then, click Options in the Export box. On the AutoCAD Export Options dialog box,
select the appropriate AutoCAD version.
When importing graphical blocks that were created in AutoCAD for typical schematics, the
software automatically translates and identifies the AutoCAD file if its AutoCAD version is
supported by the software. The supported versions of AutoCAD appear on the Version list of
the AutoCAD Export Options dialog box.
Now you can do one of the following:
Continue with the next step in the recommended workflow for generating a schematic drawing
and learn how to create typical schematic blocks (on page 51).
Return to the Recommended Workflow for Generating Schematic Drawings (on page 260).

SmartPlant Electrical User's Guide

281

Schematics

282

SmartPlant Electrical User's Guide

SECTION 18

Single Line Diagrams


SmartPlant Electrical enables you to generate single line diagrams for the following:
A power distribution board that you select in the Electrical Index.
A PDB-based single line diagram is a document that includes a power distribution board
general arrangement drawing and a power distribution board schedule. The software
generates a single line diagram for a selected power distribution board that contains all the
PDB buses, circuits, circuit components, and their inter-connections (bus couplings). Note that
the software places the PDB cells and circuits on a drawing in a particular order. This order
depends on the cell and circuit sequence in group value defined in the cell and circuit
properties.
An electrical item that you select in the Electrical Engineer.
A single line diagram that you generate from the Electrical Engineer is a main or key single
line diagram of the electrical network for a selected set of items created according to the
generation options that you predefine.
A blank single line diagram template (manual SLD).
Using a blank template allows you to drag electrical items from the Electrical Index that you
want to appear in your single line diagram. These items can include buses, offsite power
supplies, generators, battery banks, converting equipment not contained within PDBs, and
standalone disconnect electrical equipment. After positioning the items on the SLD template,
the software will complete the drawing according to the generation options that you defined.

Single Line Diagram Types


You can generate the following types of single line diagram when generating an SLD for an
electrical item that you select in the Electrical Engineer. These options are not available when
generating PDB-based single line diagrams.
Conventional Generates a full and unfiltered single line diagram that includes all the
associated cables, converting equipment, and loads.
Overall Generates an SLD that displays multiple levels of buses but does not include
individual loads. The following table specifies the items that are included in overall SLDs:
Item

Displayed in SLD

Power sources

Shown

Buses

Shown including their incomers. If there are bus incomers that


are not part of the SLD scope, the SLD displays the references to
their feeders. Also, overall SLDs show coupled buses and their
incomers and feeders.

Circuit internals

Shown according to the settings on the Circuits & Internals tab.

Feeder circuits

Shown only if connected to a transformer, battery bank, UPS,


incomer circuit, or any load that is shown in the SLD.

Converting
equipment

Shown

SmartPlant Electrical User's Guide

283

Single Line Diagrams

Item

Displayed in SLD

Loads

Not shown apart from motors and heaters that have a minimum
rated power setting defined on the Miscellaneous tab.

Cables and
busways

User-defined. You can show or hide cables and busways as you


require. Note that if you choose to display the cables, the
software will show only those cables that are connected to the
loads included in the current SLD.

Based on bus rated voltage Generates an SLD based on the bus rated voltage that you
select from the list below.
Electrical analysis SLD Generates a single line diagram that you can publish to an
electrical analysis application such as ETAP. Also, after selecting this option you have to
define the options for circuits and circuit internals on the Circuits and Internals tab.

Symbols in Single Line Diagrams


When generating an SLD, the software searches for a symbol for each electrical item that is
included in the SLD source. SmartPlant Electrical supplies you with a set of default symbols that
you can use in your drawings. Alternatively, you can create your own custom symbols in Catalog
Manager. After creating your symbols and defining them in the Options Manager, the software
then uses the SLD symbols according to the following rules:
1. SmartPlant Electrical checks whether the items included in the SLD source are associated
with symbol files. Wherever such an association exists, the software uses the associated
symbol file to represent the electrical item in the single line diagram. You associate an item
with a symbol file using the Associate Custom Symbols command from the Actions menu
for an item that you select in the Electrical Index.
2. If SmartPlant Electrical cannot find a symbol file associated with a particular electrical item,
the software uses a symbol with a name that matches the item type name of the electrical item
to be included in the single line diagram. This symbol resides in the folder defined in the
Default SLD Symbol Path location in Options Manager.
For more information about SLD symbols, see Guidelines for Creating SLD Symbols in Catalog
Manager (on page 310).

284

SmartPlant Electrical User's Guide

Single Line Diagrams

Working with SLD Elements


The software allows you perform various actions with an open single line diagram. Apart from
regular actions in a drawing such as zooming, selecting, saving, and so forth, you can do the
following:
Option

Description

Moving items

Click an item to select it and then drag it to another place in


the drawing. Save the SLD to keep the items you moved in
their new places. Note that this does not affect the data in
your database.

Drawing frames

You can instruct the software to draw a frame around each


PDB bus group and around the circuits in each cell. To draw
these frames, select these options on the Buses tab of the
Single Line Diagram Options dialog box. Note that when
drawing a PDB frame, the software draws a separate frame
around each bus or a section of a bus (if a bus break was
used to break the bus symbol into sections). When creating a
PDB symbol in Catalog Manager, you can add a macro for
PDB item tags. This will enable you to display the PDB name
on each PDB frame shown on the SLD. For examples of how
the software draws PDB frames, see PDB Frame Examples
in SLDs (see "PDB Frames Examples in SLDs" on page 306).

Moving frames

The software draws frames around items belonging to PDBs


and around circuits in each cell. You can resize and move
these frames to other places in the drawing as needed. The
software retains all your changes after saving the drawing.
Also, you can move and resize the frames that the software
draws around items belonging to PDBs and around circuits in
each cell. The software retains these changes after saving
the drawing. Before reopening a saved SLD, you can choose
whether or not to display the last saved position by selecting
or clearing the Retrieve last saved position of electrical
items check box on the SLD tab of the Preferences dialog
box.

Changing the orientation of a


branch that is connected between
a selected power source and a
bus.

Select a root power source and then click


on the Edit
Drawing toolbar. You can change the orientation of a branch
that is connected between the selected power source and a
selected bus. You can display the branch above or below a
selected bus.

Entering and modifying item


properties

Select an electrical item and then enter or modify its


properties in the Properties window.

SmartPlant Electrical User's Guide

285

Single Line Diagrams


Option

Description

Changing the line type, line color


and line width of a selected bus

Select a bus and then click the appropriate icon on the SLD
toolbar to change the line type, line width, or line color for the
selected bus. Note that the software retains new line display
settings only if you save the SLD as an external
document. Otherwise, after reopening the SLD, the software
displays the original bus symbol. You can use Options
Manager to change the symbol that the software uses to
represent busses. To create a new symbol for busses, use
Catalog Manager. For more information, see Guidelines for
Creating SLD Symbols in Catalog Manager (on page 310).

Moving a circuit connection point


to another place on the bus

Select a circuit connector and drag its connection point along


the bus to another place.

Defining the width and color of a


connection point on a bus

In the Catalog Manager, make sure that the bus symbol has a
dot that represents a connection point. After defining the
width and color of this dot, the software will use these
definitions in your SLDs.

Inserting annotations and redlining Add text labels, symbols, or watermarks to your SLD as
annotations. Add text, linked symbols, circles, rectangles,
and lines to your SLD as redlining. For more information,
see Managing Annotations and Redlining (see "Annotations
and Redlining" on page 349).

286

Renaming a document and


entering revisions

Open your SLD and on the Edit menu, click Document


Properties.

Saving an SLD as an external file

With an open SLD, on the File menu, click Save As. For
more information, see Save a Single Line Diagram as an
External File (on page 295).

Setting SLD generation


preferences

On the File menu, click Preferences. For more information,


see Customize Preferences for SLD Generation (on page
30).

Setting new generation options


and regenerating an SLD

On the Tools menu, click Drawing Options. For more


information, see Generate an SLD from the Electrical
Engineer (on page 288).

SmartPlant Electrical User's Guide

Single Line Diagrams


Option

Description

Rescaling the graphic items in an


SLD drawing so that they fit
working area of the drawing

Before generating a drawing, you can instruct the software to


shrink all the graphic items so that they will fit into the working
area of the drawing. To do this, select the Shrink to page
check box on the Page Settings tab of the Single Line
Diagram Options dialog box.
In an open drawing, right-click the blank area and then on the
shortcut menu click Fit To Page. This command fits the
content of the generated SLD (excluding the title block) into
the working area of the drawing according to the SLD margin
definitions made on the Page Settings tab of the Single Line
Diagram Options dialog box. The software will either expand
or shrink the graphic items in the generated drawing.
In order for the software to rescale all the items
correctly, make sure that when creating symbols that contain
text or smart text, the Units space property is set to World.
Note the World is not the default setting for this property.

Printing an SLD

On the File menu, click Print.

The software uses the following conventions to display parallel cables in an SLD:
[...] in the item tag label and (xN) in the cable configuration label, where N is the number of
cables, for example:
Cable-32/A[...]
3 x 150mm2 (x5)
This means that there are five parallel cables represented by the same line in the SLD.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

Generating New Single Line Diagrams


When creating a new single line diagram, the following options are available:
Generate an SLD from the Electrical Engineer (on page 288).
Generate a Single Line Diagram for a PDB (on page 289).
Generate a Manual SLD (on page 291).
Generate Multiple Single Line Diagrams for PDBs in Batch Mode (on page 291).
Generate an SLD with a Bus Tie and Internal Components (on page 292).

SmartPlant Electrical User's Guide

287

Single Line Diagrams

Generate an SLD from the Electrical Engineer


This option allows you to generate a single line diagram based on the items you select in the
Electrical Engineer. First, you select the items from which you want the new SLD to
originate. Then, you set the generation options to define the electrical items that serve as the
initial points or sources of your SLD, define the SLD page and display settings, as well as the
definitions for the display of circuits and circuit components. After generating the SLD, you can
save the SLD as an internal drawing in the system or as an external drawing using the Save As
command. You can generate as many SLDs for the same item as needed.
1. In the Electrical Engineer, select the items for which you want to generate your single line
diagram.
2. Do one of the following to open the Single Line Diagram Options dialog box:
Click File > New > SLD.
Right-click a highlighted item and then on the shortcut menu, click New SLD.
3. On the Single Line Diagram Options dialog box, define the SLD generation options as you
require. For details, see Single Line Diagram Options Dialog Box (on page 798).
4. Click Generate.

288

If you want to regenerate an open SLD drawing using different generation options, with the
SLD open, click Tools > Drawing Options.
To save the drawing as an internal document, in the generated SLD drawing, click File >
Save.
If there are overlapping connectors on the generated drawing, open the SLD and then click
Tools > Optimize Overlapping Connectors to reposition the connectors so that they do not
overlap. Note that this operation may take a few moments if your SLD contains a lot of
connectors.
For information on how to use custom symbols in your SLDs and the SLD legends, see Use
Custom Symbols in SLDs (on page 305).
If, during the SLD generation, the software cannot find a referenced symbol for a specific
electrical item, the software uses the default symbol file (default.sym) to represent the
item. You specify default files in Options Manager.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

SmartPlant Electrical User's Guide

Single Line Diagrams

Generate a Single Line Diagram for a PDB


This option allows you to create a single line diagram for a PDB that you select in the Electrical
Index. You start by selecting the PDB for which you want to generate an SLD. Then, you define
the generation options such as the page settings and the settings for the display of the circuits and
circuit components. After generating the SLD, you can save the SLD as an internal drawing in the
software. Note that you can generate only one SLD per PDB. If you select a PDB for which you
have previously created an SLD, the software opens the existing SLD using the generation
options that you defined before the previous generation. To generate a completely new SLD for
such a PDB, first delete the SLD from the Documents folder in the Electrical Index and then
generate the SLD.
1. In the Electrical Index, select the power distribution board for which you want to generate a
single line diagram.
2. Do one of the following to open the Single Line Diagram Options dialog box:
Click Actions > Generate SLD for PDB.
Click
on the toolbar.
Right-click a highlighted item and then on the shortcut menu, click Generate SLD.
3. On the Single Line Diagram Options dialog box, define the SLD generation options as you
require. For details, see Single Line Diagram Options Dialog Box (on page 798).
4. Click Generate.

To save the drawing as an internal document, in the generated SLD drawing, click File >
Save.
If there are overlapping connectors on the generated drawing, open the SLD and then click
Tools > Optimize Overlapping Connectors to reposition the connectors so that they do not
overlap. Note that this operation may take a few moments if your SLD contains a lot of
connectors.
For information on how to use custom symbols in your SLDs and the SLD legends, see Use
Custom Symbols in SLDs (on page 305).
If, during the SLD generation, the software cannot find a referenced symbol for a specific
electrical item, the software uses the default symbol file (default.sym) to represent the
item. You specify default files in Options Manager.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

SmartPlant Electrical User's Guide

289

Single Line Diagrams

Break Bus Symbols into Sections


Prior to generating an SLD for a power distribution board or when regenerating an existing SLD for
a PDB, you can instruct the software to break the bus symbols on the drawing into bus sections.
This way, you can manage the number of feeder circuits that are connected under each bus
section on your SLD and make the labels of the connected electrical items more legible.
1. On the Single Line Diagram Options dialog box, click the Buses tab.
This dialog box opens automatically if you are generating a new SLD for a power
distribution board. If you are regenerating an existing drawing, click Tools > Drawing
Options.
2. Under Display options, select the Force bus breaks check box.
When generating your SLD, the software breaks the bus symbols on the drawing
into sections and places them in rows underneath each other. The software displays the
electrical items on the buses over several rows according to the bus breaks. You can move
the individual bus sections and place them on the drawing as you require. Also, you can move
the incomer and feeder circuits from one bus section to another on the same bus. Clear this
check box to instruct the software not to break the bus symbols into sections and display of all
the circuits on the same row.
3. Under Maximum number of feeders per bus section to display, type the maximum
number of feeders to allow on each row of the drawing. The software forces bus breaks
wherever the number of feeders on the bus exceeds the specified maximum.
Note the following:
When forcing bus breaks, the software places the maximum number of feeder circuits on
the first bus section according to the value that you enter. Then, the software places the
rest of the feeders on the next section. For example, if you enter 3 as the maximum
number of feeders per bus section and there are 5 feeders on that bus, the software will
place 3 feeders on the first section and the other 2 feeders on the second bus section.
All the incomer circuits for each bus are drawn on the first bus section only.
You can move the incomer and feeder circuits from one bus section to another bus
section on the same bus as you require. Click an incomer or a feeder circuit symbol to
select it and then drag its connection point on the bus to another bus section of the same
bus.
Where two buses are connected by a coupler-riser, the software does not force a bus
break across the connection. Instead, the software draws the first bus section and then
counts the feeders from the riser on the second bus section before forcing the break. For
details, see Bus Break Example (on page 805). Note that you can move coupler and riser
circuits to another section of the same bus just like any other circuit.
4. Select the Use multiple sheets if you want to display each row of items on a separate
drawing sheet. When this option is selected, the software uses off-page connector symbols
with appropriate labels to show the continuation between adjacent sheets. Clear to display
all the items on a single drawing sheet. When cleared, the software uses row break symbols
to show the continuation between adjacent rows. Note that this option becomes available after
selecting Force bus breaks.
5. Click another tab or Generate as required.

290

SmartPlant Electrical User's Guide

Single Line Diagrams

Generate a Manual SLD


Manual SLDs are single line diagrams that you generate using a blank template. First you drag
the items you want in your SLD onto the template, positioning them where you want them to
be. Then, you set the generation options to define the electrical items that serve as the initial
points or sources of your SLD, define the SLD page and display settings, as well as the definitions
for the display of circuits and circuit components. After generating the SLD, you can save the
SLD as an internal drawing in the system or as an external drawing using the Save As
command. You can generate as many SLD for the same item as needed. If you want to
regenerate an open SLD drawing using different generation options, with the SLD open, click
Tools > Drawing Options.
1. In the Electrical Index, expand the Documents folder.
2. Right-click the Single Line Diagrams folder, right-click and then click New Manual SLD.
3. Select the new SLD in the Single Line Diagrams folder, and do one of the following:
Right-click, and then on the shortcut menu click Open.
Click File > Open > SLD.
4. From the Electrical Index, drag and drop onto the opened template the items you want in
your SLD.
5. Click Tools > Drawing Options.
6. On the Single Line Diagram Options dialog box, define the options you require for your SLD
template. For more information, see Single Line Diagram Options Dialog Box (on page 798).
7. Click Generate.

If you want to regenerate an open SLD drawing using different generation options, with the
SLD open, click Tools > Drawing Options.
In order to save an annotation that was added to a manual SLD, make sure that first you click
Generate on the Drawing Options dialog box and only then save the drawing. This way, the
software saves the SLD together with the inserted annotation.

Generate Multiple Single Line Diagrams for PDBs in Batch


Mode
This option allows you to generate in batch mode multiple single line diagrams for a selected
PDB. You can use this option to print the generated SLDs right after the software generates them
with or without saving the SLDs as external files.
1. In the Electrical Index, select the Power Distribution Equipment folder and select Power
Distribution Boards.
You can also generate multiple SLDs in batch mode from the Tabular Editor.
2. In the list view pane of the Electrical Index select the PDBs you require and do one of the
following to open the Batch Options for SLDs dialog box:
Click Actions > Generate SLD for PDB.
Right-click the selected items and then on the shortcut menu, click Generate SLD.

SmartPlant Electrical User's Guide

291

Single Line Diagrams


3. On the Batch Options for SLDs dialog box, do the following as you require:
To save the SLDs as external files, select Save files, enter the file path where you want to
save the files, and then select the file type that you require.
To print the generated SLDs automatically right after the software generates them, select
Print drawings.
To show the loads associated with items on your SLD drawing, select Include loads.

Generated SLDs show all circuit internals.


Generated SLDs show cables and cable terminations.
The software uses sequence numbers for circuits.
The software uses the default SLD template that you defined in Options Manager.
The SLDs do not display a legend that explain the symbols used in the SLDs.

Generate an SLD with a Bus Tie and Internal Components


This topic explains how to show the internals of a bus tie in a horizontal orientation on an SLD.
1. On the Electrical Index create your PDB including the Bus Tie coupler-riser relations with
their circuit internals.
2. From the Electrical Engineer, select the circuit with the Bus Tie coupler-riser that you want to
create an SLD for, and do one of the following:
Click File > New > SLD.
Right-click on the circuit, and then on the shortcut menu, click New SLD.
3. From the Electrical Index, select the PDB that contains the bus tie coupler-riser that you want
to create an SLD for, and do one of the following:
Click Actions > Generate SLD for PDB.

4.

5.
6.
7.

Click
on the toolbar.
Right-click the PDB, and then on the shortcut menu, click Generate SLD.
On the Single Line Diagram Options dialog box, select the Circuits and Internals tab, and
do the following:
Select the options you require.
Set the distance between the circuit internals and the circuits, remembering to make the
spacing wide enough so that the circuit items will not be crowded onto each other, and
require moving manually.
Select the Buses tab and select the required options.
Select the required options from the other tabs.
Click Generate.

For you to see the Bus Tie and its internal circuit you must use the correct symbols. The
Coupler circuit symbol, CircuitBusTieCoupler.sym and the Riser circuit symbol,
CircuitBusTieRiser.sym. Any of the symbols used in the internal circuits must use the syntax
<itemtype>BusTie.sym, for example CircuitbreakerBusTie.sym.

292

SmartPlant Electrical User's Guide

Single Line Diagrams

Abort SLD Generation Process


This option allows you to abort the generation process without the need to close down SmartPlant
Electrical.
In the SLD Generation Progress window, click Abort.

Opening Existing Single Line Diagrams


This topic explains how to open single line diagrams that you have saved as internal drawings.
If you have not changed any electrical items that pertain to the SLD that you want to open, the
software displays the drawing as it was saved the last time. However, if you have modified some
of the electrical data that pertains to that SLD, the software regenerates the drawing by retrieving
the information from the database. The software keeps the previous generation options and all
the existing annotations. The items that have not been modified retain their previous positions in
the SLD and keeping their existing coordinates. The new or modified electrical items appear in
the drawing with the coordinates that are calculated by the software.
You can open a single line diagram using one of the following methods:
SLDs for power distribution boards - You open these single line diagrams from the
Electrical Index. For more information, see Open an SLD for a Power Distribution Board (on
page 294).
SLDs based on items in the Electrical Engineer - You open these single line diagrams from
the Electrical Engineer. For more information, see Open an SLD Based on an Electrical
Engineer Item (on page 294).
SLDs in the Documents folder in the Electrical Index - You can open an existing single line
diagram directly without selecting the electrical item for which it was generated if you know the
name of the SLD. The SLDs in the Documents folder are the single line diagrams that you
saved as internal drawings. For more information, see Open an SLD from the Documents
Folder (on page 294).
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control the
visual consistency of connectors, you can set a Clearance value that specifies the amount of
space that the software will maintain between the connector and the connected element (also
known as range avoidance). This action allows you to control the visual consistency of connectors
that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is zero.

SmartPlant Electrical User's Guide

293

Single Line Diagrams

Open an SLD Based on an Electrical Engineer Item


1. In the Electrical Engineer, select the item for which you want to open a single line diagram.
2. Click File > Open > SLD.

You can right-click an item and click Open SLD on the shortcut menu.
If the electrical item you selected is an origin for more than one SLD drawing, the software
opens the Open Single Line Diagram dialog box where you select the drawing that you want
to open.
If you have opened an SLD drawing whose electrical data has changed (for example, you
added or deleted a bus, moved a circuit, and so on), the software does not display the SLD
clearly and some of the items might overlap. To fix the SLD, with the SLD drawing open, click
Tools > Drawing Options. Set the required SLD options and click Generate. The
regenerated SLD drawing retains the existing annotations. However, it does not keep the old
circuit and circuit component placements in the drawing.

Open an SLD for a Power Distribution Board


1. In the Electrical Index, highlight a power distribution board.
2. Click File > Open > Drawing.

You can right-click an item and click Open SLD on the shortcut menu.
If you have opened an SLD drawing for a PDB whose electrical data has changed (for
example, you added or deleted a bus, moved a circuit, and so on), the software does not
display the SLD clearly and some of the items might overlap. To fix the SLD, with the SLD
drawing open, click Tools > Drawing Options. Set the desired SLD options and click
Generate. The regenerated SLD drawing retains the existing annotations. However, it does
not keep the old circuit and circuit component placements in the drawing.

Open an SLD from the Documents Folder


1. In the Electrical Index, expand the following hierarchy: Documents > Single Line
Diagrams.
2. Select an SLD.
3. Click File > Open > Drawing.

294

You can right-click an SLD and click Open on the shortcut menu.
If you have opened an SLD drawing for which the electrical data has changed (for example,
where you added or deleted a bus, moved a circuit, and so on), the software does not display
the SLD clearly and some of the items might overlap. To fix the SLD, with the SLD drawing
open, click Tools > Drawing Options. Set the required SLD options and click
Generate. The regenerated SLD drawing retains the existing annotations. However, it does
not keep the old circuit and circuit component placements in the drawing.

SmartPlant Electrical User's Guide

Single Line Diagrams

Save a Single Line Diagram as an External File


This procedure explains how to save a single line diagram as an external file.
1. Open or generate a single line diagram.
2. Click File > Save As.
When saving a drawing in AutoCAD format, you must specify the AutoCAD version prior to
saving. To set the AutoCAD version, open a drawing and then click Tools > Options. On the
Options dialog box, click the Foreign Data tab and select AutoCAD from the Format list. Then,
click Options in the Export box. On the AutoCAD Export Options dialog box, select the
appropriate AutoCAD version.

Show Control Stations in an SLD


This procedure allows you to show control stations associated with equipment in an SLD.
1. Open a single line diagram. For more information, see Opening Existing Single Line
Diagrams (on page 293).
2. Click Tools > Drawing Options.
3. On the Single Line Drawing Options dialog box, click the Related Equipment tag.
4. Under Control Station options, check Show control stations associated with
equipment.
5. Under Control stations displacement, type the values for the X: and Y: coordinates, and
select the units required from the Units list.
6. Click Generate.

Show Metering and Relaying Equipment in an SLD


This option allows you to show metering and relaying equipment associated with items in an SLD.
1. Open a single line diagram. For more information, see Opening Existing Single Line
Diagrams (on page 293).
2. Click Tools > Drawing Options.
3. On the Single Line Drawing Options dialog box, click the Related Equipment tag.
4. Under Metering & Relaying Equipment options, check Show metering and relaying
equipment.
5. Under Metering equipment first symbol displacement, type the values for the X: and Y:
coordinates, select the units required from the Units list, and type the value for the Vertical
displacement.
6. Click Generate.
The logical connections are completed by you, on the drawing, after the drawing has been
generated.

SmartPlant Electrical User's Guide

295

Single Line Diagrams

Displaying Equipment Connected in Parallel


Single line diagrams display parallel connections that have been made among various equipment
items. In order for the software to display parallel connections appropriately, make sure that you
have connected the required equipment in parallel. For details on how to make parallel
connections, see Connect Equipment Items in Parallel (on page 202).

If you are using customized symbols for cables and disconnect equipment, make sure that you
have prepared two symbols for these item types: one for the regular (vertical) display (for
example, MY_CABLE.SYM) and one for the horizontal display (for example,
MY_CABLE_PRL.SYM). You can, however, use the shipped symbols as you require.
The software displays parallel connectivity even if there are no cables between the parallel
equipment items.

Placement of Items
The general rule for placing electrical items in an SLD is determined by the power flow of the
electrical items in a given SLD. For the items in a parallel branch, the placement rule is determined
according to the sequence of items in the Parallel Equipment Assistant. For example, if in the
Parallel Equipment Assistant, you defined Motor_1 in the Item 1 column and Motor_2 in the
Item 2 column, the software will place Motor_1 to the left of Motor_2. However, if there is an
overlap in the placement of items on the drawing due to the parallel connection definitions, the
power flow rule overrides the rule determined by the Parallel Equipment Assistant. The
software will first place the items based the power flow and then arrange the items in the parallel
branches in accordance with the definitions made in the Parallel Equipment Assistant.
For manual SLDs, after placing an item that has been included in a parallel chain in
the Parallel Equipment Assistant, the software also automatically places all the items that have
parallel connection associations with the item you just placed.
These rules are illustrated in the following examples.

Example A:
Two variable speed drives connected in parallel.
In the Parallel Equipment Assistant:

296

Item 1

Item 2

V-1G-2

V-1G-3

SmartPlant Electrical User's Guide

Single Line Diagrams

In Electrical Engineer:

In a generated SLD:

Example B:
Two motors with a maintenance switch connected in parallel.
In the Parallel Equipment Assistant:

Item 1

Item 2

M1A

M1B

In Electrical Engineer:

SmartPlant Electrical User's Guide

297

Single Line Diagrams

In a generated SLD:

Example C:
Two transformers connected in parallel.
In the Parallel Equipment Assistant:

298

Item 1

Item 2

T-1A

T-1B

SmartPlant Electrical User's Guide

Single Line Diagrams

In Electrical Engineer:

In a generated SLD:

Example D:
Three motors connected in parallel. The SLD is based on a single power source.
In the Parallel Equipment Assistant:

Item 1

Item 2

MTR-1A

MTR-1B

MTR-1B

MTR-1C

In Electrical Engineer (the SLD is based on a single power source):

SmartPlant Electrical User's Guide

299

Single Line Diagrams

In a generated SLD:

Example E:
Three motors connected in parallel. The SLD is based on two power sources.
In the Parallel Equipment Assistant:

300

Item 1

Item 2

MTR-1A

MTR-1B

MTR-1B

MTR-1C

In Electrical Engineer (the SLD is based on two power sources):

SmartPlant Electrical User's Guide

Single Line Diagrams

In a generated SLD:

To define the display settings, such as the vertical and horizontal distance between the
equipment items, see Set Parallel (see "Set Parallel Equipment Display Options" on page 301)

Set Parallel Equipment Display Options


This procedure allows you to define the display settings of parallel equipment in single line
diagrams.
1. On the Single Line Diagram Options dialog box, click the Related Equipment tab.
2. Under Parallel equipment settings, do the following:
a. Under Horizontal distance, type a value to determines the horizontal distance between
adjacent electrical equipment items that are connected in the parallel branch. For
instance, the distance between M1A and M1B in Example B in the Displaying Equipment
Connected in Parallel (on page 296) topic.
b. Under Vertical distance, type a value to determines the vertical distance between the
horizontal axis of the parallel equipment and the parallel connection branch. For instance,
the distance between M1A and C-M1A-DS in Example B in the Displaying Equipment
Connected in Parallel (on page 296) topic.
If a given parallel connection is defined on the inlet side, the software displays the
parallel branch above the main equipment. If a parallel connection is defined on the outlet
side, the software places the parallel branch below the main equipment.
c. Under Units, select an appropriate unit of measure for the distance between the items in
the parallel branch.

SmartPlant Electrical User's Guide

301

Single Line Diagrams

Hide PDB Sub-Items in an SLD


In a single line diagram, you can hide the sub-items of a particular PDB and show that PDB and all
of its sub-items as a single block.
1. Select a PDB in the Electrical Index.
2. In the Properties window, set the Hide PDB internals property to TRUE.
3. When generating a single line diagram, on the General tab of the Single Line Diagram
Options dialog box, select the Activate 'Hide PDB internals' property check box.
4. Generate the SLD.
The software hides the PDB sub-items only for those PDBs whose Hide PDB internals
property has been set to TRUE. The other PDBs are displayed with all their sub-items.

Set the Extent of Downstream Branches


For single line diagrams generated for PDBs, you can determine the extent of the downstream
branch that is included in the generated SLD,
1. Generate a single line diagram for a PDB. (For details, see Generate a Single Line Diagram
for a PDB (on page 289).)
2. On the General tab of the Single Line Diagram Options dialog box, in the Include in SLD
group box, select one of the following options from the Feeder display options:
Do not show downstream branch items Instructs the software to show only PDB
internal items: buses, cells, circuits, and circuit internals. The items that are connected
directly to the PDB internal items will be represented by a reference label.
Show all items in the downstream branch up to the first load Instructs the
software to show all the items in the feeder branch up to the first equipment item that is
defined as load. If this load is connected to a downstream equipment item, the generated
SLD will show a reference label that represents this equipment.
Show all downstream branch items Instructs the software to show the complete
feeder branch that will include all electrical items in the branch regardless whether they
have been defined as loads. The SLD will also show in the downstream branch other
buses within the same PDB and all the equipment that is connected to their feeders
downstream. If a load in the feeder branch is connected to a downstream bus that belongs
to another PDB, the SLD will show a reference label pointing to the associated PDB and
bus.
Note that the software stops the display of the downstream branch at the
item which belongs to the Loads folder in the Electrical Index. In this case, the software
shows a reference label that points to the existing downstream equipment.
3. Continue setting your options for the SLD generation as you require.

302

SmartPlant Electrical User's Guide

Single Line Diagrams

Placement of Circuits on Bus Sections


The software allows you to control the placement of incomer and feeder circuits on bus sections in
a generated SLD drawing. You control this placement by selecting a method for the circuit
positions on the bus symbols in the drawing. The placement depends on the sequence in group
values of each circuit. You can either place the incomer circuits on the first bus section followed by
the feeder circuits or place the incomer and feeder circuits continuously depending on their
sequence in group values.
1. Generate a single line diagram. (For details, see Generating New Single Line Diagrams (on
page 287).)
2. On the Single Line Diagram Options dialog box, click the Buses tab.
3. In the Display options group box, select one of the following methods that control the
placement circuits on the bus symbol in the generated SLD drawing:
Position the incomers and feeders by showing the incomers on the first page and
first bus section Allows you to set the position of the incomers and feeders on the bus
using the sequence in group values in such a way that the incomer and feeder circuits in
the group are counted separately. Selecting this option always results in placing the
incomer circuits on the first page and on the first bus section. The number of bus
sections, in this case, is determined only by the number of feeder circuits that are defined
for that bus.
Position the incomers and feeders by their sequence numbers Allows you to set
the position of the incomers and feeders on the bus using the sequence in group values in
such a way that all the incomer and feeder circuits in the group are counted together in a
continuous manner. Selecting this option results in placing the incomers and feeders on
bus sections based on the sequence in group values of the incomers and feeders. The
number of bus sections, in this case, is determined by the total number of feeder and
incomer circuits on a particular bus.

Note that bus risers and couplers are always displayed on the same page adjacent to
each other.
To ensure that all the circuits are placed correctly, all the circuits must have sequence in
group values. The software places the circuits that do not have sequence in group values
first and only then the rest of the circuits.
4. Continue setting your options for the SLD generation as you require.

Hide Bus Feeders in an SLD


In a single line diagram, you can hide the bus feeders of a particular bus.
1. Select a bus in the Electrical Index or Electrical Engineer.
2. In the Properties window, set the Hide bus feeders property to TRUE.
3. When generating a single line diagram, on the General tab of the Single Line Diagram
Options dialog box, select the Activate 'Hide bus feeders' property check box.
4. Generate the SLD.

The software hides the bus feeders only for those buses whose Hide bus feeders property
has been set to TRUE. The other buses are displayed with all their feeders.

SmartPlant Electrical User's Guide

303

Single Line Diagrams

If a particular bus belongs to a PDB whose sub-items have been hidden, this bus and its
feeders will not be displayed in a single line diagram.

Find an Electrical Item in an SLD


This feature allows you to find an electrical item in an open single line diagram. You select an
electrical item in the Electrical Engineer or the Electrical Index and the software finds the item in
the open SLD.
1. Open or generate a single line diagram.
2. In the Electrical Engineer or Electrical Index, expand the pertinent hierarchy in the tree
view.
3. Right-click an electrical item and select Find in SLD on the shortcut menu.

The software highlights the item it finds in the SLD. You can now click
to modify the
magnification level of the selected item. To cancel the selection, click somewhere outside the
drawing.
In redlining mode, the Find in SLD option is not available.

Insert a Legend in an Existing SLD


While defining SLD generation options, the software allows you to include a legend which explains
the meaning of all the symbols used in the generated SLD. The software also allows you to insert
a legend in an existing SLD that was generated without a legend. Once an SLD contains a
legend, you can drag the legend and move it like any other element in an SLD.
1. Open a single line diagram. For more information, see Opening Existing Single Line
Diagrams (on page 293).
2. Click Edit > Insert > Legend.
3. On the SLD Legend dialog box, select one of the following options:
Horizontal.
Vertical.
4. In the SLD, click where you want the software to insert the legend.

304

Once an SLD contains a legend, it behaves like any other element in the SLD. Therefore, you
can resize it or drag it to another place in the SLD.
The SLD legend contains the symbols that represent the electrical items in the open single line
diagram. Also, the software shows custom symbols if you have defined the Electrical
Equipment Type property and selected a symbol from the Symbol Name list in the
Properties window for a particular electrical item.
For information on how to use custom symbols in your SLDs and the SLD legends, see Use
Custom Symbols in SLDs (on page 305).

SmartPlant Electrical User's Guide

Single Line Diagrams

Use Custom Symbols in SLDs


You can use a custom symbol to present a particular item in a single line diagram. The software
will use this custom symbol instead of the default symbol taken from the shipped reference data
and specified by you on the Symbology page in Options Manager.
Create your custom symbol using Catalog Manager or any other appropriate tool.
Then, place the image file in the default folder or its sub-folders where you store your reference
data symbols. You set the default symbol folder in the SmartPlant Electrical Options Manager. For
more details, see Defining File Locations in the SmartPlant Electrical Option Manager Users
Guide.
1. In the Electrical Index or Electrical Engineer, select the item tag you want to associate with
a custom symbol.
2. Do one of the following:
Click Actions > Associate Custom Symbols.

Click
.
Right-click the selected item and then click Associate Custom Symbols on the shortcut
menu.
3. On the Associate Custom Symbols dialog box, under Document Type click on a cell, and
from the list select Single Line Diagrams.
4. Under Symbol, click
.
5. Browse to the symbol (.sym) file you want to add, and select the file.
You can only choose symbols that are stored in the default folder and its
sub-folders.
6. Click OK.

If, during the SLD generation, the software cannot find a referenced symbol for a specific
electrical item, the software uses the default symbol file (default.sym) to represent the
item. You specify default files in Options Manager.
For guidelines about the creation of custom symbols in Catalog Manager, see Guidelines for
Creating SLD Symbols in Catalog Manager (on page 310).

Customize a PDB Border (Frame) on an SLD


1. Open Catalog Manager and create or edit the PDB border symbol. For more information, see
Create a Symbol in the Catalog Manager User's Guide, under Working with Symbols,
Creating Symbols, Create a Symbol.
2. Open Options Manager and define the symbology for the PDB border symbol created in
Catalog Manager. For more information, see Define an Item Type Symbol in the Options
Manager User's Guide, under Using Options Manager, Defining Item Type Symbology, Define
an Item Type Symbol.
3. In SmartPlant Electrical associate your PDB border symbol with the PDB you require. For
more information, see Associate a Custom Symbol with an Item Tag (see "Associate a
Custom Symbol with Item Tags" on page 347)

SmartPlant Electrical User's Guide

305

Single Line Diagrams

PDB Frames Examples in SLDs


The following images illustrate how the software draws PDB frames in single line diagrams.
Example 1: A PDB frame drawn around two buses that belong to the same PDB. Note the PDB
name shown in the drawing.

306

SmartPlant Electrical User's Guide

Single Line Diagrams


Example 2: A PDB frame drawn around two sections of the same bus shown with a bus break.

Remove an Item from an SLD


This topic explains how to remove an item from a Single Line Drawing that was generated using a
blank template.
This procedure only works for SLDs created using a blank SLD template. It cannot
be used on SLDs that were automatically created by the software.
1. On your open SLD select the item you want to delete.
2. Do one of the following:

Click
.
Click Edit > Remove.
Right-click, and from the shortcut menu, click Remove.

SmartPlant Electrical User's Guide

307

Single Line Diagrams

Creating and Using Symbol Assemblies for SLD


Diagrams
An assembly is a symbol comprising two symbols or more, where there is a functional relationship
between the item types the symbols represent. Assemblies are created within SLD items.
Draw and create the symbol assembly in the Catalog Manager.
You can view the symbol assembly and generate the SLD in SmartPlant Electrical. In this way
you can use assemblies to fully illustrate complex items such as circuits with their internals. When
creating an assembly or combining two assemblies or more, the items in the assemblies must
have valid relations.
The following guidelines apply when creating assemblies:

General Guide Lines


An assembly is a group of symbols related to a main item with related item types. The following
item types are used as placeholders for assemblies:
Circuits / typical circuits
Loads
Conventional equipment
Generators
After assembly generation, you can select an individual item within an assembly, and view the
item properties and perform connections to auxiliary points.
After assembly generation you will not be able to break the graphics into individual symbols that
can be moved. The assembly will move as one group.

Assembly Composition Guidelines


Circuit / typical circuits
Circuit data (main item data).
All internals (including metering equipment).
All I/O associated signals.
Cable item tags associated to the circuit.
Schematic item tag.
Loads/converting equipment/generators
Main item data (circuit information and properties).
Associated control station and associated cable item tags.
Associated instruments and their cable item tag.
Motor space heater for motors.
Schematics item tag.
I/O signals.
control or instrument cables item, tags (embedded cable symbols retrieve cable data without
referring to their category).
Transformers and generators:
Neutral grounding resistor data.
Neutral grounding cable data (as property only).
Neutral grounding metering equipment data.

308

SmartPlant Electrical User's Guide

Single Line Diagrams

Create and Use a Symbol Assembly


1. Create a new item or use an existing one.
2. To create an assembly, drag the desired symbols to the drawing sheet.
You can use Smart Text Editor to create a label if desired. For details see Smart Text
Dialog Box (a_CATALOGMANAGERSmartText_Editor_Dialog_Box_sp).
3. In the Properties window, select the appropriate item type from the list, and click
.
4. In Option Manager, click Option > Locations.
5. In the Locations window, verify that the Default SLD Symbol Path location, matches the
symbol location in Catalog Manager.
6. In Option Manager, you can define the item type symbology. For details see, Define an item
type symbol (PROJOPTIONSDefine_an_item_type_symbol_h).
7. In SmartPlant Electrical index tree view pane, right click the predefined item and on the
shortcut menu click Associate Custom Symbol.
8. On the Associate Custom Symbol dialog box, click Add.
9. From the Document type column, from the list, select the desired document type.
10. From the Symbol column, select the assembly symbol to associate with the document type.
11. In the Electrical Engineer tree view pane, right click the item and on the shortcut menu, click
New SLD.
12. On the Single Line Diagram Options dialog box, click Generate to view the SLD containing
the assembly.

The assembly item properties now appear in the Properties window in SmartPlant Electrical.
In an assembly, items of the same type are sequenced in-group. It is possible to change the
sequence but two items cannot have identical sequence values.
It is possible to combine several assemblies into one.

Gapping Lines
A gap in a drawing is a condition that exists when two lines intersect graphically in the drawing but
not physically in the plant. In order to portray this condition, you can choose that lines show a gap
at these non-physical intersections. This can help the clarity of your drawing considerably.
Gapping is carried out automatically when you open an existing drawing. If you want to perform
gapping on a drawing that is already open, you must use the command Tools > Gap Now.

SmartPlant Electrical User's Guide

309

Single Line Diagrams

Perform Line Gapping in Your Drawing Now

Click Tools > Gap Now.

Guidelines for Creating SLD Symbols in Catalog


Manager
SmartPlant Electrical uses symbols to generate single line diagrams. You create these symbols
in Catalog Manager. You store the symbol files in the folder that you define in the Default SLD
Symbol Path location in Options Manager.

General Guidelines
When generating a single line diagram, SmartPlant Electrical searches for the symbols that match
the item type names. Therefore, all the symbol names must match the item type names of the
electrical items that you want to include in the SLD. You can, however, save a symbol file under
a different name and assign it to an electrical item using the Associate Custom Symbols
command from the Actions menu. In this case, the software will use the associated symbol file to
represent the electrical item in an SLD.
You have to set an item type for each symbol that you create. Each symbol consists of graphical
elements (lines, circles, and so forth), SmartText properties, fixed text (labels), connect points,
and an origin point.
Note that you can use all the graphical tools provided in Catalog Manager to create your symbols.

Connect Points
Two types of connect points are used in SLDs:
Connect Point for main power connection.
Auxiliary Point for creating the logical connection between equipment, metering, and
relays.
All symbols must have at least two connect points, apart from some exceptions listed below.
Each connect point consists of a:
Connection type Connect point or auxiliary point.
Connection angle The angle at which the connection is made between the equipment and
the connector.
Side A numeric value used to distinguish between the "power in" 1, and the "power out"
2, sides of the equipment.
Number A sequential, unique, index number for the connect point. Each side, within a
connection type, starts at number one and progresses in sequential steps.
The upper and lower connect points must have the same X coordinates.

310

SmartPlant Electrical User's Guide

Single Line Diagrams

Origin Point
Place the origin point in the middle of the existing or virtual line that connects the upper and lower
point.

Special Symbols
The software uses several symbols to represent a transformer in a single line diagram Transformer symbol and TransformerComponent symbols. You create each symbol
separately. However, the origin point of all the symbols has to be placed in such a way that when
the software superimpositions all the symbols, it creates a complete representation of a
compound transformer.
Use the following properties to create transformer symbols:
Symbol name Transformer
One upper connect point
Connection angle: 90 degrees (up)
Index 1
Symbol name TransformerComponent0
One lower connect point
Connection angle: 90 degrees (down)
Index 1
Symbol name TransformerComponent1
One lower connect point
Connection angle: 90 degrees (down)
Index 1
Symbol name TransformerComponent2
One lower connect point
Connection angle: -90 degrees (down)
Index 1
Catalog Manager uses the TransformerComponent0 symbol together with the Transformer
symbol to create a 2-winding transformer representation.
Catalog Manager uses TransformerComponent1 together with the Transformer and
TransformerComponent 2 symbols to create a 3-winding transformer representation.
You can customize the transformer and transformer component symbols in the SmartPlant
Options Manager. For more details, see Define a Transformer Component Symbol.
For an example of origin placement in each of the transformer symbols, you can open any of the
above mentioned symbol files located in the folder that you define in the Default SLD Symbol Path
location in Options Manager.
Bus symbols:
Bus SmartPlant Electrical creates bus representations in SLD
automatically. However, you still need to create a bus symbol and set its line type, line
width, and define SmartText attributes. The origin point must always be at the left edge
of the symbol.
SmartPlant Electrical uses the above properties to create the bus symbols in single line
diagrams. You can create as many bus symbols with different properties as required so
that you can generate single line diagrams with various line types and widths. Note that
SmartPlant Electrical uses only the symbol properties and not the file itself to represent
buses in single line diagrams. After creating bus symbols and defining their properties in

SmartPlant Electrical User's Guide

311

Single Line Diagrams

312

Catalog Manager, you can modify the bus properties prior to generating an SLD by
associating a different symbol file using the Associate Custom Symbols command from
the Actions menu. This way, the software can generate a single line diagram with
various bus representations.
Symbols that represent the connection between two buses in a PDB:
Horizontal representation Special symbols are used to show the horizontal connection
between two buses and their internals. The two symbols are CircuitBusTieCoupler.sym
and CircuitBusTieRiser.sym. All disconnect equipment, cable, or any other item that
needs to be displayed in the internals of the bus tie have a specific syntax,
<ItemType>BusTie.sym. The software generates the SLD and searches for the
BusTie.sym suffixed symbols if in the Single Line Diagram Options dialog box the circuit
internals have been chosen to be displayed. Note that the BusTie symbol is a circuit'
type symbol and has its first connection point on the rightmost side and the second
connection point at the leftmost side.
Vertical representation The standard bus coupler-riser circuit connection
representation that includes both coupler and the riser circuits and displays them as
vertical objects, connected to each other. The software displays both circuits as standard
arrows.
If you want to have more than one symbol to represent a bus tie, you can create a
custom symbol (for example, MyDisconnectSwitch.sym) and assign it, for example, to a
disconnect switch using a default symbol or custom symbol. Then, create another custom
symbol with the same name plus BusTie (for example, MyDisconnectSwitchBusTie.sym
and arranged horizontally if needed). Place this custom symbol in the SLD symbols folder.
SmartPlant Electrical will use this symbol if you select the Use bus tie symbols check
box on the Circuits & Internals tab of the Single Line Diagram Options dialog box.
Other symbols:
Other special symbols include <ItemType>Alt.sym used to represent equipment that has
two sources of power supply, Buswrappingmarker_Right, Buswrappingmarker_Left,
and Triangle- Compare .
Note that the connect point numbering sequence for an Alt.sym symbol is "main power
in" 1, "power out" 2, and "alternate power in" 3.
From This is a system symbol; do not modify it.
Default (Symbol name = Default) SmartPlant Electrical uses a default symbol
whenever a required symbol for a particular item type does not exist. Default symbols
require two connect points. You can select any item type for the Default symbol.
For information on how to use custom symbols in your SLDs and the SLD legends, see Use
Custom Symbols in SLDs (on page 305).
For information on how to place connect points in a symbol in Catalog Manager, see Place
Symbol Connect Points (on page 313) in the Catalog Manager User's Guide, under Working
with Symbols, Creating Symbols, Place Point Command.
A list of all shipped symbols and their SmartText attributes is available in the symbols.txt file
located in the folder that you define in the Default SLD Symbol Path location in Options
Manager.
SmartPlant Electrical shipped data includes two sets of transformer symbol files. The IEC set
includes:
TransformerIEC
TransformerComponent0IEC
TransformerComponent1IEC

SmartPlant Electrical User's Guide

Single Line Diagrams

TransformerComponent2IEC
The NEC set includes:
TransformerNEC
TransformerComponent0NEC
TransformerComponent1NEC
TransformerComponent2NEC
Since the software uses the Transformer, TransformerComponent0,
TransformerComponent1, and TransformerComponent2 symbols by default, you have to
replace this set with the NEC or IEC symbols and rename them without their IEC or NEC
suffixes if you want to use symbols belonging to another standard.
The following limitations of SLD symbol creation exist in Catalog Manager:
On the Smart Text Editor dialog box, you cannot use the Visible, Short Text, and
Format features.
The angles for the symbol connect points are fixed at 90 degrees for the top connect point
and -90 degrees for the bottom connect point.
There is no support of symbol properties in the Properties window except for the
selection of item types.
The software does not retain the assigned smart text labels if you change the item type of
a symbol for which smart text labels have been created.

In order for the software to rescale all the items correctly, make sure that when
creating symbols that contain text or smart text, the Units space property is set to World. Note
the World is not the default setting for this property.

Place Symbol Connect Points


1. In Catalog Manager, open the desired .sym file.
2. On the Catalog Tools toolbar, click Place Points
.
3. From the Connection Type list, select the connection type required.
4. Click the symbol at the location where you want to add the connect point.
The software displays a dynamic dashed line representing the connection of the new
connect point.
5. Orient the dashed line to represent the appropriate connection angle for the new connect
point.
6. After the connection angle is correct, click again to place the connect point.

You can also type the exact angle value in the Connect angle field to define the connection
angle.
You can right-click during this procedure to reset the command.

SmartPlant Electrical User's Guide

313

Single Line Diagrams

Manipulating Smart Labels


Component handles allow you to rotate or mirror a Smart Label around axes changing their
orientation in relation to the labels associated item. Only those Smart Labels that appear in cable
block diagrams, power distribution board layout drawings, single line diagrams, and wiring
diagrams, and are associated with connectors can be mirrored or rotated.

The mirror handle allows you to mirror about the horizontal and vertical axes, defined in
relation to the origin of the item. You can mirror items by dragging the mirror handle in the
appropriate direction. The software shows you the result of the operation dynamically so that
you can be sure to mirror the item correctly.

The rotate handle provides a mechanism for rotating components around their origin. You
can rotate items by dragging the rotate handle in the appropriate direction. The software
shows you the result of the operation dynamically so that you can be sure to rotate the item
correctly.
For more information, see Working with Labels in the SmartPlant Engineering Manager Users
Guide.

Create a Mirror Image of a Smart Label


This procedure shows you how to mirror a Smart Label about the horizontal and vertical axes.
1. Select the Smart Label in the drawing.
2. Click the mirror handle , the cursor changes to
.
3. Drag the mirror handle in the direction that you want to mirror the item, the new label position
is outlined on our drawing.
4. Release the mirror handle.

Rotate a Smart Label


This procedure shows you how to rotate a Smart Label on your drawing.
1. Select the Smart label on the drawing.
2. Click the rotate handle
.
3. Drag the rotate handle in the direction that you want to rotate the item.
You can click the rotate handle closer to or further from the center of the item to change the
step angle for the rotation.

314

SmartPlant Electrical User's Guide

Single Line Diagrams

Align Smart Labels


This procedure shows you how to align Smart Labels on your drawing.
1. In the Drawing view, select the labels that you want to align.
In order to align labels, you must be sure not to select any drawing items other than
labels. You can remove an item from a select set by pressing CTRL and clicking the item.
2. Click the appropriate alignment button on the main toolbar:

Align Left Align labels so that their left-most lines match

Align Right Align labels so that their right-most lines match

Align Center About Vertical Align labels so that their center points agree on a
horizontal line

Align Center About Horizontal Align labels so that their center points agree on a
vertical line

Align Top Align labels so that their top lines match

Align Bottom Align labels so that their bottom lines match

Rename the Sheet Tabs in an SLD Drawing


This procedure explains how to rename the Sheet tabs in a generated drawing. This enables you
to have different page names for each of the pages in a multi-page drawing.
Prior to renaming the Sheet tabs, you have to add the &Sheet.Name macro to the
drawing template. For details, see Enable the Renaming of Sheet Tabs in a Drawing (on page
258).
1. Generate a new drawing.
2. In the generated drawing, do one of the following:
Double-click a tab that you want to rename.
On the SmartPlant Electrical menu bar, click File > Sheet Setup.
3. On the Sheet Setup dialog box, click the Name tab and type a new name under Sheet name.
4. Click OK to rename the tab.
The software retains the new name after you reopen the drawing.

SmartPlant Electrical User's Guide

315

SECTION 19

Cable Block Diagrams


Cable Block Diagrams (CBDs) provide a graphical representation of the interconnection of all
control, power, instrumentation, and grounding cables, and their related equipment such as power
distribution boards (PDBs), generators, motors, and so forth, within your plant. They show the
project cable flow between the various cabinets and equipment of your project.
Cable block diagrams are used in the preliminary planning stages of the project life cycle to verify
the destination panels for cables as no wiring connections or terminations are needed at this early
stage of your project. Cable block diagrams can also be used for ordering MTO (made to order)
cables at the feed stage of your project, and later after the completion of your project as part of the
maintenance program to show the location of all major cables, panels, junction boxes, and so
forth. Use the same equipment and cables in more than one drawing.
SmartPlant Electrical allows you to drag items from the Electrical Index, Electrical Engineer,
and Reference Data Explorer to your drawing, and position them exactly where you want them to
be. You can create associations among the items, especially when placing cables on your
drawing. You can manually connect the cables on a CBD. The software checks the connections
and informs you if there is a problem.
To present the placed items on the drawing, the software uses either a shipped symbol taken from
the reference data (specified by you on the Locations page in Options Manager) or a custom
symbol that you have associated with a specific item. If these images are not available in the
specified folder, the software uses a default image taken from the shipped reference data. For
more information, see Customizing Symbols (on page 347) and Defining File Locations in the
SmartPlant Electrical Option Manager Users Guide.

Creating Cable Block Diagrams


There are two ways in which you can create a project cable block diagram (CBD):
Create a blank drawing and then place and connect the electrical items that you require. For
details, see Create a Blank Project CBD (on page 318).
Create a project CBD based on a typical cable block diagram. Typical CBDs already contain
predefined electrical items and associations. Using this option automates the creation of
project CBDs and electrical items as the software automatically creates these project items
based on the typical definitions. For details, see Create a Project CBD Based on a Typical
Cable Block Diagram (on page 318).

SmartPlant Electrical User's Guide

317

Cable Block Diagrams

Create a Blank Project CBD


This procedure explains how to create a blank cable block diagram where you can place the
electrical items that you require and make all the necessary associations and connections.
1. In the Electrical Index open the Documents folder.
2. Right-click the Cable Block Diagrams folder, and on the shortcut menu, click New Cable
Block Diagram.
3. Right-click the new cable block diagram and then click Document Properties.
4. On the Document Properties dialog box, do the following:
a. Under Document number, type a name of up to 80 characters for the new typical CBD.
b. Click in the Description box and type a brief description if needed.
c. From the Template name, select an appropriate drawing template.
d. To filter the display of cables in the CBD, select the appropriate check boxes under
Display cable types in cable block diagrams.
5. Click OK.
6. Place the required items on the new drawing.
In addition to smart graphics, you can also add auxiliary graphics, redlining, and
annotations to your CBD. For details, see Working with Smart Data and Auxiliary Graphics in
a CBD (on page 320). Once you save the drawing, the software retains all your additions and
modifications.
7. When done, click

on the main toolbar before closing the drawing.

For more information, see Working with Smart Data and Auxiliary Graphics in a CBD (on
page 320).

Create a Project CBD Based on a Typical Cable Block


Diagram
This procedure explains how to create a project cable block diagram (CBD) based on a typical
CBD. The advantage of using this option is that you can automate the process of creating your
project electrical items using predefined typical items and associations. The software
automatically creates a project CBD, creates and places all the electrical items on the drawing,
and sets all the existing associations among the electrical items as defined in the typical CBD. For
details on how to create a typical CBD, see Create a Typical Cable Block Diagram (on page 48).
1. In the Electrical Index expand the Documents folder.
2. Do one of the following:
Drag an appropriate typical CBD from the Reference Data Explorer to the Cable Block
Diagrams folder in the Electrical Index.
Right-click the Cable Block Diagrams folder and them on the shortcut menu, click
Create from Typical.
3. If you used the right-click option, on the Find dialog box, find an appropriate typical CBD that
will serve as a basis for the new CBD and click OK.
4. If the new plant CBD is based on a typical CBD that contains typical circuits, do the following:
a. On the Create New Plant Circuits dialog box (that opens automatically once you select
or drag a typical CBD that contains typical circuits), select an appropriate plant PDB by
clicking
in the Plant PDB field.

318

SmartPlant Electrical User's Guide

Cable Block Diagrams


You do not need to select a plant PDB if you want to assign your new circuit to a
free-standing bus.
b. From the Plant Bus list, select an appropriate bus belonging to the selected plant PDB or
click
to select a free-standing bus.
If you do not select a bus for a particular typical circuit listed in this dialog
box, the software will not create a plant circuit for that typical circuit.
c. From the Plant Cell list, select an appropriate cell or create a new cell as you required.
You can skip the cell assignment for the new plant circuit if needed.
The software validates that the circuits created under a cell belong to the same
circuit type.
d. Click OK for the software to create new plant circuits and assign them according to the
selections you just made.
5. In the open CBD drawing, make any changes as required..
In addition to smart graphics, you can also add auxiliary graphics, redlining, and
annotations to your CBD. For details, see Working with Smart Data and Auxiliary Graphics in
a CBD (on page 320). Once you save the drawing, the software retains all your additions and
modifications.
6. When done, click

on the main toolbar before closing the drawing.

After saving the new CBD, the software associates the new plant items with the new CBD
drawing and allows you to open the new drawing from the Associated Drawings dialog box
(on page 620).
For more information about working with CBDs, see Working with Smart Data and Auxiliary
Graphics in a CBD (on page 320).

Open an Existing Cable Block Diagram


This procedure shows you how to open an existing cable block drawing.
1. In the Electrical Index, Documents Folder, expand the Cable Block Diagrams folder.
2. Select the cable bock diagram that you want to open, and do one of the following.
Double-click the selected drawing.
Click File > Open > Drawing.

Click
.
Right-click and on the shortcut menu, click Open.

For information about placing items on a drawing and connecting cable between equipment
items in a CBD, see Place and Connect Items in a Cable Block Diagram (on page 324).
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

SmartPlant Electrical User's Guide

319

Cable Block Diagrams

Rename the Sheet Tabs in a CBD Drawing


This procedure explains how to rename the Sheet tabs in a generated drawing.
Prior to renaming the Sheet tabs, you have to add the &Sheet.Name macro to the
drawing template. For details, see Enable the Renaming of Sheet Tabs in a Drawing (on page
258).
1. Generate a new drawing.
2. In the generated drawing, do one of the following:
Double-click a tab that you want to rename.
On the SmartPlant Electrical menu bar, click File > Sheet Setup.
3. On the Sheet Setup dialog box, click the Name tab and type a new name under Sheet name.
4. Click OK to rename the tab.
The software retains the new name after you reopen the drawing.

Working with Smart Data and Auxiliary Graphics in a


CBD
Cable block diagrams (CBDs) provide you with a full graphical environment for your front-end
design. Apart from regular actions in a drawing such as zooming, selecting, saving, and so forth,
you can perform the following actions:
Action

Description

Placing electrical Items

You can select an electrical item (a PDB, load, cable, and so


forth) in the Electrical Index or Reference Data Explore
and drag it to an open cable block diagram.
Local panels and junction boxes that contain
circuits cannot be placed on cable block diagrams..
See also Use Reference Items in a Cable Block Diagram (on
page 325).

320

Moving items

Select an item and drag it to another location in the


drawing. Save the drawing to keep the items you moved in
their new locations. Note that this does not affect the data in
your database.

Placing cables

Drag a cable from the Electrical Index, Electrical Engineer,


or Reference Data Explorer to an open CBD.
When placing parallel cables, drag only one of the parallel
cables in the set. The software represents parallel cables
using a single line.

SmartPlant Electrical User's Guide

Cable Block Diagrams


Action

Description

Placing single-core cable


assemblies

Select a single-core cable assembly in the Electrical Index


or Reference Data Explorer and drag it to an open cable
block diagram.

When dragging from the Electrical Index, instead of


dragging a single-core cable assembly, you can drag one
of the current-carrying cables belonging to a given
single-core cable assembly.
All the current-carrying cables of an assembly are shown
as one line in a CBD.
Selecting a single-core cable assembly in a CBD enables
you to edit the properties of the individual
current-carrying cables in the Properties window.
The grounding and neutral appear on the CBD as
separate lines. You can connect them as you require.
You cannot place an assembly that has a cable which is
connected to an equipment item that has not been placed
on the current CBD.
The software uses the symbol used for the
current-carrying cables to identify single-core cable
assemblies in the drawing.
If you defined a cable formation macro in the symbol
used for single-core cable assemblies, the software
identifies the formation of an assembly according to the
following formula:
<Number of parallel power cables> multiplied by
[<Number of current-carrying cores> multiplied by
<formation of a single-core cable assembly>]
Example: 2 x [3 x (1 x )1 x 240 mm2))]

Connecting and disconnecting


cables

To connect a cable, first place it on a CBD and then drag one


of the cable ends of to a connect point of an electrical item.
When connecting parallel cables, drag the end of the line that
represents the parallel cables to a connect point of an
equipment item.
To disconnect a set of parallel cables or a single cable, drag
its end away from a connect point of an electrical item.
If the symbol to which you want to connect the cable does not
have enough connection points, the software displays a
message informing you that there is a shortage of connection
points on that symbol.

SmartPlant Electrical User's Guide

321

Cable Block Diagrams


Action

Description

Placing connectors

To place a connector, click


on the Draw toolbar. For more
details about various actions with connectors, see Toolbars
and Ribbons (on page 827).
See also Mark Auxiliary Graphics on a Cable Block Diagram
(on page 326) to learn how to distinguish between plant items
and auxiliary graphics in a CBD.
A connector is a line that serves to connect items in a
drawing. A connector is an auxiliary graphic that does not
represent any project item.

322

Connecting and disconnecting


connectors

To connect a connector, first place it on a CBD and then drag


one of its ends to an electrical item.
To disconnect a connector, drag its end away from the
equipment

Connecting and disconnecting


single-core cable assemblies

After placing a single-core assembly on a CBD, drag one of


its ends to a connect point of an equipment item. This action
connects all the other current-carrying cables belonging to
that assembly on the selected cable end. You can see this
association in the Cable Common Properties of each
individual cable.
To disconnect a single-core cable assembly, drag its end
away from a connect point of an electrical item.

Connecting equipment items in


parallel

After placing the required equipment items and cables on a


CBD, select a cable that hasn't been connected yet and then
select an equipment item pair from the Parallel Pairs list on
the Modify Connector ribbon. You can now drag the
selected cable to one of the pertinent equipment items that
you want to connect in parallel. For a detailed procedure, see
Connect Equipment Items in Parallel (on page 202).

Moving a connection point of a


connected cable or connector

You can move a connection point of a connected cable or


connector along the outer edge of the symbol to which the
cable is connected. Drag the required connection point along
the edge of the symbol. If you want to drag it to a point that is
already connected by another cable, disconnect that cable
first to make the connection point available for another
connection.

Manipulating Smart Labels and


macros

You can move and manipulate Smart Labels and macros in


an open CBD. For details, see the following:
Manipulating Smart Labels (on page 314).
Manipulating Drawing Items (on page 360).

Entering and modifying item


properties

Select an electrical item and then enter or modify its


properties in the Properties window.

SmartPlant Electrical User's Guide

Cable Block Diagrams


Action

Description

Inserting annotations and redlining Add text labels, symbols, or watermarks to your CBD as
annotations. Add text, linked symbols, circles, rectangles,
and lines to your CBD as redlining. For more information,
see Managing Annotations and Redlining (see "Annotations
and Redlining" on page 349).
Removing items from a CBD

In an open CBD, right-click the item and then click Remove


on the shortcut menu. Note that if you want to remove a
cable, you must first disconnect it.

Renaming a document and


entering revisions

In an open CBD and click Edit > Document Properties.

Saving a CBD as an external file

In an open CBD, click File > Save As.

Printing a CBD

Click File > Print.

Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.
Cable block diagrams do not allow you to make dual power source connections. You can
make these connections in the Electrical Engineer. After making such a connection in the
Electrical Engineer, the cable block diagrams generated for these items will display the dual
power source connections correctly. You can, however, disconnect an item from an alternative
power source in a cable block diagram.

SmartPlant Electrical User's Guide

323

Cable Block Diagrams

Place and Connect Items in a Cable Block Diagram


This procedure shows you how to place electrical items on an open CBD drawing and connect the
placed cables between appropriate items.
To present the placed items on the drawing, the software uses either a shipped symbol taken from
the reference data (specified by you on the Locations page in Options Manager) or a custom
symbol that you have associated with a specific item. If these images are not available in the
specified folder, the software uses a default image taken from the shipped reference data. For
more information, see Customizing Symbols (on page 347) and Defining File Locations in the
SmartPlant Electrical Option Manager Users Guide.
For details on various actions that you can carry out in a cable block diagram. see Working
with Smart Data and Auxiliary Graphics in a CBD (on page 320).
1. Open a cable block diagram or create a new one.
2. Drag the appropriate items from the Electrical Index, Reference Data Explorer, or
Electrical Engineer to the open drawing and position them on the drawing as needed.

You can drag the following items to an open cable block diagram:
All electrical equipment items apart from buses, and relay functions.
You can drag disconnect electrical equipment items if they are stand-alone items, that
is, if they do not belong to any circuits.
Metering equipment items can be dragged only if they are current transformers or
potential transformers.
All wiring equipment items (panels, cables, and so forth) apart from busways, glands and
cableway components.
In addition to smart graphics, you can also add auxiliary graphics, redlining, and
annotations to your CBD. For details, see Working with Smart Data and Auxiliary
Graphics in a CBD (on page 320). Once you save the drawing, the software retains all
your additions and modifications.

When placing a circuit or a PDB on a cable block diagram, the following rules apply:
Placing a circuit is allowed only if the parent PDB of the circuit is not in the current cable
block diagram.
Placing a power distribution board is allowed only if none of the child circuits have been
placed in the current cable block diagram.
3. To connect a cable that has been placed on a CBD drawing, do the following
a. In the open drawing, click an appropriate cable.

After clicking the cable that want to connect, the software switches on all the available
connection points on the equipment symbols that can be connected The software
displays only the connection points available for the specific category of the cable
chosen. For more details, see Place Point Ribbon (SmartPlant Electrical) in the
Catalog Manager User's Guide, under Working with Symbols > Place Point
Command. If no connection points are available, the software does not allow the
cable to be connected.
If the symbol to which you want to connect the cable does not have enough
connection points, the software displays a message informing you that there is a
shortage of connection points on that symbol.
b. Drag an appropriate cable end to the connection point of the item you want the cable to
connect 'From'.

324

SmartPlant Electrical User's Guide

Cable Block Diagrams


c. Drag the other cable end to the connection point of the item you want the cable to connect
'To'.

For the rules that govern the connection to circuit symbols, see Rules for Connecting
to Circuit Symbols (on page 328).
When using a reference cable to connect items in a CBD, the software automatically
creates a plant cable in the Electrical Index and makes all the required associations.
4. To disconnect a cable from an electrical item in a CBD, click the required cable end and drag
it away from the connection point.
5. When done, click

on the main toolbar before closing the drawing.

You can also place auxiliary graphics, such as redlining, annotations, and water marks. For
information on how the software behaves when placing these and other items in a cable block
diagram, see Working with Smart Data and Auxiliary Graphics in a CBD (on page 320).
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.
You can also associate cables with a specific circuit either in the Cable Common Properties
or the Electrical Engineer.
Clicking Refresh also saves the drawing. If you do not use Refresh or you make changes to
your drawing after refreshing, the software prompts you to save the drawing on closing.
You can move and reposition any item or cable by selecting and dragging the item to its new
position.
If you delete any of the items that have been placed on a drawing, this item will no longer
appear on the drawings.

Use Reference Items in a Cable Block Diagram


You can drag a reference item from the Reference Data Explorer to a CBD. This way, you can
place this item in the CBD and create a new plant item based on that reference item. The new
plant item will also automatically appear in the Electrical Index.
You can drag the following reference items to an open cable block diagram:
All electrical equipment items apart from buses and relay functions.

You can drag disconnect electrical equipment items if they are stand-alone items, that is,
if they do not belong to any circuits.
Metering equipment items can be dragged only if they are current transformers or
potential transformers.
All wiring equipment items (panels, cables, and busways) apart from glands and cableway
components.

SmartPlant Electrical User's Guide

325

Cable Block Diagrams

Use a Reference Circuit in a Cable Block Diagram


You can add a circuit to a cable block diagram by dragging a typical circuit from the Reference
Data Explorer. This action places a circuit symbol on the CBD and automatically creates a plant
circuit in the Electrical Index in the location that you specify.
1. Select an appropriate typical circuit in the Reference Data Explorer.
2. Drag this circuit to an open CBD.
3. On the Circuit dialog box, specify the power distribution board, bus, and cell where you want
the new circuit to be created.

For a free-standing bus, you do not need to specify a power distribution board.
You can select the Create cell check box if you want to create the new circuit in a cell that
doesn't exist yet.
4. Click OK.
If your preferences are set to open the Item Tag dialog box after creating a new item, the
software opens this dialog box after you define the location of the new circuit and after placing the
symbol on the drawing. On the Item Tag, you can change the name of the new circuit as you
need.

Mark Auxiliary Graphics on a Cable Block Diagram


Auxiliary graphics are images that you draw on a cable block diagram. These images do not carry
any data that is stored in the database. For example, you can draw circles, lines, rectangles, and
so forth that will be saved on the CBD. This procedure shows you how to distinguish the
representation of smart graphics (for example, symbols of motors, cables, circuits, and so on)
from auxiliary graphics.
1. In Options Manager, click Options > Item Type Symbology > Define.
2. In the Define Item Type Symbology window, select Auxiliary Graphics from the Item type
list.
3. From the Document type list, select Cable Block Diagram.
4. Make your definitions as you require. For details, see Define an Item Type Symbol in Options
Manager Help.
5. In SmartPlant Electrical, open a cable block diagram and click
toolbar to mark the auxiliary graphics.

326

on the Edit drawing

If you insert text with an auxiliary graphic, the software displays this text in the same color that
you defined for the auxiliary graphic.
When you re-open a saved CBD, the software does not mark the auxiliary graphics
automatically. Click
to display the markings. To cancel the marking of auxiliary graphics,
click
again.

SmartPlant Electrical User's Guide

Cable Block Diagrams

Remove Items from a Cable Block Diagram


This procedure shows you how to remove an electrical item from an open drawing.
1. On the drawing, select the item that you want to remove.
2. Do one of the following:

On the Edit Drawing toolbar, click


Click Edit > Remove.
Press the DELETEe key.

Use Custom Symbols in Cable Block Diagrams


You can use a custom symbol to present a particular item in a cable block diagram (plant or typical
CBD). The software will use this custom symbol instead of a symbol taken from the shipped
reference data and specified by you on the Symbology page in Options Manager.
Create your custom symbol using Catalog Manager or any other appropriate tool.
Then, place the image file in the default folder or its sub-folders where you store your reference
data symbols. You set the default symbol folder in the SmartPlant Electrical Options Manager. For
more details, see Defining File Locations in the SmartPlant Electrical Option Manager Users
Guide.
1. In the Electrical Index, Electrical Engineer or Reference Data Explorer, select an item that
you want to associate with a custom symbol.
2. Do one of the following:
Click Actions > Associate Custom Symbols.

Click
.
Right-click the selected item and then click Associate Custom Symbols on the shortcut
menu.
3. On the Associate Custom Symbols dialog box, under Document Type click on a cell, and
from the list select Cable Block Diagrams.
4. Under Symbol, click
.
5. Browse to the symbol (.sym) file you want to add, and select the file.
You can only choose the symbols that are stored in the default folder and its
sub-folders.
6. Click OK.

If, during the CBD creation, the software cannot find a referenced symbol for a specific
electrical item, the software uses the default symbol file (default.sym) to represent the
item. You specify default files in Options Manager.
For guidelines about the creation of custom symbols in Catalog Manager, see Guidelines for
Creating SLD Symbols in Catalog Manager (on page 310).

SmartPlant Electrical User's Guide

327

Cable Block Diagrams

Rules for Connecting to Circuit Symbols


When connecting a power cable to a circuit symbol, the software shows the available connect
points. Make sure that you connect to the circuit symbol power connect points according to the
following rules:
Connecting to an incomer circuit connect the cable on its Side 2 (the To side) to Side 1 of
the incomer.
Connecting to a feeder or coupler circuit connect the cable on its Side 1 (the From side) to
Side 2 of the feeder or coupler.
Connecting to a bus riser connect the cable on its Side 2 (the To side) to Side 1 of the bus
riser. Note that the cable must be connected to a coupler on its From side prior to connecting
the bus riser.
Connecting to a panel circuit you can connect to either side of the panel circuit. If you
connect to Side 1 of the panel circuit, connect the cable on its Side 2 (the To side). If you
connect to Side 2 of the panel circuit, connect the cable on its Side 1 (the From side).
When connecting a control, instrumentation, or grounding cable to a circuit symbol, it is only
possible to connect to non-power connect points of the circuit symbol. In this case, the software
shows both connection sides of the circuit symbol and you can connect to either side of the circuit
as you require.
Note that the same rules also apply when making connections in the Electrical Engineer or the
Cable Common Properties dialog box.

Resolve Symbol Inconsistencies


This procedure explains how to resolve symbol inconsistencies in plant and typical cable block
diagrams. Symbol inconsistencies can occur if, for some reason. a symbol file has been replaced
or updated. Once you save a CBD, the software retains the symbols in the drawing as they appear
at the time of saving. If, at a later stage, some of the symbol files have been updated, the CBD that
you open will not display the updated symbols until you resolve the inconsistencies. When
updating the symbols, the software validates that the updated symbols are suitable replacements
for the old symbols. For example, the new symbols must have suitable connect points so that
connections can be made. If the new symbols are not suitable, they will not replace the old ones in
the drawing and the software will display an appropriate message to that effect.
1. Open a cable block diagram and do one of the following:
On the menu bar, click Actions > Resolve Symbol Inconsistencies.
On the Actions ribbon click
.
2. On the Resolve Symbol Inconsistencies dialog box, select the check boxes next to the
appropriate item tags.
3. Click Resolve.

328

If the software does not resolve all of the symbols, a message appears that instructs you to
open the log file where you can see which symbols have not been replaced.
The Resolve command button on the Resolve Symbol Inconsistencies dialog box is
available only after selecting at least one item tag to be resolved.
If a symbol cannot be resolved, the software indicates it under Expected Result. You can
click the Symbol cannot be resolved text to see the reason why the symbol cannot be
resolved.

SmartPlant Electrical User's Guide

Cable Block Diagrams

Hide Cable Types


This procedure shows you how to hide (filter) the four categories of cables when working on a
drawing. Cable block diagrams can become very crowded, so by applying a filter you can hide
those cables that you are not working with at that moment, allowing you to concentrate on the job
at hand. You can use the filter to show only one category of cable in the working and generated
drawing, for example power cables, or to show a combination of cables, such as control and
instrumentation cables. The filter can be changed on the fly to reveal other cable category or to
hide a particular cable category.
1. In the Cable Block Diagrams folder, select the drawing you want to filter.
2. Do one of the following:
Click Edit > Document Properties.
Click Document Properties
.
Right-click the document, and on the shortcut menu, click Document Properties.
3. Under Show cables in drawing clear the check boxes beside those cables that you do not
want to see.

You can change the filter at any time by going to the Document Properties dialog box and
selecting or clearing the relevant check boxes.
You can instruct the software to display the filter settings notation in your cable block
diagrams. For details, see Display Filter Settings Notation in a CBD (see "Display a Filter
Settings Notation in a CBD" on page 330).

Define a Focal Item for a Cable Block Diagram


You can define a focal item for a cable block diagram. A focal item is a plant item for which you
generate a cable block diagram. Once you define a focal item, the software associates it with a
specific cable block diagram.
1. In Electrical Engineer, expand the Documents folder and select an appropriate cable block
diagram.
2. Right-click the selected CBD and then click Document Properties.
3. On the Document Properties dialog box, click Find next to the Focal item box.
4. On the Find dialog box, select an appropriate item and click OK.

If you want the software to display the name of the focal item in the title block of the associated
CBD, add a new macro to your document template, for example
&Document.Equipment.ItemTag.
To dissociate a focal item from the current CBD, click Clear next to the Focal item box.

SmartPlant Electrical User's Guide

329

Cable Block Diagrams

Display a Filter Settings Notation in a CBD


This procedure explains how to display a notation in your cable block diagrams that will specify the
filter settings used in the open CBD. You add a special macro to a document template and the
software will display the notation on all the CBDs that use this template. For example:

1. In Catalog Manager or SmartSketch, open the appropriate title block symbol that is used in
your cable block diagram template.
The software supplies a number of shipped templates with title blocks (.sym files) in the
reference data.
2. In the open title block symbol, add the following macro text:
Document.Filters
You can insert the macro anywhere in the template depending on where you want the
notation to appear in your CBDs.
3. Save the modified template and close Catalog Manager.
4. In SmartPlant Electrical, click File > Open > Template and open the template that you
modified in Catalog Manager.
5.
6.
7.
8.

330

If the template contains a title block, select it and then delete it.
Click Edit > Insert > Symbol.
Select the .sym file to which you added the Document.Filters macro.
Click an appropriate X point in the template to insert the title block symbol.
Save and close the template.
All the cable block diagrams based on the modified template will display the filter settings
notation.
If you open a CBD that is not filtered, the software will not display the notation.
For details on how to set a filter for a CBD, see Hide Cable Types (on page 329).

SmartPlant Electrical User's Guide

SECTION 20

Wiring in SmartPlant Electrical


SmartPlant Electrical enables you to perform wiring and create wiring drawings. The software
provides for the creation of basic wiring and enables you to make the terminations that you
require. You can do the following:
Create terminal strips for all types of applicable equipment.
Create terminals on terminal strips.
Manage both cable sides.
Manage both conductor sides.
Create wiring drawings and make connections.
Generate termination reports.
SmartPlant Electrical deals with equipment interconnections that are external to PDBs or main
equipment item types. The software handles the internal circuit wiring in typical
schematics. Cable terminations can reach and include equipment terminal strips.
After creating your wiring items and making the required terminations, you can generate cable
wiring schedule and terminal strip connection reports. For details, see Shipped Reports (on page
382).

Create a Terminal Strip in the Electrical Index


This procedure explains how to create a single terminal strip in the Electrical Index.
1. In the Electrical Index, expand the hierarchy of the Electrical Equipment folder and then an
individual equipment item to display the Terminal Strips folder.
2. Right-click the Terminal Strips folder and then click New Terminal Strip.
3. If the Terminal Strip Properties dialog box does not open automatically, right-click the new
terminal strip and then on the shortcut menu, click Common Properties.

4.
5.
6.

7.

SmartPlant Electrical opens the Common Properties dialog box automatically after
creating a new item if you selected the Common Properties dialog box option on the
General tab of the Preferences dialog box.
On the Terminal Strip Properties dialog box, under Item tag, type a new name as you
require.
Type a short description if you require.
In the Terminal strip configuration group box, do one of the following:
Click Find to find an existing reference configuration that you can apply to the current
terminal strip. For details, see Apply a Reference Terminal Strip Configuration to a
Terminal Strip (on page 333).
Define a new terminal strip configuration. For details, see Define a Terminal Strip
Configuration for a Single Terminal Strip (on page 333).
Click OK.

SmartPlant Electrical User's Guide

331

Wiring in SmartPlant Electrical

Create a Terminal in the Electrical Index


This procedure explains how to add a terminal to a terminal strip in the Electrical Index.
1. In the Electrical Index, expand the hierarchy of the Electrical Equipment folder and then an
individual equipment item and its terminal strips.
2. Right-click a terminal strip and then click New Terminal.
3. If the Terminal Properties dialog box does not open automatically, right-click the new
terminal and then on the shortcut menu, click Common Properties.

4.
5.
6.
7.
8.
9.
10.
11.

SmartPlant Electrical opens the Common Properties dialog box automatically after
creating a new item if you selected the Common Properties dialog box option on the
General tab of the Preferences dialog box.
On the General tab of the Terminal Common Properties dialog box, under Item tag, type a
name for the new terminal as you require.
Type a short description if you require.
Select a terminal type that you require. You can define and customize types in Data
Dictionary Manager.
Select a terminal color that you require. You can define and customize terminal colors in
Data Dictionary Manager.
Under Sequence, type a value that sets the sequential number of the current terminal on its
terminal strip.
Click the Procurement tab.
Select a manufacturer and a model as you require. You can define and customize these
entries in Data Dictionary Manager.
Type a store part number if you require.

Define a Reference Terminal Strip Configuration


This procedure explains how to define a reference terminal strip configuration that you can apply
to a terminal strip. You can create as many reference configurations as you require and store
them in the Reference Data Explorer.
1. In the Reference Data Explorer, right-click the Terminal Strip Configurations folder.
2. On the shortcut menu, click New Terminal Strip Configuration.
3. On the Terminal Strip Configuration dialog box, type the configuration name and
description as you require.
4. In the Configuration properties group box, enter the total number of terminals.
5. Under First terminal, enter an appropriate value.
6. In the Terminal strip pattern data grid, click and type in the Prefix field, click and type a value
if you want to prefix the names of the terminals.
7. Select the Numbered check box if you want the number of the terminal to appear between the
prefix and the suffix.
8. Select the Incremented check box if you want the terminal number to be incremented within
the pattern.
9. In the Suffix field, click and type a value if you want a suffix for the names of the terminals.

332

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical


10. Click Add if you want to add another data row in the terminal strip pattern.
The maximum number of rows that you can add cannot exceed the total number of
terminals that you enter.
11. Click OK.

Apply a Reference Terminal Strip Configuration to a


Terminal Strip
This procedure explains how to apply a reference terminal strip configuration to a terminal
strip. Applying a reference configuration to a terminal strip saves time when creating terminal
strips.
1. In the Electrical Index or Reference Data Explorer, expand the hierarchy of the Electrical
Equipment folder as necessary to display the Terminal Strips folder.
2. Expand the Terminal Strips folder and then right-click a terminal strip that you require.
3. On the shortcut menu click Common Properties.
4. On the Terminal Strip Properties dialog box, click Configuration.
5. On the Terminal Strip Configuration dialog box, click Find.
6. On the Find dialog box, click Find Now.
7. In the Results data window, select an appropriate terminal strip configuration and click OK.
8. On the Terminal Strip Configuration dialog box, click OK.

The software does not allow you to apply a reference terminal strip configuration to a terminal
strip that has already been wired.
If you apply a reference terminal strip configuration to a terminal strip that already has a
terminal strip configuration, the replaces the existing configuration with the reference
configuration that you are applying.

Define a Terminal Strip Configuration for a Single


Terminal Strip
This procedure explains how to define a terminal strip configuration for a terminal strip you are
currently editing. Note that the software does not retain the configuration that you define. The
software uses this configuration to create the terminals on the current terminal strip but does not
store the configuration in the database.
1. On the Terminal Strip Properties dialog box, under Terminal strip configuration, enter the
total number of terminals.
2. Under First terminal, enter an appropriate value.
3. In the Terminal strip pattern data grid, click and type in the Prefix field, click and type a value
if you want to prefix the names of the terminals.
4. Select the Numbered check box if you want the number of the terminal to appear between the
prefix and the suffix.
5. Select the Incremented check box if you want the terminal number to be incremented within
the pattern.
6. In the Suffix field, click and type a value if you want a suffix for the names of the terminals.

SmartPlant Electrical User's Guide

333

Wiring in SmartPlant Electrical


7. Click Add if you want to add another data row in the terminal strip pattern.
The maximum number of rows that you can add cannot exceed the total number of
terminals that you enter.
8. Click OK.

Wiring Project Items


SmartPlant Electrical enables you to effect wiring termination of project items. You can create
wiring diagrams where you make the terminations that you require. Also, you can generate
various wiring reports that show the wiring of the project items.
Note that you can only wire and terminate those cables that have already been associated with the
electrical items that you want to wire. Therefore, before terminating the cable wires, make sure
that you associate the required cables with appropriate project items.
The software provides you with several ways to wire your project items. You can choose one of
the following termination methods:
Continuous connection Allows you to perform wiring in a sequential order starting with a
terminal that you select.
Custom connection Allows you to select a reference custom connection type for the
terminals that you want to wire.
Batch cable connection Allows you to select a number of cables that have the same wiring
pattern. You can connect these cables in batch mode to project items that have the same
connectivity.

334

When you change the association of a terminated power cable by dragging it to another
equipment item in the Electrical Engineer, the software disconnects this cable from the
terminal strip of that equipment. Changing the association of a terminated non-power cable
on the Cable Common Properties dialog box also results in disconnection. The software
disconnects the cable without displaying a warning message.
The software allows you to wire non-power cables to all the circuits that belong to a PDB that
has already been associated with a non-power cable in a CBD or the Cable Common
Properties dialog box. In a wiring diagram, after placing the circuits of a PDB that has already
been associated with a non-power cable, the software identifies the connection points of these
circuits and enables you to wire the associated non-power cable or its constituents.
When designing electrical terminations of space heaters, to terminate the auxiliary contact
with a space heater or any other electrical equipment item, terminate the cable conductors to
the terminal strip of the circuit where the auxiliary contact is located.
In a wiring diagram, the software allows you to split the wires of a non-power cable and
terminate them to any terminal strip of any of the circuits of a PDB or of local panel or junction
box.
You can lengthen the connectors that represent conductors and cable sets in a wiring
diagram. To control the position of a conductor or cable set on a drawing, click the connector
that represents the conductor or cable set and then drag the connection point to the required
position on the drawing.

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical

Define a Connection Type


This option allows you to select, create, or edit a connection type in the Reference Data
Explorer. A connection type facilitates rapid cable set connections. You define a connection
type that contains a connection pattern. A connection type contains the definition of the pattern
by which wires will be connected on a terminal strip, and allows automatic connection of
successive cable sets. Once a wiring pattern has been defined, you can select it when you wire
project items using the custom connection method. The connection type that you select during
the connection procedure will determine how the connections are made.
1. In the Reference Data Explorer, right-click the Connection Types folder.
2. On the shortcut menu, click New Connection Type.
3. On the Connection Type dialog box, type a connection type name and description.
4. For instrumentation cables, in the Skip between sets field, enter the number of terminals that
you want to skip between the first conductor of the previously connected set and the first
conductor of the next set. The skipped terminals will be left unconnected.
5. In the Conductors group box, do the following:
6. Click in the Skip text field and type the number of terminals to skip before connecting this
conductor in the cable set. The skip refers to the number of terminals that will be left
unconnected between consecutive cable sets. Enter the number of terminals to be skipped
according to your needs. In most cases, this value is incremented for successive
conductors. You can accept the displayed value if suitable.
7. In the Land Side field, select the A Active or O Opposite check box to select the terminal
side to which you want to connect each conductor. The side that is currently active depends
on the side that you start connecting.
In the environment of a wiring drawing, the A side is the active side of the terminal that
you want to connect. It can be its left or right side, depending on which terminal side you
clicked after you moved the cursor over the connection points. The O side is the opposite
side of the active side.
8. Click Add to add another row to the Conductors data window.

The Conductor field signifies a specific conductor in a cable set. The displayed Wire00x
values represent the conductor names and are used to illustrate the current connection
type configuration. This field is not editable.
The number of rows that you add has to match the number of conductors that will be
connected. The software does not connect the leftover conductors that do not have
connection type definitions in the Conductors data window.
9. Click OK.

SmartPlant Electrical User's Guide

335

Wiring in SmartPlant Electrical

Wire Project Items Using the Custom Connection Method


This procedure explains how to make connections in a wiring drawing using the custom
connection method. The custom connection method allows you to make your connections based
on an existing reference connection type of a selected cable. You start by selecting a terminal to
be wired first and the software then connects the rest of the terminals according to the connection
type.
1. In the Electrical Index, expand the Documents folder.
2. Right-click the Wiring Drawings folder and then on the shortcut menu, click New Wiring
Drawing.
3. Drag the project items that you want to wire from any open window to the new wiring drawing.

You can drag any appropriate item such as a motor, circuit, panel, and so forth.
You can drag your items from the Electrical Index, Electrical Engineer, or Related
Items window.
4. Do one of the following:
Click Activate Connection Mode
.
Click Edit > Activate Connection Mode.
5. In the Electrical Index, Electrical Engineer, or Related Items window, select an appropriate
cable that you want to terminate.
You can connect only those cables that are associated with equipment on one or both
cable sides.
6. In the wiring drawing, move the cursor over the terminal strip that you want to connect to the
cable.
The software displays the available, valid connection points of the terminal strip on your
drawing. For more details, see Place Point Ribbon (SPEL) in the Catalog Manager User's
Guide, under Working with Symbols > Place Point Command.
7. Click the connection point of the terminal to which you want to connect the first conductor on
the appropriate side.

You can connect the first conductor to any terminal on the current terminal strip. The
software will then connect the remaining conductors according to the custom connection
type that you select. (See the following steps in this procedure.)
The number of conductors that you can connect cannot exceed the number of available
wiring connection points on a terminal.
You can connect only one conductor on a wiring connection point.
8. On the shortcut menu, click Custom Connection.
9. On the Cable Connection Type Selection dialog box, select a connection type you require.
10. Click Connect.

336

The software provides a set of default symbols for terminal strips, terminals, first terminals,
cables, cable sets, and conductors. You can customize your own wiring symbols in Catalog
Manager. For details, see Creating Symbols in the Catalog Manager User's Guide, under
Working with Symbols, Creating Symbols.

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical

You can perform various actions in a wiring drawing, such as moving items by dragging them
to position the items in the drawing, removing items from the drawing, disconnecting cables,
and so forth.
Removing a wiring item from a drawing does not delete that item from your project.
Disconnecting two wiring items in a drawing, disconnects the items in your project, removes
the connecting cable from the drawing, and retains the association between the cable and the
items in your project. For details, see Disconnect Cables from Items in Cable Block
Diagrams.
Clicking Refresh saves the drawing. If you do not click Refresh or you make changes to your
drawing after refreshing, the software prompts you to save the drawing on closing.
To exit the Connection Mode select another command or press the ESCAPE key.
You can add other wiring items to the drawing by dragging them to drawing from the Electrical
Index or Related Items window.
After adding a wiring item that is connected to a cable, the drawing displays the item
connected to the cable on one of the cables sides and the name of the item tag of the wiring
item that is connected on the other cable side. After dragging that wiring item to the drawing,
software replaces the item tag name with the symbol of that wiring item.
The software allows you to add annotations and use redlining in your wiring drawings. For
details, see Managing Annotations and Redlining (see "Annotations and Redlining" on page
349).
If you move a macro to another place in the drawing, clicking a macro highlights the cable,
cable set, or conductor that is associated with that macro. This way you can see which cable,
cable set, or conductor belongs to that macro.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

Wire Project Items Using the Continuous Connection Method


This procedure explains how to make connections in a wiring drawing using the continuous
connection method. The continuous connection method allows you to make a connection in a
sequential way by selecting a terminal that will be wired first. The software then automatically
wires the rest of the terminals in a sequential order.
1. In the Electrical Index, expand the Documents folder.
2. Right-click the Wiring Drawings folder and then on the shortcut menu, click New Wiring
Drawing.
3. Drag the project items that you want to wire from any open window to the new wiring drawing.

You can drag any appropriate item such as a motor, circuit, panel, and so forth.
You can drag your items from the Electrical Index, Electrical Engineer, or Related
Items window.

SmartPlant Electrical User's Guide

337

Wiring in SmartPlant Electrical


4. Do one of the following:
Click Activate Connection Mode
.
Click Edit > Activate Connection Mode.
5. In the Electrical Index, Electrical Engineer, or Related Items window, select an appropriate
cable that you want to terminate.
You can connect only those cables that are associated with equipment on one or both
cable sides.
6. In the wiring drawing, move the cursor over the terminal strip that you want to connect to the
cable.
The software displays the available, valid connection points of the terminal strip on your
drawing. For more details, see Place Point Ribbon (SPEL) in the Catalog Manager User's
Guide, under Working with Symbols > Place Point Command.
7. Click the connection point of the terminal to which you want to connect the first conductor on
the appropriate side.

You can connect the first conductor to any terminal on the current terminal strip. The
software will then automatically connect the remaining conductors in a sequential order.
The number of conductors that you can connect cannot exceed the number of available
wiring connection points on a terminal.
You can connect only one conductor on a wiring connection point.
8. On the shortcut menu, click Continuous Connection.
9. In the wiring drawing, move the cursor over the connection points of the second terminal strip.
10. On the shortcut menu, click Continuous Connection.

338

The software provides a set of default symbols for terminal strips, terminals, first terminals,
cables, cable sets, and conductors. You can customize your own wiring symbols in Catalog
Manager. For details, see Working with Symbols > Creating Symbols in the Catalog Manager
User's Guide.
You can perform various actions in a wiring drawing, such as moving items by dragging them
to position the items in the drawing, removing items from the drawing, disconnecting cables,
and so forth.
Removing a wiring item from a drawing does not delete that item from your project.
Disconnecting two wiring items in a drawing, disconnects the items in your project, removes
the connecting cable from the drawing, and retains the association between the cable and the
items in your project. For details, see Disconnect Cables from Items in Cable Block
Diagrams.
Clicking Refresh saves the drawing. If you do not click Refresh or you make changes to your
drawing after refreshing, the software prompts you to save the drawing on closing.
To exit the Connection Mode select another command or press the ESCAPE key.
You can add other wiring items to the drawing by dragging them to drawing from the Electrical
Index or Related Items window.
After adding a wiring item that is connected to a cable, the drawing displays the item
connected to the cable on one of the cables sides and the name of the item tag of the wiring
item that is connected on the other cable side. After dragging that wiring item to the drawing,
software replaces the item tag name with the symbol of that wiring item.

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical

The software allows you to add annotations and use redlining in your wiring drawings. For
details, see Managing Annotations and Redlining (see "Annotations and Redlining" on page
349).
If you move a macro to another place in the drawing, clicking a macro highlights the cable,
cable set, or conductor that is associated with that macro. This way you can see which cable,
cable set, or conductor belongs to that macro.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

Connect Project Cables in Batch Mode


This feature enables you to connect in batch mode numerous project cables that belong to the
same category, for example, power, control, instrumentation, and so forth. For example, you can
you can terminate all the project control cables that are associated with 10hp motors and their
circuits. The software allows you to select a connection method (continuous or custom) for the
batch operation.
1. In the Electrical Index, click the Cables folder.
2. In the Item Tag pane, select the cables you want to terminate in batch mode.

3.
4.
5.

6.
7.
8.

You can only connect cables in batch mode if they belong to the same category, for
example, power, control, instrumentation, and so forth.
Click Actions > Cables > Batch Cable Connection.
On the Batch Cable Connection dialog box, select the Activate cable side 1 (From) check
box, Activate cable side 2 (To) check box, or both check boxes.
Under Terminal strip sequence, type the sequence of the appropriate terminal strip that is
associated with the equipment you want to connect. The value you type defines the terminal
strip to be connected. Type a value for one or both cable sides as you require.
Under First terminal, type a value to instruct the software which terminal on the current
terminal strip is to be connected first.
Select an appropriate active connection side for one or both cable ends.
From the Connection type list for one or both cable sides, select an appropriate connection
type.

From the Connection type list, you can select Continuous (wire the first selected
terminal of an item and then automatically wire the rest of the terminals) or a name of an
existing custom connection type. If the connection type that you require is not on the list,
create it in the Reference Data Explorer. For details, see Define a Connection Type (on
page 335).
9. In the Cable connection details data window, select the Select check box next to the
appropriate cables that you want to connect.
10. Click OK.
When designing electrical terminations of space heaters, to terminate the auxiliary contact
with a space heater or any other electrical equipment item, terminate the cable conductors to the
terminal strip of the circuit where the auxiliary contact is located.

SmartPlant Electrical User's Guide

339

Wiring in SmartPlant Electrical

Connect a Cable Set


This procedure shows you how to connect a single cable set.
1. Open a wiring diagram and do one of the following:
Click Activate Connection Mode
.
Click Edit > Activate Connection Mode.
2. In Electrical Index, Electrical Engineer, or Related Items window, expand the hierarchy of
a cable to display its sets.
3. Select a cable set.
4. In the wiring drawing, move the cursor over the terminal strip that you want to connect to the
cable set.
The software displays the available, valid connection points of the terminal strip on your
drawing. For more details, see Place Point Ribbon (SPEL) in the Catalog Manager User's
Guide, under Working with Symbols > Place Point Command.
5. Click the connection point of the terminal to which you want to connect the cable set.
6. On the shortcut menu, click Custom Connection.
If you select the Continuous Connection Method, the software connects the cable set
starting with the terminal you clicked and completes the connection of the other terminals in a
sequential order.
7. On the Cable Connection Type Selection dialog box, select a connection type you require.
8. Click Connect.

Connect a Single Conductor


This procedure shows you how to connect a single conductor.
1. Open a wiring diagram and do one of the following:
Click Activate Connection Mode
.
Click Edit > Activate Connection Mode.
2. In Electrical Index, Electrical Engineer, or Related Items window, expand the hierarchy of
a cable to display its conductors.
3. Select a conductor.
4. In the wiring drawing, move the cursor over the terminal strip that you want to connect to the
conductor.
The software displays the available, valid connection points of the terminal strip on your
drawing. For more details, see Place Point Ribbon (SmartPlant Electrical) in the Catalog
Manager User's Guide, under Working with Symbols > Place Point Command.
5. Click the connection point of the terminal to which you want to connect the conductor.
In a wiring drawing, the software does not show the item tag label for conductors whose
polarity property is defined as shield.

340

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical

Connect a Jumper
This procedure shows you how to connect a jumper on a terminal strip.
1. In a wiring diagram that has a terminal strip, do one of the following:
Click Activate Jumper Mode
.
Click Edit > Activate Jumper Mode.
2. Select the first jumper connection point that you want to connect.
The software displays the available, valid jumper connection points on the terminal
strip. For more details, see Place Point Ribbon (SmartPlant Electrical) in the Catalog
Manager User's Guide, under Working with Symbols > Place Point Command.
3. Move the cursor to the next jumper connection point on the same terminal strip and click it.

The terminal symbols must be defined with jumper connection points.


You can only connect jumpers on terminals that belong to the same terminal strip.
The software represents the jumpers using the default conductor symbol without displaying
the item tag macro. To customize a jumper symbol, see Customize a Jumper Symbol (on
page 342).

Disconnect a Cable, Cable Set, or Conductor in a Wiring


Drawing
This procedure shows you how to disconnect cables, cable sets, or conductors in a wiring
drawing. When disconnecting a cable, the software disconnects it on both sides and removes it
from the drawing. However, the cable still remains associated with the wiring items even if it has
been disconnected. When disconnecting a cable set or a conductor, the software also removes
the disconnected set or conductor from the drawing.
1. In a wiring drawing, select a cable, cable set, or conductor that you want to disconnect.
2. Do one of the following:

Click
.
Click Edit > Disconnect.
Right-click, and on the shortcut menu, click Disconnect Items.

After you confirm the disconnection of a cable, the software disconnects the cable on both
sides and removes it from the drawing. However, the software does not delete the cable from
the project and retains the association between the wiring items and the cable.
When disconnecting cable sets or conductors, the software removes these items from the
drawing.

SmartPlant Electrical User's Guide

341

Wiring in SmartPlant Electrical

Remove Items from a Wiring Drawing


This procedure shows you how to remove an electrical item from an open drawing.
1. On the drawing, select the item that you want to remove.
2. Do one of the following:

On the Edit Drawing toolbar, click


Click Edit > Remove.
Press the DELETEe key.

Customize a Jumper Symbol


1. Clone a conductor symbol in Catalog Manager and rename it to jumper.
2. Define the customized jumper symbol on the Symbology page in Options Manager.
3. In Options Manager, define a conductor symbol for a wiring diagram using the following filter:
electrical equipment type = jumper

Open an Existing Wiring Drawing


1. In the Electrical Index, click Documents > Wiring Drawings.
2. Select a wiring drawing and do one of the following:
Click File > Open > Drawing.

342

Click
.
Right-click and on the shortcut menu, click Open.

SmartPlant Electrical User's Guide

Wiring in SmartPlant Electrical

When opening a wiring drawing that contained a wiring item that has been deleted from your
project, the wiring drawing no longer displays this item, showing the cable and wiring item
connected to the other cable end.
If you deleted both wiring items that were connected to a cable, the wiring drawing displays the
cable only.
If you deleted a cable that was used to connect two wiring items, the wiring diagram shows the
two items as disconnected.
Removing a wiring item from a drawing does not delete that item from your project.
Disconnecting two wiring items in a drawing, disconnects the items in your project, removes
the connecting cable from the drawing, and retains the association between the cable and the
items in your project.
You can add other wiring items to the drawing by dragging them to drawing from the Electrical
Index or Related Items window.
After adding a wiring item that is connected to a cable, the drawing displays the item
connected to the cable on one of the cables sides and the name of the item tag of the wiring
item that is connected on the other cable side. After dragging that wiring item to the drawing,
software replaces the item tag name with the symbol of that wiring item.
The software allows you to add annotations and use redlining in your wiring drawings. For
details, see Managing Annotations and Redlining (see "Annotations and Redlining" on page
349).
If you move a macro to another place in the drawing, clicking a macro highlights the cable,
cable set, or conductor that is associated with that macro. This way you can see which cable,
cable set, or conductor belongs to that macro.
In a wiring drawing, the software does not show the item tag label for conductors whose
polarity property is defined as shield.
Sometimes, after the software opens a drawing, the distance between connected items is
either too long or too short, which results in an inappropriate display of connectors. To control
the visual consistency of connectors, you can set a Clearance value that specifies the amount
of space that the software will maintain between the connector and the connected element
(also known as range avoidance). This action allows you to control the visual consistency of
connectors that make right-angle turns just before they attach to a symbol.
To set Clearance, select a connector and then type the minimum distance from the symbols
where you would like the first turn in the connectors to occur. Note that the default setting is
zero.

SmartPlant Electrical User's Guide

343

Working with Signals

SECTION 21

Working with Signals


Signals are items that allow you to transfer I/O data between SmartPlant Electrical and SmartPlant
Instrumentation and include properties originating in both applications. After creating the signals,
you publish the signal data to SmartPlant Instrumentation. SmartPlant Instrumentation uses
signals to create special tag numbers that are associated with SmartPlant Electrical and may be
wired to PLC and DCS panels as regular I/O signals. After the signals are wired and associated
with I/O channels in SmartPlant Instrumentation, you can retrieve the I/O information back to
SmartPlant Electrical and use it to add as item types with macros in schematics. These item
types display PLC or other host I/O data such as DCS data in the schematics.
You can create signals for all load items, converting equipment, disconnect electrical equipment,
control stations, and power distribution board circuits.
Also, it is possible to associate and dissociate single signals or multiple signals in batch mode.
Electrical signals include properties that you can edit in SmartPlant Electrical such as Item Tag,
Tag Prefix, Tag Suffix, Description, Design By, Sequence in Group, and System I/O Type.
Other properties belong to SmartPlant Instrumentation and are read-only, for example, Host
Channel Address, Reference Loop Number.
You can add or delete signals provided you have access rights for electrical equipment,
regardless of the item type to which you add the signal.

Create a Signal
This procedure explains how to create a signal in SmartPlant Electrical. After creating the
signals, you publish the signal data to SmartPlant Instrumentation.
1. In the Electrical Index, expand the folder hierarchy by clicking the + icons or by doubleclicking the folders.
2. Do one of the following:
Navigate to one of the Loads folders and select an item.
Navigate to one of the Converting Equipment folders and select an item.
Expand the hierarchy Power Distribution Equipment > Disconnect Electrical
Equipment, then navigate to one of the folders and select an item.
Expand the hierarchy Power Distribution Equipment > Power Distribution Boards
and select a circuit.
Expand the hierarchy Wiring Equipment > Panels > Control Stations and select a
control station.
3. Right-click the selected item, and then click New Signal.
4. Edit the signal properties in the Properties window as required.
Some of the properties that you can edit include Item Tag, Tag Prefix, Tag Suffix,
Description, Sequence in Group, and System I/O Type; there are other properties that belong
to SmartPlant Instrumentation and are read- only.
You can also create signals for an item by dragging a typical I/O set in the Reference Data
Explorer onto the item in the Electrical Index.

344

SmartPlant Electrical User's Guide

Working with Signals

Associate I/O Signals


This procedure explains how to associate numerous I/O signals that are available in the Signals
folder of the Electrical Index. You can associate single signals or multiple signals in batch
mode.
1. In the Electrical Index, expand the hierarchy of the Signals folder by clicking the + icons or
by double-clicking the folder to display the existing signals.
2. Do one of the following:
In the tree view, right-click a signal and then on the shortcut menu, click Associate.
In the Items pane, select the required signals, right-click them, and then on the shortcut
menu, click Associate.
3. Use the Find dialog box, to find the appropriate equipment items with which you want to
associate the signals.
If the software could not dissociate some of the signals, an appropriate message is
displayed. These signals remain under their associated equipment.

Dissociate I/O Signals


The software allows you to dissociate I/O signals that were associated with inappropriate
equipment. You can dissociate these signals without deleting them. After dissociating the
signals, they become available in the Signals folder of the Electrical Index. Note that it is
possible to dissociate single signals or multiple signals in batch mode.
1. In the Electrical Index, expand the hierarchy of an equipment folder by clicking the + icons or
by double-clicking the folder to display the existing signals.
2. Do one of the following:
In the tree view, right-click a signal and then on the shortcut menu, click Dissociate.
In the Items pane, select the required signals, right-click them, and then on the shortcut
menu, click Dissociate.
If the software could not dissociate some of the signals, an appropriate message is
displayed. These signals remain under their associated equipment.

SmartPlant Electrical User's Guide

345

SECTION 22

Customizing Symbols
Symbology provides graphical clarity to a drawing by differentiating among various items by their
appearance. Symbology refers to the color, line width, shape, and style associated with items.
You can use line widths, styles, shapes, and color to differentiate among the different types of
drawing items, such as cables, power distribution boards (PDB), equipment, bus ties and their
internals, and so forth. For example, you could define a power cable that connects to a PDB as
being a black, 2-mm thick continuous line, where as a control cable could be a blue, 1-mm thick,
broken line.
Along with the default symbols supplied with the software, you can create your own customized
symbols that can be associated with a document and item tag.
The three different types of documents, SLDs, PDBs, and Wiring, support the use of multiple
symbols for the same item by the use of filters, so that a DC motor can be displayed differently
than an AC motor in the same drawing.
In order for the software to rescale all the items correctly, make sure that when
creating symbols that contain text or smart text, the Units space property is set to World. Note
the World is not the default setting for this property.
Using symbology you can customize the style of the PDB frame, add and change the macros, and
change their position in relation to the frame.
You must create your custom symbols in the Catalog Manager before using them in SmartPlant
Electrical.
For more details, see Creating Symbols in the Catalog Manager User's Guide, under Catalog
Manager > Working with Symbols > Creating Symbols.

Associate a Custom Symbol with Item Tags


This procedure shows you how to associate plant items, reference items, or document types with
custom symbols that have already been created in Catalog Manager.
1. In the Electrical Index, Electrical Engineer, or Reference Data Explorer, select the item
tags you want to associate with a custom symbol.
2. Do one of the following:
Click Actions > Associate Custom Symbols.
Click
.
Right-click > Associate Custom Symbols.
3. On the Associate Custom Symbols dialog box, under Document Type click on a cell, and
from the list select the document type you require.
4. Under Symbol, click
.
5. Browse to the symbol (.sym) file you want to add, and select the file.

SmartPlant Electrical User's Guide

347

Customizing Symbols
6. Click OK.
You can only choose symbols that are stored in the default folder, and its sub-folders. You
set the symbols default folder in the SmartPlant Electrical Options Manager. For more details,
see Defining File Locations in the SmartPlant Electrical Option Manager Users Guide, under
Using Options Manager, Defining File Locations, Defining File Locations.

Dissociate a Custom Symbol from an Item Tag


This procedure shows you how to dissociate a custom symbol from an Item Tag and Document
Type.
1. In the Electrical Index or Reference Data Explorer, select the item tags you want to
dissociate the custom symbol from.
2. Do one of the following:
Click Actions > Associate Custom Symbols.
Click
.
Right-click > Associate Custom Symbols.
3. On the Associate Custom Symbols dialog box, click on the row you want to remove from the
item tag.
4. Click Remove.
5. Click OK.
Removing a symbol disassociates the symbol from the document type and item tag, it does
not delete it from the template.

348

SmartPlant Electrical User's Guide

SECTION 23

Annotations and Redlining


You can mark up single line diagrams, schematic drawings, cable block diagrams, and wiring
drawings using text or symbols as annotations. The software saves annotations in the same
layer as the graphical elements of the drawing.
You can lock an annotation to a selected item tag. So if you move the item tag, the software also
moves the annotation. Alternatively, you can set the annotation to be moved independently of the
item tag.
When working with annotations, you can do the following:
Insert Annotation Text (on page 349)
Insert Annotation Symbols (on page 350)
Edit Annotation Text (on page 350)
Delete Annotations (on page 351)
Redlining appears in a separate drawing layer and you can hide and display redlining as you
require. If a drawing has more than one sheet, you can create redlining and hide or display it
independently for each sheet. Therefore, while working in redlining mode, you cannot access any
items in the main drawing layer. The software saves the drawing with the redlining items. When
opening a drawing that contains redlining items, the software automatically displays the drawing in
redlining mode. You can switch back to regular mode and modify the drawing as needed. The
software saves the existing redlining items regardless of whether you open the drawing in
redlining mode or not. You can add text, symbols, lines, circles, rectangles, and watermarks as
redlining.
In schematic drawings for which the software also retrieves Enhanced SmartLoop data
from SmartPlant Instrumentation, you can add annotations and redlining to the Enhanced
SmartLoop drawing sheets.
When working in redlining mode, you can do the following:
Insert Redlining Text (on page 351)
Insert Redlining Graphical Elements (on page 352)
Edit Redlining Text (on page 352)
Delete Redlining (on page 353)

Insert Annotation Text


1. Open a drawing and do one of the following:
Click Edit > Insert > Text.
On the toolbar, click
.
2. On the Text Properties dialog box, click the General tab.
3. Type the annotation text in the Caption box.
You can type an unlimited number of lines with up to 28 characters on each line.
4. Select Set as watermark if you want to define the text as a watermark that appears in a layer
under other drawing items.

SmartPlant Electrical User's Guide

349

Annotations and Redlining


5. Under Annotation locking, select Lock to item tag to lock the position of the annotation text
to the selected item tag. In this case, when moving the item tag, the attached annotation
moves with it.
6. Select Move independently if you want to be able to move the annotation text independently
from the item tag that it is locked to. For this option, the software keeps the annotation text
locked to the item tag, but allows you to move the annotation text too.

7.
8.
9.
10.

11.

The Annotation locking and Move independently properties are only available if you
first selected an item tag before inserting text.
Click the Properties tab.
In the Horizontal and Vertical lists, select options to align text within the text box boundaries.
Select Show border if you want to display the text box border.
To rotate the annotation text box, do one of the following in the Rotation box:
Enter a positive value in degrees to rotate the macro attribute or label clockwise (CW).
Enter a negative value in degrees to rotate the macro attribute or label counter-clockwise
(CCW).
From the Orientation list, select a text box orientation if needed.

In the vertical orientation, the software rotates the letters 45 CCW.


12. Click Font to open a dialog box where you can specify the text font, font style, size, effects,
color, and script.
13. Click a blank area on the drawing sheet to position the text.
You can select several text boxes by holding the CTRL key while clicking each text box
and then dragging the selected text boxes to the desired location in the drawing.
14. Click File > Save.
In order to save an annotation that was added to a manual SLD, make sure that first you
click Generate on the Drawing Options dialog box and only then save the drawing. This way, the
software saves the SLD together with the inserted annotation.

Insert Annotation Symbols


1.
2.
3.
4.

Open an appropriate drawing.


Click Edit > Insert > Symbol and then navigate to the desired .sym file.
Click on the drawing to position the symbol.
Click File > Save.

Edit Annotation Text


1. Open an appropriate drawing.
2. Select an annotation text box.
3. Do one of the following:
Click Edit > Text.
On the toolbar, click
.
4. On the Text Properties dialog box, click the General tab.
5. Modify the annotation text in the Caption box.
When you modify an annotation, the option Set as watermark is not available. You can
set this option only when defining the text properties for the first time.

350

SmartPlant Electrical User's Guide

Annotations and Redlining


6.
7.
8.
9.

Click the Properties tab.


In the Horizontal and Vertical lists, select options to align text within the text box boundaries.
Select Show border if you want to display the text box border.
To rotate the annotation text box, do one of the following in the Rotation box:
Enter a positive value in degrees to rotate the macro attribute or label clockwise (CW).
Enter a negative value in degrees to rotate the macro attribute or label counter-clockwise
(CCW).
10. From the Orientation list, select a text box orientation if needed.
In the vertical orientation, the software rotates the letters 45 CCW.
11. Click Font to open a dialog box where you can specify the text font, font style, size, effects,
color, and script.
12. Click File > Save.

Delete Annotations
1. Open an appropriate drawing.
2. Select an annotation item on the drawing sheet.
You can select several items at a time. To do so, hold the CTRL key and click each
item. The font and border color of the annotations change when you select them.
3. Press the DELETE key.
4. Click File > Save.
When you delete an annotation, it is not pasted to the Clipboard and you cannot reinsert
it. You cannot restore a deleted annotation after you have saved the file.

Insert Redlining Text


1. Open an appropriate drawing.
2. To activate redlining mode, click Edit > Redlining.
When redlining mode is switched on, a check mark appears beside the menu command,
and also, the text 'Redlining' appears as the label for the selected drawing sheet.
3. Do one of the following:
Click Edit > Insert > Text.
On the toolbar, click
.
4. On the Text Properties dialog box, click the General tab.
5. Type the annotation text in the Caption box.
6.
7.
8.
9.

You can type an unlimited number of lines with up to 28 characters on each line.
Select Set as watermark if you want to define the text as a watermark that appears in a layer
under other drawing items.
Click the Properties tab.
In the Horizontal and Vertical lists, select options to align text within the text box boundaries.
Select Show border if you want to display the text box border.

SmartPlant Electrical User's Guide

351

Annotations and Redlining


10. To rotate the annotation text box, do one of the following in the Rotation box:
Enter a positive value in degrees to rotate the macro attribute or label clockwise (CW).
Enter a negative value in degrees to rotate the macro attribute or label counter-clockwise
(CCW).
11. From the Orientation list, select a text box orientation if needed.
In the vertical orientation, the software rotates the letters 45 CCW.
12. Click Font to open a dialog box where you can specify the text font, font style, size, effects,
color, and script.
13. Click a blank area on the drawing sheet to position the text.
14. Click File > Save to save the drawing with the added redlining text.

Insert Redlining Graphical Elements


1. Open an appropriate drawing.
2. To activate redlining mode, click Edit > Redlining.
When redlining mode is switched on, a check mark appears beside the menu command,
and also, the text 'Redlining' appears as the label for the selected drawing sheet.
3. To insert a line, do one of the following:
Click Edit > Insert > Line.
On the toolbar, click
.
4. To insert a circle, do one of the following:
Click Edit > Insert > Circle.
On the toolbar, click
.
5. To insert a rectangle, do one of the following:
Click Edit > Insert > Rectangle.
On the toolbar, click
.
6. To insert a curved line, do one of the following:
Click Edit > Insert > Curve.
On the toolbar, click
.
7. Click on the drawing to position the redlining element.
8. Click File > Save to save the drawing with the added redlining items.

Edit Redlining Text


1. Open an appropriate drawing.
2. To activate redlining mode, click Edit > Redlining.
When redlining mode is switched on, a check mark appears beside the menu command
and also, the text 'Redlining' appears as the label for the selected drawing sheet.
3. Select the desired redlining text.
4. Do one of the following:
Click Edit > Text.

352

On the toolbar, click

SmartPlant Electrical User's Guide

Annotations and Redlining


5. On the Text Properties dialog box, click the General tab.
6. Modify the annotation text in the Caption box.

7.
8.
9.
10.

11.

When you modify an annotation, the option Set as watermark is not available. You can
set this option only when defining the text properties for the first time.
Click the Properties tab.
In the Horizontal and Vertical lists, select options to align text within the text box boundaries.
Select Show border if you want to display the text box border.
To rotate the annotation text box, do one of the following in the Rotation box:
Enter a positive value in degrees to rotate the macro attribute or label clockwise (CW).
Enter a negative value in degrees to rotate the macro attribute or label counter-clockwise
(CCW).
From the Orientation list, select a text box orientation if needed.

In the vertical orientation, the software rotates the letters 45 CCW.


12. Click Font to open a dialog box where you can specify the text font, font style, size, effects,
color, and script.
13. Click File > Save.

Delete Redlining
1.
2.
3.
4.
5.

Open an appropriate drawing.


Click Edit > Redlining.
Select a redlining item in the single line diagram.
Press the DELETE key.
Click File > Save.

When you delete redlining, it is not pasted to the Clipboard and you cannot reinsert it. You
cannot restore a deleted redlining item.

SmartPlant Electrical User's Guide

353

SECTION 24

Drawing Items
With SmartPlant Electrical, you can generate schematics and single line diagrams (SLDs). After
generation, you can view or manipulate the drawings before saving them. Among the options
available to you are:
Viewing Drawings (on page 356)
Finding Drawings (see "Find a Drawing Item in the Electrical Index or Electrical Engineer" on
page 355)
Aligning Objects (see "Aligning Drawing Objects" on page 357)

Find a Drawing Item in the Electrical Index or


Electrical Engineer
This procedure shows you how to find items that appear on your SLD or CBD in the Electrical
Index or Electrical Engineer.
1. On your drawing, select the item you want to find in the Electrical Index or Electrical
Engineer.
Make sure that the Electrical Index and Electrical Engineer are open.
2. Right-click the selected item, and from the shortcut menu select Find in Electrical Index or
Find in Electrical Engineer. The software opens the folder where the item is stored and
highlights the item.
SmartPlant Electrical searches for the wanted item, first in the custom folders, and then in
the All Items folder.

View Associated Drawings of an Item


This procedure allows you to select an item from the Electrical Index and view a list of all the
drawings that the item appears on. You can filter the results by drawing type and then open a
specific drawing.
1. On the Electrical Index, select the item you want to view its associated drawings.
2. Right-click, and on the shortcut menu, click Associated Drawings.
3. On the Associated Drawings dialog box, from the Drawing Type list, select the drawing type
you want to view.
4. Select a drawing from the Associated Drawings pane, and click Open Drawing.
If the selected drawing type is a single line diagram, the software only shows the
associated drawings of the selected item when the selected item is the main item of the single line
drawing, and not a secondary item.

SmartPlant Electrical User's Guide

355

Drawing Items

Show Related Items


This procedure allows you to show those items that are related to the main items that you want to
use in your SLDs and CBDs. Using Show Related Items opens a new window that shows just
those items that are related to the main item, allowing for quick selection when adding to your
CBD.
1. On the Electrical Index or Electrical Engineer navigate to the item that you want to see its
related items.
2. Right-click on the item and from the shortcut menu, select Show Related Items in a New
Window.

A new window opens showing the open folders of the selected item and all the related items,
you can then drag and drop these items onto your CBD in the same way as from the Electrical
Index or Electrical Engineer.
To close the Related Items window, double-click on the blue title bar at the top of the window
and then click on the close icon.

Viewing Drawings
When you generate or open schematics or single line diagrams, you can zoom and pan the
diagram to view the areas of interest to you.

Zoom Area
To zoom in on a selected area, click Zoom Area on the main toolbar.
To select the area to zoom, drag over the area. You can redefine the zoom area position and
dimensions by moving the mouse pointer while continuing to hold down the mouse button.

Zoom In
To zoom in on a selected area, click Zoom In on the main toolbar.
Click over the area where you want to zoom in. The point where you click becomes the center of
the zoom-in area.

Zoom Out
To zoom in on a selected area, click Zoom Out on the main toolbar.
Click over the area where you want to zoom out. The point where you click becomes the center of
the zoom-out area. For

Fit
To fit the drawing on the visible display area, click Fit on the main toolbar.
If you change the size of the display area, you must click the command again to make the drawing
fit the modified display.

356

SmartPlant Electrical User's Guide

Drawing Items
Pan
To view different parts of the drawing in the visible display area, click Pan on the main toolbar.
You can move the drawing in the display area as required.

Restore a Drawing View


After zooming or panning a drawing, you can restore the drawing to the previous view. Repeated
selection of this option toggles between the previous and last views.

Gapping Lines
A gap in a drawing is a condition that exists when two lines intersect graphically in the drawing but
not physically in the plant. In order to portray this condition, you can choose that lines show a gap
at these non-physical intersections. This can help the clarity of your drawing considerably.
Gapping is carried out automatically when you open an existing drawing. If you want to perform
gapping on a drawing that is already open, you must use the command Tools > Gap Now.

Perform Line Gapping in Your Drawing Now

Click Tools > Gap Now.

Aligning Drawing Objects


Alignment involves lining up two or more objects vertically or horizontally, either by their edges or
their centers. Almost all diagrams and drawings require aligning certain items with each
other. You can rely on rulers, grids, and guides to help you place objects, or you can use these
features along with the alignment functions.

Aligning Items Vertically


You can align objects vertically in three different ways:
Align objects by their left sides
Align objects by their right sides
Align objects by their centers

SmartPlant Electrical User's Guide

357

Drawing Items
In the following illustration, the objects are aligned by their left sides:

The objects in the select set are moved horizontally from the place where they are selected until
they are aligned with the left edge of the leftmost object in the select set.
If two objects are horizontally near one another, one of the objects may be placed
behind another object. To avoid this, make sure that the items you select are never to the left or
right of one another when you use vertical alignment.

Aligning Items Horizontally


The Align command allows you to horizontally align objects in three different ways:
Align objects by their tops
Align objects by their bottoms
Align objects by their centers

358

SmartPlant Electrical User's Guide

Drawing Items
In the following illustration, the objects are aligned horizontally by their tops:

The objects in the select set are moved vertically from the place where they are selected until they
are aligned with the top edge of the top-most object in the select set.
If two objects are vertically near one another, one of the objects may be placed
behind another object. To avoid this, make sure that the items you select are never to the top or
bottom of one another when you use horizontal alignment.

Align Drawing Objects


1. On the drawing sheet, select two or more objects that you want to align.

To select more than one object, hold down the SHIFT or CTRL key and click each object.

You can create a select set by clicking Select Tool


on the Main toolbar and then
dragging a fence around the objects you want to include.

2. Click Align

on the Main toolbar.

SmartPlant Electrical User's Guide

359

Drawing Items
3. On the Align Ribbon (on page 828), click the button that corresponds to the alignment type
you want.

When you use horizontal alignment, make sure the selected objects are not to the top or
bottom of one another.
If two shapes are vertically near one another, one of the objects may be placed behind another
object.
When you use vertical alignment, make sure the selected objects are not to the right or left of
one another.
If two shapes are horizontally near one another, one of the objects may be placed behind
another object.
Alignment features only line up objects; they do not distribute an equal amount of space
between aligned objects.
You cannot align items that are glued to other objects, including labels and symbols.

Align Command
Allows you to align two or more objects in a select set. You can create a select set by clicking
Select Tool
on the Main toolbar and dragging a fence around the items you want to
include. To select more than one object, hold down the SHIFT or CTRL key and click each
element.
The six align options provide the flexibility of arranging objects with less dragging.
You cannot align items that are glued to other objects, including labels and symbols.

Manipulating Drawing Items


The topics in this section explain how to move, mirror, and rotate drawing items.

Move a Drawing Item


1. Select one or more items.
2. Select a drawing item and do one of the following:
On the menu bar, click Edit > Move and then move the cursor to another location in the
drawing.

360

Click Move
on the Change Toolbar (on page 829) and then move the cursor to
another location in the drawing.
Drag an item without using the Move command. Select the item and then drag it to its new
location. If you want to copy the item, press CTRL while you drag it.

If you move an item that owns other items, the owned items move also.
You can use other view manipulation commands, such as Zoom, Fit, and Pan, while you are
using the Move command. When you finish manipulating the view, the software returns you to
the Move command at the point where you were when you started manipulating the view.

SmartPlant Electrical User's Guide

Drawing Items

Mirror an Item About an Existing Mirror Axis or Linear


Element
1. Select one or more items.
2. Do one of the following:
On the Change Toolbar (on page 829), click Mirror
.
On the menu bar, click Edit > Mirror.
3. By dragging the pointer over the item, locate a mirror axis. The mirrored items are displayed
dynamically on the other side of the mirror axis.
4. Position the pointer so that the mirrored items appear where you want them, and then click.
You can use other view manipulation commands, such as Zoom and Pan, while you are
using Mirror. When you finish manipulating the item, the software returns you to Mirror at the
point where you were when you started manipulating the view.

Mirror an Item About a Mirror Axis That You Define


1. Select one or more items.
2. Do one of the following:
On the Change Toolbar (on page 829), click Mirror
.
On the menu bar, click Edit > Mirror.
3. Define one end of the mirror axis by clicking in an appropriate empty portion of the drawing or
by clicking a keypoint
. The software displays the mirror axis and the mirrored items
dynamically (that is, as you move your pointer).
4. Position the pointer so that the mirrored items appear where you want them, and then click.
If you want to copy the mirrored items, hold CTRL when you click to place your items.

Instead of positioning the mirror axis dynamically, you can use the Position Angle box on the
Mirror Ribbon (on page 362).
You can use other view manipulation commands, such as Zoom and Pan, while you are using
the Mirror command. When you finish manipulating the item, the software returns you to the
Mirror command at the point where you were when you started manipulating the item.

SmartPlant Electrical User's Guide

361

Drawing Items

Mirror Ribbon
Appears on the main toolbar when the Mirror command is active, and allows you to either specify
mirroring options or to observe mirroring options.
Copy Copies the item or items when you mirror them.
Position Angle Sets the angle of the mirror axis. The origin of the angle measurement is the
point that you clicked for the beginning of the mirror axis. Setting the position angle to zero
extends the axis horizontally to the right of the screen, 90 extends the axis vertically to the top, 180
extends the axis horizontally to the left, and 270 extends the axis vertically to the bottom.
To determine the option name on the ribbon, pause over an option and read the ToolTip.

Rotate an Item About an Axis You Define


1. Select one or more items.
2. Do one of the following:
On the Change Toolbar (on page 829), click Rotate
On the menu bar, click Edit > Rotate.
3. Click at the center of rotation.
4. Then, click to define the other end of the rotation axis.

The software dynamically displays the rotation axis and items being rotated. The location
and position of the rotation axis defines the rotation from point.
5. Rotate the items into position by dragging the rotation axis.
6. Click to define the rotation to point.

To rotate by arbitrary increments, type a value in the Step Angle box on the Rotate Ribbon (on
page 362).
In order to copy the rotated items into the new position, you can hold CTRL while you click to
define the to point.
You can use other manipulation commands, such as Zoom and Pan, while you are using the
Rotate command. When you finish manipulating the item, the software returns you to the
Rotate command at the point that you were when you started manipulating the view.

Rotate Ribbon
Appears when the Rotate command is active, and allows you to either observe rotation options as
you rotate an item or specify rotation options.
Copy Creates a copy of the item that you are rotating.

362

SmartPlant Electrical User's Guide

Drawing Items
Position Angle Displays the angle between the horizontal axis through the center of rotation
(A) and the point that you rotate from (B). Then, if you rotate the item, the position angle (C)
changes to become the angle between the horizontal axis and the point to which you rotate. The
position angle is always a positive value measured counter-clockwise from the axis.

Rotation Angle Defines the rotation angle. The rotation angle is the angle between the point
from which you rotate and the point to which you rotate. In the following picture, the center of
rotation (A) shows the point (B) from which you rotate the item.

The rotation angle (C) is the angle of change between the old and new positions of the rotated
item. The value is always positive.
Step Angle Specifies the rotation step angle. The step angle specifies the increments, in
degrees, that an item rotates on a rotation axis. You can enter increments in the Step Angle box.
For example, if the box is set to 30.0, the rotation is displayed in 30 degree increments. The
default setting is 0 degrees so that the rotation is fully dynamic.

Manipulating Smart Labels


Component handles allow you to rotate or mirror a Smart Label around axes changing their
orientation in relation to the labels associated item. Only those Smart Labels that appear in cable
block diagrams, power distribution board layout drawings, single line diagrams, and wiring
diagrams, and are associated with connectors can be mirrored or rotated.

The mirror handle allows you to mirror about the horizontal and vertical axes, defined in
relation to the origin of the item. You can mirror items by dragging the mirror handle in the
appropriate direction. The software shows you the result of the operation dynamically so that
you can be sure to mirror the item correctly.

The rotate handle provides a mechanism for rotating components around their origin. You
can rotate items by dragging the rotate handle in the appropriate direction. The software
shows you the result of the operation dynamically so that you can be sure to rotate the item
correctly.
For more information, see Working with Labels in the SmartPlant Engineering Manager Users
Guide.

SmartPlant Electrical User's Guide

363

Drawing Items

Create a Mirror Image of a Smart Label


This procedure shows you how to mirror a Smart Label about the horizontal and vertical axes.
1. Select the Smart Label in the drawing.
2. Click the mirror handle , the cursor changes to
.
3. Drag the mirror handle in the direction that you want to mirror the item, the new label position
is outlined on our drawing.
4. Release the mirror handle.

Rotate a Smart Label


This procedure shows you how to rotate a Smart Label on your drawing.
1. Select the Smart label on the drawing.
2. Click the rotate handle
.
3. Drag the rotate handle in the direction that you want to rotate the item.
You can click the rotate handle closer to or further from the center of the item to change the
step angle for the rotation.

Align Smart Labels


This procedure shows you how to align Smart Labels on your drawing.
1. In the Drawing view, select the labels that you want to align.
In order to align labels, you must be sure not to select any drawing items other than
labels. You can remove an item from a select set by pressing CTRL and clicking the item.
2. Click the appropriate alignment button on the main toolbar:

364

Align Left Align labels so that their left-most lines match

Align Right Align labels so that their right-most lines match

Align Center About Vertical Align labels so that their center points agree on a
horizontal line

Align Center About Horizontal Align labels so that their center points agree on a
vertical line

Align Top Align labels so that their top lines match

Align Bottom Align labels so that their bottom lines match

SmartPlant Electrical User's Guide

SECTION 25

Working with Documents


Internal Documents in SmartPlant Electrical
Internal documents are cable block diagrams, single line diagrams, electrical schematics, and
power distribution board layout design drawings. You create these documents for selected
electrical items and, therefore, you do not need to associate them with the items. The software
adds your internal documents to the document repository automatically and you can associate
them with other electrical items as needed. You can add and maintain revisions in internal
documents. The software allows you to select a revision numbering method, enter a revision
number, date, short description, and the name of the person who modified the document. Also,
you can add or update the last revision of a number of selected documents. When you work with
internal documents, your tasks mostly include managing revisions for single or multiple
documents, archiving documents and comparing them with current versions.

Add a Document Revision


This procedure explains how to add a revision to a single document.
1. Open or generate an SLD or a schematic drawing.
2. Click Edit > Document Properties.
To access the Document Properties command, first select an item in the drawing.
3. On the Document Properties dialog box, click New.
4. Under Revision method, select a revision numbering method that you require for the current
document.
If a document you are revising already has a revision, do not change the revision method
unless you want the software to start a new revision numbering.
5. In the Revisions group box, under Revision Numbering, accept the displayed value or type
the one that you require.

If you type a value that does not comply with the current revision method, the next time
you add a new revision, the software starts a new numbering. For example, the selected
revision method is P0, P1, P2 and the last revision is P3. If you add a new revision
number RRR and then another one using the P0, P1, P2 method, the software displays
the newly added revision as P0.
If you type a value that complies with the numbering method but the value is not
sequential, the software increments the number of the next revision that you add. For
example, the selected revision method is P0, P1, P2 and the last revision is P3. If you
add a new revision number P1, the software will increment the following revision to P2.

SmartPlant Electrical User's Guide

365

Working with Documents


6. Type all the other pertinent information relating to the revision date, person who created and
checked the revision, and so forth.

You can delete a selected revision by highlighting a row and clicking Delete. The software
updated the revision numbers automatically if the subsequent revision number complies with
the selected revision method.
Using the Data Dictionary Manager, it is possible to determine which fields are available on the
Revisions tab. For details, see Data Dictionary User's Guide > Modify Properties of
Database Tables.

Manage Global Revisions


This option allows you to perform a number of revision activities for a group of selected
documents. You can add, update, upgrade, and delete revisions in batch mode.
1. In the list view of the Electrical Index, select the documents that you require.
2. Click Actions > Global Revisions.
3. From the Activity list, select an activity to perform with a global revision:
Add revision - adds a new revision to the selected documents in accordance with the
value that you specify for the Revision number setting. The software determines which
revision method suits best the value that you typed in the Revision number field and
adjusts the revision method accordingly. If the revision number value that you are adding
conforms with method of the last existing revision, the software will continue to number
the new revision accordingly. If the software cannot determine a suitable revision
method for the typed value, the revision method will switch to Other. Also, if you do not
enter a value in the Revision number field, the software will add a new revision using the
Other method and will not provide a value in the Revision number field of the individual
documents.
Upgrade revision - adds a new revision by raising the last revision number of all the
selected documents. The software identifies the revision numbering method of each
document (P0, P1, P2; 0,1,2, A,B,C, and so forth) and raises the revision number to the
next value according to the existing revision method. You cannot change the revision
method but you can update all the other settings by entering new settings.
Delete last revision - deletes the last revision of all the selected documents.
Delete all revisions - deletes all the revisions of all the selected documents.
4. From Revision method for items without revisions, select a revision method if some of the
selected documents have not been revised yet.
5. Edit the settings as you require.
The software archives all the added and upgraded revisions of the selected documents so
that you can compare the data of an archived document with the current version. For more
information, see Compare an Archived Document with a Current Document (on page 367).

366

SmartPlant Electrical User's Guide

Working with Documents

Compare an Archived Document with a Current Document


The software allows you to archive SLDs, schematic drawings, wiring diagrams, and cable block
diagrams in your SmartPlant Electrical database. This option then makes it possible to compare
an archived version of a document with the data in the current version of that document. Before
comparing an archived version of a document, you can click View to open it for viewing. To
enable the archiving option, make sure that your Project Administrator switches on the archiving
option in Options Manager. Once the archiving option is switched on, the software automatically
archives every added or modified revision whether you did it for a single document or used the
Global Revision feature for multiple documents.
You can archive and compare single line diagrams, schematics, wiring diagrams,
and cable block diagrams. However, the software does not allow you to archive miscellaneous
drawings.
1. Open or generate a drawing.
2. Modify the drawing as you require.
3. Save the drawing.
4. Click Edit > Document Properties.
5. Add a revision and click OK on the Document Properties dialog box.
Repeat the above procedure as many times as required to add archived versions of the
document to the database.
6. In the Electrical Index, expand the Documents folder hierarchy to display the names of the
existing SLDs or schematics.
7. In the appropriate document folder, select the document you require and do one of the
following to open the Compare Documents dialog box:
Click Actions > Compare Documents.
Right-click the document and select Compare Documents from the short-cut menu.
8. Select an archived version of the document and click Compare.
Before clicking Compare, you can click View to open the selected drawing that you want
to compare. The software opens the archived drawing in view mode only.

The software displays clouds around the items that differ from the current data. The last
revision number is shown in a triangle beside the cloud.
The software uses index numbers to identify the changes in associations between electrical
items.
The software generates a tabular report where it shows all the changes and shows the
changes in associations using index numbers as they appear in the drawing.
For registered reports, the software opens two Excel files. One of the Excel files displays
changed data with a blue shading. The second file is a summary of all changes and it is called
Registered Comparison Report. This report displays the previous and current data for
each tag that has undergone a change. Note that you can compare a registered report only if
this is a simple tabular report.

SmartPlant Electrical User's Guide

367

Working with Documents

In SLDs, the software indicates the following changes:


All added and deleted electrical items except for control stations.
Added, deleted, and updated properties of electrical items.
Changes in associations.
Attachment to a different document template.
In schematic drawings, the software indicates the following changes:
Added, deleted, and updated properties of electrical items.

Batch Compare Documents


1. In the Electrical Index, expand the Documents folder hierarchy to display the names of the
existing SLDs or schematics.
2. Select the Single Line Diagrams or Schematic Drawings folder.
3. In the lower pane, select the documents you require and do one of the following to open the
Batch Compare Documents dialog box:
Click Actions > Compare Documents.
Right-click the document and select Compare Documents from the short-cut menu.
4. To save the comparison report, select Save files.
5. Under Path, type the folder path where you want to save the report, and from the Save as
type list, select the desired file format.
6. To print the current and last revised versions of the selected drawings, select Print drawings.
7. To print a set of reports comparing the changes between the current and last revised
drawings, select Print comparison reports.

368

The software compares the current data with the last saved revision.
In SLDs and schematics, the software displays clouds around the items that differ from the
current data.
The software uses index numbers to identify the changes in associations between electrical
items.
The software generates a tabular report where it shows all the changes and shows the
changes in associations using index numbers as they appear in the drawing.
In SLDs, the software indicates the following changes:
All added and deleted electrical items except for control stations.
Added, deleted, and updated properties of electrical items.
Changes in associations.
Attachment to a different document template.
In schematic drawings, the software indicates the following changes:
Added, deleted, and updated properties of electrical items.

SmartPlant Electrical User's Guide

Working with Documents

External Documents
External documents are external files that you associate with electrical items in the
software. These files can be reference documents or drawings, such as a general specification
number, requisition number, vendor document, civil or structural document, site layout drawing,
an electrical communications drawing, and so forth.
The software allows you to create a document reference repository that stores all the document
references in your system. You can add external file references to your document repository or
just create references that you can link to external files later. It is possible to display all the
documents associated with a selected electrical item classified according to document category
and type. Also, you can associate documents with multiple items if needed. Note that if you
delete an electrical item that is associated with an external document, the software deletes the
external document association automatically.

Define an External Document Reference


You define a document reference by adding a reference to the list of document references. You
can then associate this reference with an external file. The software adds this association by
storing the file path in the database.
1. Click Actions > Define Document Reference.
2. On the Document Reference Definition dialog box, under Filter by, select a document
category.
3. Select a document type.
4. Click Add.
5. Under Edit, type a value in the Document box.
If you selected All types from the Document type list under Filter by, select the desired
value from the Document type list under Edit.
6. Type a suitable document description in the Description box if needed.
7. Beside the Path and file name box, click the ellipsis button

to select the desired file.

You do not have to associate a document reference with an external file. You can do
this at some other time when needed.
8. On the Select File dialog box, select the desired file.
9. Click Apply to store the document reference in the database and select another document
category if needed.

SmartPlant Electrical User's Guide

369

Working with Documents

Associate External Documents with Electrical Items


After you define external document references, you select one or more electrical items and
associate them with external documents. You can associate an electrical item with a document
reference or with an external file that is linked to the document reference. The software allows
you to associate single or multiple electrical items with the same external document. Also, you
can associate the same external file with multiple items in the software.
1. Define a reference for the document that you want to associate. For details, see Define an
External Document Reference (on page 369).
2. In the Electrical Index or Tabular Editor, select an electrical item.

3.
4.
5.
6.

You can also associate multiple electrical items with the same external document. In
the Electrical Index, click a folder that contains electrical items and highlight in the list view
pane the items that you require.
Click Actions > Associate Document.
On the Associate Documents dialog box, under Filter by, select a document category and
type from the lists.
Click Add.
On the Find dialog box, click Find Now to display the available documents.

The Find dialog box finds only those documents that belong to the document category
and type that you select on the Associate Documents dialog box.
7. Select each document that you want to associate with the selected item and then click Apply.
To associate documents belonging to another category or type, return to the Associate
Documents dialog box, select the desired document category and type, click Associate again,
and repeat the succeeding steps in this procedure.

Dissociate an External Document


This option allows you to dissociate electrical items from external documents.
1. In the Electrical Index, select an electrical item.
2. Click Actions > Associate Document.
3. On the Associate Documents dialog box, under Filter by, select a document category.
4. From the Document type list, select a document type.
5. Under List, highlight the document that you want to dissociate.
6. Click Remove.
To dissociate a document belonging to another type or category, click Apply and then select
another document type and category as required.

370

SmartPlant Electrical User's Guide

Working with Documents

Dissociate an External Document from Multiple Electrical


Items in Batch Mode
This option allows you to dissociate an external document from multiple electrical items in batch
mode.
1. In the list view of the Electrical Index, select the electrical items you require.
2. Click Actions > Associate Document.
3. On the Associate Documents dialog box, under Filter by, select a document category.
4. From the Document type list, select a document type.
5. Click Dissociate.
6. On the Find dialog box, click Find Now.
7. Select the document that you want to dissociate from the selected items and click OK.
8. On the Associate Documents dialog box, click OK or Apply.

Open an External Document


This option allows you to open an external file that is associated with a document reference.
1. In the Electrical Index, select an electrical item.
2. Click Actions > Associate Document.
You can also open an associated document by clicking Actions > Define Document
Reference.
3. On the Associate Documents dialog box or the Document Reference Definition dialog
box, under List, select the document that you want to open.
On the Document Reference Definition dialog box, under Filter by, select the required
document category and type.
4. Click Open.

SmartPlant Electrical User's Guide

371

Working with Documents

Inserting External Graphics Files into SmartPlant


Electrical Templates
The software allows you to create project drawings based on graphics files created in
SmartSketch or any other CAD application. These project drawings are called miscellaneous
drawings. You create miscellaneous drawings by inserting an external graphics file into a
SmartPlant Electrical template.
Once you create a miscellaneous drawing and save it to your SmartPlant Electrical database, the
software updates the drawing title block and the revision data. The software also enters the
revision property macros, which enables the retrieval of information from the database when you
reopen the drawing. SmartPlant Electrical organizes these drawings in the Miscellaneous
Drawings folder in the Electrical Index.
You can open a miscellaneous drawing and manage its revisions as you require. However, you
cannot archive a miscellaneous drawing and therefore you cannot compare it with a previous
revision.
Just like with external documents, SmartPlant Electrical allows you to associate a miscellaneous
drawing with an electrical item.

Insert an External Graphics File into a SmartPlant Electrical


Template
This option allows you to insert an external graphics file into a SmartPlant Electrical template. An
external graphics file can be any file created in SmartSketch or any other CAD application.
Open Options Manager and set a default path for miscellaneous drawings.
For details, see Define File Locations in the Options Manager User's Guide.
1. In SmartPlant Electrical, double- click the Documents folder and then right-click the
Miscellaneous Drawings folder in the Electrical Index.
2. On the shortcut menu, click New Miscellaneous Drawing.
3. On the New Miscellaneous Drawing dialog box, beside the Template box, click the ellipsis
4.
5.
6.
7.
8.

button
to select a template that you require.
Under Document number, type a document name. Note that this is a required field.
Type a short description if needed and click OK.
In the drawing that opens, to insert a symbol, click Edit > Insert > Symbol.
On the Select Symbol File dialog box, select a symbol and click OK.
To place the symbol in the drawing, position the cursor in the open drawing and then press the
left mouse button. Note that the cursor marks the symbol origin (the left bottom corner).

You can insert as many symbols as you require.


9. Click File > Save to save the miscellaneous drawing.

372

After saving a miscellaneous document, you can set the appropriate revisions as you
require. For details, see Add a Document Revision (on page 365).
You can associate an electrical item with a miscellaneous drawing. For details, see Associate
External Documents with Electrical Items (on page 370).

SmartPlant Electrical User's Guide

Tabular Editor

Tabular Editor
You use the Tabular Editor for viewing and performing editing or other operations on one or more
items of a specified item type.
The Table Properties dialog box (on page 816) allows you to define the items you want to see in
the table view. You customize a filter and layout for the display on the Advanced Table
Properties dialog box (on page 813).
The main features of the Tabular Editor are:

Header
The header displays the following information:
Total count - The total number of rows (tags) that your table contains. Filtering does not change
this value.
Item type - The item type on which your table is based.
Layout - The layout name that your table uses to determine which properties appear, and their
order.
Tabular editor layouts are limited to 350,000 cells. It is highly recommended that you
work with filtered layouts to avoid the creation of numerous cells that you might not need.

Data
You can populate data viewed in the table in one of the following ways:
Selecting a table cell and typing the appropriate information.
If the property has a select list associated with it, then you choose the value from the select list.
If the cell is populated by a value that results in calculating another cell, the software performs
the calculation and displays the result in the appropriate cell.
If the cell is populated by a read-only property or a property that is only automatically generated by
validation or calculation, you cannot edit that cell. You can select an entire row, corresponding to
the properties of a single item tag, by clicking the corresponding row number to the left of the
table. Then you can view the properties in the Properties window and edit item properties there,
too.
The contents of cells can be copied to other cells, provided the cell contents are compatible.

Data Manipulation
You can perform the following operations in the Tabular Editor:
Move a cell from one location to another like in Excel.
Change the width of a cell by dragging the edge of the cell header and making the cell wider or
narrower. When you save the settings, the software retains cell widths the next time you open
the layout.
Freeze one or more columns to prevent them from scrolling. Click a column header to select
the column, then right-click in the table and select Freeze Panes on the shortcut menu. The
software prevents all the columns to the left of the selected column from scrolling horizontally.
Double-click a cell to select its contents for editing.
Click a cell once to select the entire row for copying or pasting data.
For a multiple selection using the TAB or CTRL keys, click the relevant row numbers.
Click the upper left empty header to select all the items.

SmartPlant Electrical User's Guide

373

Tabular Editor
Printing
You can print out the contents the current table. The software opens a print preview in Microsoft
Excel that allows you to view and print out the data. For more details, see Print Tabular Editor
Content (on page 379).

When navigating in the Tabular Editor, the Properties window is enabled. When you select
a tag in the Tabular Editor, the data for the tag appears in the Properties window. Editing a
property of a tag in the Properties window is immediately reflected in the Tabular Editor and
vice versa.
The Properties window can display data for either the Tabular Editor or for one of the
windows where you select an item (Reference Data Explorer, Electrical Index, or Electrical
Engineer). If you select more than one tag in the Tabular Editor, the Properties window can
display common properties when you choose Select Set from the list at the top of the window.
After exiting SmartPlant Electrical, and starting a new session, the software retains the size
and position of all the windows that were open in the previous session.

When tabbing through the cells of a Tabular Editor work sheet, pressing F4, when a select
list field is highlighted, displays the select list contents. You can then use the arrow keys to select
the desired item.

Display the Tabular Editor

Click Window > New >Table

Define a New Tabular Editor View


1.
2.
3.
4.

Click Window > New > Table.


On the Table Properties dialog box, select an item type from the Item Type list.
Select a filter from the Filter list.
Select a layout from the Layout list.

When you create a Tabular Editor view for abstract item types such as loads or converting
electrical equipment, as opposed to specific item types such as motors or transformers, the
software displays all the common properties for these item types in the Tabular Editor. With
loads, for example motors and heaters both appear, but the software cannot display their
specific properties in one common Tabular Editor view. However, when you select items of
the same specific type, all of the properties appear in the Properties window.
If you do not find a filter you want under Filter, you can define a filter on the Filter tab of the
Advanced Table Properties dialog box. Open the Advanced Table Properties dialog box
by clicking Advanced on the Table Properties dialog box.
If you do not find a layout you want under Layout, you can define a layout on the Layout tab of
the Advanced Table Properties dialog box. Open the Advanced Table Properties dialog
box by clicking Advanced on the Table Properties dialog box.
To modify an existing table, right-click in the table and select Edit View to open the Table
Properties dialog box.
To print out the contents of an open table, right-click in Tabular Editor and then on the shortcut
menu, click Print or Print Preview. For details, see Print Tabular Editor Content (on page
379).

374

SmartPlant Electrical User's Guide

Tabular Editor

Define a Filter for a Tabular Editor View


1. Click Advanced on the Table Properties dialog box.
You can open the Table Properties dialog box by right-clicking in the Tabular Editor and
choosing Table Properties from the shortcut menu.
2. On the Filter tab of the Advanced Table Properties dialog box, specify a name for the filter
in Base filter.
Select Default if you want this filter to be the default for the item type that you selected on
the Table Properties dialog box.
3. Click Browse if you want to search for a filter or create a new filter - either simple or
compound - using the Select Filter dialog box.
4. To further define a filter, populate the Definition box with properties and values. Click Add to
add a line to the Definition box.
5. Select a property, an operator, and a value from the Edit group. Property lists properties that
apply to your item type; Operator lists all the possible relationships, such as greater than and
not equal to; select the specific property value you want to filter for in Value.

6.
7.
8.
9.

You can use an operator with a property that has a value with a unit of measure. For
example, you can filter a table showing motors to show only those motors that have the brake
power value greater than the value you set in the filter.
To add more entries, repeat steps 4 and 5.
Click Delete if you want to delete the current row in the Definition box.
Click either Match all or Match any.
Click OK on the Advanced Table Properties dialog box and again on the Table Properties
dialog box so that the software can populate your table.
After you have defined a specific filter for your Tabular Editor, you can save that
definition. For details, see Save a Tabular Editor Layout (on page 377).

Define a New Layout for a Tabular Editor View


The following procedure deals with the definition of tabular editor view layouts.
Tabular editor layouts are limited to 350,000 cells. It is highly recommended that you
work with filtered layouts to avoid the creation of numerous cells that you might not need.
1. Open the Table Properties dialog box by doing one of the following:
Click Window > New > Table Properties.
Right-click in the Tabular Editor and on the shortcut menu, click Table Properties.
You can define a layout by selecting a default layout from the Layout list and modifying
it. You can then save and use the modified layout. For a list of the default layouts that come
shipped with the software, see Shipped Default Layouts (on page 376).
2. Click Advanced.
3. On the Layout tab of the Advanced Table Properties dialog box, specify a name for the
layout.
Select Default if you want this layout to be the default table layout for the item type,
which you specified on the Table Properties dialog box. Since there can only be one default
layout per item type, whichever layout you last selected as the default becomes the current
default layout.

SmartPlant Electrical User's Guide

375

Tabular Editor
4. Click Save if you want to save the layout in order to apply it to another Tabular Editor, click
Delete if you want to delete the layout.
5. To further define a layout, populate the Definition box with display and sort properties.
6. Click Add to add a line entry to the Display Property list. Then specify the property and
caption in the Edit group at the bottom of the dialog box.
To add and define more display properties, repeat step 5.
To change the display order of the columns in the Tabular Editor, select a row in the
Display Property box and click Move Up or Move Down.
7. In the Sort Property list click Add to add an entry. Then select the property, order, and type
in the Edit group at the bottom of the dialog box.
To add and define more sort properties, repeat step 7.
To change the sort order of the properties in the Tabular Editor, select a row in the Sort
Property box and click Move Up or Move Down.
The Add, Insert, Delete, Move Up, and Move Down buttons apply to the active list
view, which can be either Display Property or Sort Property.

Shipped Default Layouts


Several default layouts come shipped with the software. You can use them to define your own
layouts by changing the layout name, adding or deleting properties as required, and saving under
a new name.
The following shipped layouts are available for the appropriate item types:
Default Battery Bank List
Default Bus List
Default Cable List
Default Circuit List
Default Circuit Breaker List
Default Control Stations List
Default Document List
Default Generator List
Default Load List
Motor List
Default PDB List
Default Reference Cable List

Modify the Table Properties of an Existing Tabular


Editor View
1. Click inside the Tabular Editor.
2. Click View > Table Properties to open the Table Properties dialog box.
You can open the Table Properties dialog box by right-clicking in the Tabular Editor and
choosing Table Properties from the shortcut menu.
3. Review and edit the item type, filter, and layout.
4. If you want to customize a filter or layout click Advanced on the Table Properties dialog box.
5. Define a Filter for a Tabular Editor View (on page 375).

376

SmartPlant Electrical User's Guide

Tabular Editor
6. Define a New Layout for a Tabular Editor View (on page 375).
7. Click OK on the dialog box to display the modified view.

After defining a layout, you can save it if you want to apply it to another Tabular Editor view. To
save the view layout, specify a name in Name and click Save on the Advanced Table
Common Properties Layout tab.
You can also name and save the entire Tabular Editor view, layout and all:
Save a Tabular Editor Layout (on page 377)
You can edit some of the properties of those items that appear in the Tabular Editor. You can
edit the contents of some cells directly in the Tabular Editor if the corresponding property is not
read-only or generated strictly by validation; you can copy, cut, and paste properties too, with
the same restriction, or you can click on the row number to the left of the Tabular Editor to
select an item and edit its properties in the Properties window.

Save a Tabular Editor Layout

After you have customized the Tabular Editor, on the Tabular Editor Property dialog box,
Layout tab, click OK.

You can delete a saved view, too. For more details, see Delete a Tabular Editor Layout (on
page 377).
The Tabular Editor is where you can display database items.
You can customize the Tabular Editor. For more details, see Modify the Table Properties of
an Existing Tabular Editor View (on page 376).

Delete a Tabular Editor Layout


1.
2.
3.
4.
5.
6.
7.

Click inside the Tabular Editor.


Click View > Table Properties.
Click Advanced.
On the Advanced Table Properties dialog box, click the Layout tab.
From the Name list, select the layout you want to delete.
Under the Name group box, click Delete.
When prompted, click Yes to confirm the deletion.

Update Tabular Editor Data

Right-click inside the Tabular Editor and on the shortcut menu, click Refresh.

The database can change at any time. The software does not update the Tabular Editor
automatically: you must update it by using the Refresh command manually.

SmartPlant Electrical User's Guide

377

Tabular Editor

Search for Tags from the Tabular Editor


1. Open a Tabular Editor view.
2. Select a row.
3. Right-click, and on the shortcut menu, click one of the following:
Find in Electrical Engineer.
Find in Electrical Index.

Use AutoFilter in the Tabular Editor


1. Turn AutoFilter on by right- clicking in the Tabular Editor and choosing Auto Filter from the
shortcut menu.
Click AutoFilter again from the shortcut menu to turn the AutoFilter feature off.
2. Click on the down-arrow at the top of the column you want to filter values for.

To match a single value, choose that value from the list that is displayed.
To display rows that meet two conditions, choose Custom from the list. The Custom
AutoFilter dialog box opens. Enter the comparison operator and value you want, and
then click the And button. In the second comparison operator and value boxes, enter the
operator and value you want.
To display rows that meet either one condition or another condition, enter the comparison
operator and value you want, and then click the Or button. In the second comparison
operator and value boxes, enter the operator and value you want.
You can also choose Blanks or NonBlanks from the list in order to display items that
either have no value in the column or do have a value in the column, respectively.

Since properties with units of measure are strings, you cannot perform mathematical
operations on these type of properties.

Copy Data from the Tabular Editor to an External File


1. Open a Tabular Editor view.
2. Select a row, cell, or group of cells.
You can click the upper left empty header to select all the items.
3. Right-click inside the Tabular Editor and on the shortcut menu, click Copy.
4. Open an external file, for example a Microsoft Word file or an Excel sheet.
5. Paste the data into the desired location.
In Word, the data is pasted in with tab separators between columns and paragraphs
between rows. In Excel, the data is pasted into the same cell positions as the original cell
positions in the Tabular Editor.

378

SmartPlant Electrical User's Guide

Tabular Editor

Print Tabular Editor Content


You can print out the contents the current table. The software opens a print preview in Microsoft
Excel. The Excel print preview displays the data as it is retrieved from the current table. You can
adjust the table width in Tabular Editor before printing. The column width and all other data is
retained in Excel. You can close the Excel print preview and work with the data in Excel as you
require.
You can print out the contents the current table by doing one of the following:
Right-click somewhere in the Tabular Editor and then on the shortcut menu, click Print.
Click File > Print.

SmartPlant Electrical User's Guide

379

SECTION 26

Reports in SmartPlant Electrical


In This Section
Create a New Customized Report ................................................. 381
Generate a Report for Selected Items ........................................... 382
Shipped Reports ............................................................................ 382
Registering Reports ....................................................................... 391
Creating and Editing Report Templates ........................................ 395

Create a New Customized Report


This procedure describes the work flow for creating new customized reports.
1. On the SmartPlant Electrical menu bar, click Reports > New.
2. On the New Report Template dialog box, select an appropriate source template.

3.
4.
5.
6.
7.
8.
9.
10.
11.

If you select the Blank template, the file format for Excel 2007 and higher is Excel
Macro-Enabled Workbook (*.xlsm). For Excel 2003, the file format is Microsoft Excel
Spreadsheet (*.xls).
Under Name, type the report name.
Select an appropriate item type for which your report will be used.
Select an appropriate report format: fixed, tabular, or composite. For details, see New
Report Template Dialog Box (on page 783).
Click OK.
On the SmartPlant Electrical menu bar, click Reports > Edit and select your new report to
edit in MS Excel.
Edit your report headers as you require. For details, see Define Report Headers (on page
397).
Edit your report contents. For details, see Define the Contents of Your Report Template (on
page 398).
To open your new report, click Reports > My Reports.
Select your report from the My Reports list and click OK to open it in Microsoft Excel.

SmartPlant Electrical User's Guide

381

Reports in SmartPlant Electrical

Generate a Report for Selected Items


1. In the Electrical Index, select the items for which you want to generate a report.
2. Click Reports > Plant Reports.
Alternatively, click Reports > My Reports to select a customized report that you defined
already.
3. On the Plant Reports dialog box or the My Reports dialog box, choose the items you want to
report on.
4. In the Report using group box, select one of the following options:
Current selection - Produces a report containing the selected items in your current
table. This option is not available if no table items are selected.
Entire table - Produces a report containing the contents of the Tabular Editor.
5. Click OK.

You must have Microsoft Excel installed on your computer to display reports.
When creating a report based on the Blank template, the Excel file format of the Blank
template is XLSM for Office 2007 and Office 2010, for Office 2003, the file format is XLS.
The software stores the reports that you generate on your local computer in the Windows
directory under \Profiles\<username>\My Reports\Output.

Shipped Reports
SmartPlant Electrical provides you with a number of predefined reports. You can use these
reports as templates for any other reports. You can define your own sort and filter settings. Also,
you can use sort, filter or other queries to create new reports.
Note that if you do not select particular items in a table that you open in the Tabular Editor, the
software generates a report that includes all the tags belonging to the item type that the report is
based on.
Every time you generate a report, the software retrieves the relevant data from the database and
calculates the pertinent results based on the currently retrieved values. The software does not
store the report and the calculation results in the database, but rather in the Excel file that the
software creates after generating the report. The software recalculates the values every time you
generate the report. Therefore, the report displays the data only as it exists at the time of the
report generation. You can then save the report as an external Excel file if needed.
Note that there are hidden columns and Visual Basic code in the templates of these reports. Be
very careful when editing a template or a report, as this may render your report unusable.
The following reports are available:

382

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


I/O Signal List
I/O Signal List is a report that is intended for publishing signal data to SmartPlant
Instrumentation. The report includes all I/O signals defined in the units of the current plant. This
report provides the following information:
I/O signal tags
Description
I/O types
Host
Card
Channel
Address
CS tag
Reference instrument loop

I/O Signal List - With Issue


I/O Signal List - with issue is a report that is intended for publishing signal data to the integrated
environment. The report includes all I/O signals defined in the units of the current plant. This
report provides the following information:
I/O signal tags
Description
I/O types
Host
Card
Channel
Address
CS tag
Reference instrument loop

I/O Signal and Equipment - With Issue


I/O Signal and Equipment - with issue is a report that is intended for publishing signal and
equipment data, or just equipment data to the integrated environment. The report includes all I/O
signals and equipment defined in the units of the current plant. The report provides the following
information:
I/O signal tags
Description
Equipment tags
Item type
I/O type
Host
Card
Channel
Address
CS tag
Reference instrument loop

SmartPlant Electrical User's Guide

383

Reports in SmartPlant Electrical


Instrument and Cabinet Load List
Instrument and Cabinet Load List is a report that is intended for publishing instruments and
cabinets that have been retrieved from SmartPlant Instrumentation as loads. The report actually
displays data for all electrical equipment types; however, when you use it for publishing data to
SmartPlant Instrumentation, the software automatically selects data for instruments and cabinets
only; you should not use a filter to do so. This report provides the following information:
Instrument / cabinet tags
Tag types
Description
Instrument rated power
Cabinet rated power

Instruments and Cabinet Load List - With Issue


Instrument and Cabinet Load List is a report that is intended for publishing instruments and
cabinets that have been retrieved from SmartPlant Instrumentation as loads to the integrated
environment. The report actually displays data for all electrical equipment types; however, when
you use it for publishing data to the integrated environment, the software automatically selects
data for instruments and cabinets only; you should not use a filter to do so. This report provides
the following information:
Instrument / cabinet tags
Tag types
Description
Instrument rated power
Cabinet rated power

Electrical Load List


Electrical Load List is a report that you generate based on the load item type. The software
retrieves the load tags with the relevant load tag data, such a rated power, brake power for motors,
as well as values for efficiency, power factor, full load current, and so forth.
To customize this report VB programming skills are required.

PDB Load Summary


PDB Load Summary is a report that you generate based on a load item type. The purpose of this
report is to provide a list of loads that are associated with power distribution boards, to sum the
electrical kW, kVAR values of these loads and, based on the individual coincidence factors,
calculate normal and peak consumptions that enable you to estimate the desired capacities that a
particular PDB has to deliver.
The report specifics are as follows:
For each associated load, the report lists such properties as load rated power, the load
demand factor, operating mode, and the electrical rated values (in kW and kVAr) of the load.
On the first page of the report, the software shows the loads that are not yet associated with
any PDB. On the subsequent pages of the report, the software lists each PDB and its
associated loads.
The report includes only those PDBs that are associated with loads. However, the report
does not include loads that do not belong to the load item type.
Loads that are connected to circuits for which the circuit mode value is Disconnected appear
in load summaries, but the software does not take those loads into account in the total load
calculation.

384

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical

The report groups and sorts the loads according to their associated PDB.
The software sums the electrical quantities to provide the total running load and the total peak
load based on the coincidence factors that has been defined for each load.
Under each PDB in the report, the software sorts the loads according to their bus association
and then alphanumerically under the bus.
The software does not filter out any specific PDB. If you do not filter the PDBs, the software
lists all the existing PDBs. To create a report for a specific PDB, use an appropriate
filter. The software displays each PDB on a separate page. The first page is reserved for
those loads that are not associated with a PDB.
The report multiplies each electrical load by its coincidence factor (x, y, z or zz).
Based on the total kW and KVA values, the software calculates the needed power factor in the
report.
The software does not store the report and the calculation results in the database, but rather in
the Excel file that the software creates after generating the report. The software recalculates
the values every time you generate the report. Therefore, the report displays the data only as
it exists at the time of the report generation. You can then save the report as an external
Excel file if needed.
For associated capacitors, the software subtracts the rated kVAr value of the capacitor from
the total connected rated kVAr value. Therefore, the rated electrical power ( kVAr) may
display a negative value. This means that there is a lagging power factor.
When localizing the software, do not translate the values (Continuous, Intermittent,
Standby, and Spare) that appear in the Operating Mode list of the Data Dictionary. The
software will not be able to perform some of the calculations if these values are changed.
It is also possible to generate a PDB load summary for a freestanding bus.
To customize this report VB programming skills are required.

PDB Load Summary - Consumed Power Values


The PDB Load Summary - Consumed Power values report displays consumed power values
instead of rated power values. The rest of the report is identical to the PDB Load Summary
report. You can also generate a PDB load summary for a freestanding bus.
To customize this report VB programming skills are required.

All Feeder Load Summary (Enhanced) Report


The All Feeder Load Summary (Enhanced) report is a summary of the loads that are connected to
the buses of a power distribution board that you select in the Electrical Index or the Electrical
Engineer. This report is based on either the consumed or rated power of the selected loads.
The All Feeder Load Summary (Enhanced) report provides a list of loads that are associated with
power distribution boards, to sum the electrical kW, kVAR values of these loads and, based on the
coincidence factors of the relevant buses or the individual loads, calculate normal and peak
consumptions that enable you to estimate the desired capacities that a particular PDB has to
deliver. The enhanced report sums the loads that are connected to the downstream buses. This
ability to look for downstream loads that are fed from the selected bus is sometimes called "drill
down" or "roll up".
For full explanation, see All Feeder Load Summary (Enhanced) Report (on page 389).
To customize this report VB programming skills are required.

SmartPlant Electrical User's Guide

385

Reports in SmartPlant Electrical


PDB Load Summary by Operating Mode Report
Note that this report is no longer supported.
The PDB Load Summary by Operating Mode report is intended to complement the All Feeder
Load Summary report, which calculates the running and peak loads according the coincidence
factor of each load or according to the bus coincidence factor. This report satisfies the need to
calculate a load summary according to special operating modes, such as emergency or life
support systems for offshore platforms. The software provides ten operating mode factors (duty
and load factors) for each load or bus. The PDB Load Summary by Operating Mode report
displays the calculated figures for the total power according to each of the ten operating
modes. Note that the output of the PDB Load Summary by Operating Mode report is affected by
your settings on the Reports tab of the Preferences dialog box exactly in the same way as the All
Feeder Load Summary report.

Cable Take-Off
Cable Take-Off is a report that provides a summary of all the existing project cable types, including
the cables that haven't been sized yet.
The report specifics are as follows:
Provides technical details about the cable types.
Calculates the total estimated and design lengths of each cable type.
Calculates the lengths of single core conductor configuration cables based on the number of
conductors of each cable.
Provides estimated cable lengths both in meters and feet.
Allows you to expand each cable type to view the individual cable tags.

Cable Schedule
Cable Schedule is a report that lists all the existing project cables.
This report provides the following information:
Cable tag names
Cable types
Estimated and design cable lengths
Store part numbers
Cable origin and destination sides (the To and From cable sides). The To and From
information includes the tag of the electrical item that the cable is associated with. If one of
the cable sides is assigned to a PDB, the report displays the path of the circuit tag: PDB/
bus/(cell)/ circuit.
If you are generating a cable schedule report for a cable that is connected to an auxiliary
contact, the cable schedule report will display the full connection path:
PDB > Bus > Cell > Circuit > Circuit internal disconnect electrical equipment > Auxiliary
contact
Or
Stand-alone disconnect electrical equipment > Auxiliary contact

386

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


Cable Schedule - with issue
Cable Schedule - with issue is a report that lists all the existing project cables for publishing to the
integrated environment.
This report provides the following information:
Cable tag names
Cable types
Estimated and design cable lengths
Store part numbers
Cable origin and destination sides (the To and From cable sides). The To and From
information includes the tag of the electrical item that the cable is associated with. If one of
the cable sides is assigned to a PDB, the report displays the path of the circuit tag: PDB/
bus/(cell)/ circuit.

Cable Sizing Summary


Cable Sizing Summary is a report that lists all the cable sizing input and output data for a specified
power cable. You are required to create a filter for this report to display power cables only. This
report is useful as a quick reference for your sizing considerations and criteria at any time during
the life cycle of your project.
This report provides the following information:
Cable tag name.
Cable origin and destination sides (the To and From cable sides). The To and From
information includes the tag of the electrical item that the cable is assigned to.
Input values such as load voltage, full load current, number of phases, and so forth.
Sizing results such as reference cable, conductor size, calculated voltage drop, and so forth.

Cable Wiring Schedule


Cable Wiring Schedule is a report that provides a list of selected cables and their conductors
showing to which terminal strips and terminals the cables are connected. The report is based on
the item type of the cables for which you want to generate a report. When customizing your cable
wiring schedule report, use the following conductor properties to define the association between
the conductors and the terminals that are connected on both sides of the cables.
Side1.Terminal.Item.Tag
Side1.Terminal Strip.Item.Tag
Side2.Terminal.Item.Tag
Side2.Terminal Strip.Item.Tag

Terminal Strip Schedule Reports


SmartPlant Electrical provides with three terminal strip schedule reports. These reports show
wiring information from the perspective of the wiring equipment that you select in the Electrical
Index. The connection between the terminals and the conductors is based on the ConductorTerminal table. The following reports are available:
Terminal Strip Schedule A report based on the terminal strips you select in the Electrical
Index.
Terminal Strip Schedule - Panel A report based on the panels you select in the Electrical
Index.
Terminal Strip Schedule - PDB A report based on the power distribution boards you select in
the Electrical Index.

SmartPlant Electrical User's Guide

387

Reports in SmartPlant Electrical


Drum Composition

Displays the cable assignments for each drum in your plant.

Segment Width Estimate

You can use the Segment Width Estimate report for calculating the tray widths and number of
layers needed so that you can select appropriate reference cableway components.

Cableway Component Material Take-Off

Displays the quantity of items required for each type of reference cableway component when
ordering items from the manufacturer.

Cableway Segment Schedule

Displays the list of cables in each cableway segment that makes up your cable routing.

Segment Fill

Displays the fill status and tray loading for each segment and indicates whether or not the
segment is overfilled.

PDB Schedule

PDB Schedule is a report that you generate based on the circuit item type. The report
specifics are as follows:
The report lists, for all the power distribution boards in the current plant, all the circuits, loads,
circuit internal components with the technical details of each circuit.
The report includes the associated schematic drawings.
The report uses a predefined filter to display the associated schematic drawings. To
customize this report VB programming skills are required.
It is also possible to generate a PDB schedule for a freestanding bus.

Power Distribution Panel Schedule

388

Power Distribution Panel Schedule is a report that is intended for single phase loads
connected to distribution panels. The report specifics are as follows:
The report lists, for all the power distribution boards in the current plant, all the circuits,
each with its protection device type and current rating (the software supports a single
protection device per circuit) and the loads associated with each circuit.
The report sorts the circuits by phase and then by circuit (all the circuits for phase 1, then
phase 2, and then phase 3).
The report calculates the following: Full load current for each phase, Total load current of
the bus, Total kW per phase, Total kW per bus.
This report is not suitable for PDBs that include 3-phase loads.
To customize this report VB programming skills are required.

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical

All Feeder Load Summary (Enhanced) Report


The All Feeder Load Summary (Enhanced) report is a summary of the loads that are connected to
the buses of a power distribution board that you select in the Electrical Index or the Electrical
Engineer. This report is based on either the consumed or rated power of the selected loads.
The All Feeder Load Summary (Enhanced) report provides a list of loads that are associated with
power distribution boards, to sum the electrical kW, kVAR values of these loads and, based on the
coincidence factors of the relevant buses or the individual loads, calculate normal and peak
consumptions that enable you to estimate the desired capacities that a particular PDB has to
deliver. The enhanced report sums the loads that are connected to the downstream buses. This
ability to look for downstream loads that are fed from the selected bus is sometimes called "drill
down" or "roll up".
The software takes into account any existing equipment that is connected in parallel.
Once you start generating an enhanced All Feeder Load Summary report (for details, see
Generate an Enhanced All Feeder Load Summary Report (on page 254)), the software retrieves
the data of all the loads that are connected to the buses that belong to the PDBs or buses that you
selected in the Electrical Index or the Electrical Engineer and starts the bus drill-down
calculation. The software retrieves the values for one bus at a time (the summary is per bus
within the selected PDB) including the loads that are connected to the downstream loads that are
connected and fed from the bus for which the software calculates the summary. The generated
report shows the individual loads connected to the bus as well as all the feeders that feed the
downstream buses and their loads.
When making calculations, SmartPlant Electrical considers the worst case scenario
in its calculation results and does not take into account any load flow that would be taken into
account by a power analysis application such as ETAP. That is, for calculation purposes,
SmartPlant Electrical always assumes that the total connected load is supplied from one source
only. If there are multiple sources that supply the same connected load, SmartPlant Electrical
assumes that each source has the capability to supply the connected load. SmartPlant Electrical,
unlike any power analysis application, does not account for multiple sources that share a load.
Consequently, in SmartPlant Electrical, the total load for a distribution network can appear
artificially high unless the Circuit Mode property is set to either Connected or Disconnected as
desired on specific circuits.
Unlike the presentation of data in the regular All Feeder Summary report, the enhanced report
shows consumed or rated power values, compensated or uncompensated for the coincidence
factors of the buses or loads (depending on the preference settings). For details, see Customize
All Feeder Load Summary Report Preferences (on page 31).
Furthermore, the enhanced report also shows the kV and kVAR values for individual loads
grouped according to the relevant operation mode of the load. The report also includes the
converting equipment power losses data as well as circuit totals.
Note that circuits have a property called CircuitMode with values Connected and
Disconnected. If you set this property to Disconnected, the drill down algorithm will stop the
calculation and the software will not roll up the loads connected to this circuit.
At the bottom of the All Feeder Load Summary report, the software displays the calculated
compensated totals of all the loads at normal and peak operations.
Note that you can customize your Enhanced All Feeder Load Summary report.

SmartPlant Electrical User's Guide

389

Reports in SmartPlant Electrical


For instructions, on the SmartPlant Electrical menu bar, click Help > Contents > Reports in
SmartPlant Electrical > Shipped Reports > Customizing the Enhanced All Feeder Load
Summary Report.

Electrical items are included in calculations if they are defined as consumers. In addition to
loads, you can define converting equipment items, cabinets, local panels, and junction boxes
as consumers. To define an electrical item as a consumer, you have to set the Is Load
property in the Properties window for that item to True or define the electrical item as a
Consumer in the relevant Common Properties dialog box.
If you define a converting equipment item, local panel, or junction box as a consumer and
perform a drill-down calculation, the software uses the rated and consumed electrical load
values of the equipment as the load values, the software ignores the entire branch that is
connected downstream from the equipment. Note that you enter the pertinent rated and
consumed electrical load values on the Common Properties dialog box of the equipment
item.
If you create a circular network that contains several buses that feed other common
downstream buses, the report will display a larger than expected value for the total of the
circuits. In a circular network, each of the circuits includes common loads and, consequently,
the total of the circuits is reflected in the summation of the common loads.
To prevent this from happening, disconnect one of the circuits that feeds the downstream
buses.
The circuit totals that are shown in the Bus grid of the report do not account for transformer
losses. The bus totals, however, do account for these losses.
It is also possible to generate a report for a freestanding bus.
You can customize this report as needed. (Note that VB programming skills are required.) For
detailed information about customizing this report, see the SpelCalcInf.chm file, which is
located in the home folder where your SmartPlant Electrical is installed, for example C >
Program Files>SmartPlant>Electrical>Program\resdlls>0009>SpelCalcInf.chm.

Customizing the Enhanced All Feeder Load Summary Report


The software allows you to customize your All Feeder Load Summary Report (Enhanced). You
can do the following:
Change the column names.
Move the columns to another position.
Add new columns.
Remove redundant columns.
Build new sheets from scratch.
For detailed information about customizing this report, see the SpelCalcInf.chm file, which is
located in the home folder where your SmartPlant Electrical is installed, for example C > Program
Files>SmartPlant>Electrical>Program\resdlls>0009>SpelCalcInf.chm.

390

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical

Registering Reports
When you create an Excel report in SmartPlant Electrical, you can enable revisions for the report
by registering it. If you create a report for an item type where the data can be published, for
example, instruments, cabinets or signal runs, you also need to register the report and enable
publishing. When you register a report, it appears under Documents > Registered Reports in
the Electrical Index. Note that you can associate an electrical item with a registered
report. Also, you can compare the current data with the data in an archived revision of a simple
registered report.

Register a Report
1. Click Actions > Register Report.
2. On the Registered Report Common Properties dialog box, beside the Report template
box, click the ellipsis button

and select a report file.

You can create a custom report or select one of the reports that is shipped with
SmartPlant Electrical. For the full list of shipped reports, see Shipped Reports (on page
382).
In the Select Report window, you can select the XLS or XLSM file extension from the list
beside the File name list.
3. If you want to filter the data that appears in the report, beside Filter, click the ellipsis button
and select a filter that is suitable for the report template. For details of how to create or
modify a filter, see Filter Manager Online Help.
4. Select a value from the Document main item type list if needed.
This value is for information purposes only.
5. Type a name for the document, and if required, a description.
6. To use the report for publishing data to an XML file, select Enable document for publishing.

A report that you register can display revision numbers after you archive the report.
The registered report with its filter defines the exact scope or subset of data to be published.
You can view the layout of this report and the properties that are included in the report when
you open the report; however, the actual data (properties) to be published with each item is
defined in the code.

Include Revision Data in Registered Reports


This procedure explains how to include revision data in registered reports. You can display as
many revision levels as you require.
1. Click Reports > Edit.
2. On the Edit Report Template dialog box, select a registered report template.
3. Click Open.
4. In the Excel report template, select the cells for the revision headers and type the header text
in the selected cells.
If you want the revision information to appear at the top of the report, select the cells in
the Header section of the template.

SmartPlant Electrical User's Guide

391

Reports in SmartPlant Electrical


5. Select another cell to contain the revision data.
6. In the Name Box, type the appropriate name for mapping the desired revision data, for
example:

7. Press ENTER.
8. After adding all the desired revision data, save the Excel template.

392

The following revision mapping names are available:


LastRevision (same as RevisionNumber_1)
RevisionNumber_1
RevisionDate_1
CreateBy_1
CheckBy_1
ApproveBy_1
RevisionDescription_1
You can include as many revision levels as you need. You specify the revision number by
adding an underscore (_) followed by a number to the mapping name. The lowest number
that follows the underscore retrieves the latest revision. For example, if you want to specify
the data indicated for 4 revision numbers in the document in descending sequence, you need
to include the mapping names (one name per cell) in the following order:
Revision

By

Date

RevisionNumber_1

CreateBy_1

RevisionDate_1

RevisionNumber_2

CreateBy_2

RevisionDate_2

RevisionNumber_3

CreateBy_3

RevisionDate_3

RevisionNumber_4

CreateBy_4

RevisionDate_4

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical

Save Free Text in Registered Reports


You can add free text (text that is not part of engineering data that is kept in your SmartPlant
Electrical database) to any registered report that uses the fixed format option. This is especially
useful with data sheet type reports . Retaining free text becomes possible after enabling a special
Excel add-in in the report templates. Note that you have to enable this add-in for the template of
each registered report that will have free text.
After archiving a registered report, the software retains the free text and the smart data with every
revision. This way, each revision can have different free text.
a.

Prior to carrying out the following procedure, you have to select the Trust
access to VBA project object model check box in your Microsoft Excel Options. To do
this, in Excel Options, click Trust Center > Trust Center Settings > Macro Settings >
Trust access to VBA project object model.
The following procedure provides the instructions for enabling this special Excel add-in and saving
the free text.
1. On the SmartPlant Electrical menu bar, click Reports > Edit.
2. Select the template that you require and click Open.
3. In the report template, do the following to add a property that holds a unique value. For
example, the ItemTag property (Motor_1, Motor _2, and so forth.)
a. In Microsoft Excel, click
on the SmartPlant Reports toolbar.
b. On the Define Report Contents dialog box, select the item type for which the new report
is intended and click Define.
c. On the Define Report Item dialog box, from the Available properties list, select any
unique property and click the right arrow to add it to the Selected properties list and click
OK.
We recommend that you select SP_ID because this property is known to be unique.
d. Close the Define Report Contents dialog box.
e. In Microsoft Excel, click in any available cell where you want the selected property (for
example, SP_ID) to appear.
f. Click Map Properties on the SmartPlant Reports toolbar and point to the item type for
which the current report is intended.
g. From the list of the selected properties for this report, click the property that you selected
(for example, SP_ID) to place this property in the selected cell.
h. Click in the Name Box of Microsoft Excel and type Item_ID to name the cell that holds the
selected property (for example, SP_ID).
Note that Item_ID is the only name that is available in the Excel Name Box. It does
not actually matter where you place this cell as long as it exists in the report template.
4. For existing reports, add the following VB code in the report template:
a. In the report template (Microsoft Excel), press Alt+F11.
b. Under VBAProject, double-click ThisWorkbook.
c. In the General declaration section, add the following string:
Public m_objXLAgent As Object
d. Locate the Public Sub BeginReport(vParam As Variant) string and then type the following
underneath:
Set m_objXLAgent = vParam
e. Save your changes and close the template.

SmartPlant Electrical User's Guide

393

Reports in SmartPlant Electrical


5. To register the report, click Actions > Registered Reports on the SmartPlant Electrical menu
bar.
6. On the Registered Reports Common Properties dialog box, select the required template.
7. Type the report name and a brief description if needed.
8. Click OK to add the report to the Registered Reports folder in the Electrical Index.
9. Double-click the report in the Registered Reports folder.
10. Edit the report as needed and add your free text in the data sheet.
You can add free text only in those cells that do not hold macros or template
headers.
11. Do the following in Microsoft Excel to save the free text that you entered in the data sheet:
a. Click the Add-Ins tab.
b. Click Retain Free Text on the SmartPlant Reports toolbar.
12. Save the report before closing the data sheet.

Associate an Electrical Item with a Registered Report


1. Define a document reference for the registered report that you want to associate. For details,
see Define an External Document Reference (on page 369).
2. In the Electrical Index, select an electrical item.

3.
4.

5.
6.
7.

You can also associate multiple electrical items with the same registered report. In the
Electrical Index, click a folder that contains electrical items and highlight in the list view pane
the items that you require.
Click Actions > Associate Document.
On the Associate Documents dialog box, under Filter by, under Document category,
select Electrical Documents. This selection determines the available options in the
Document type list. You can define and customize document categories in the Data
Dictionary Manager.
From the Document type list, select System Reports.
Click Add.
On the Find dialog box, click Find Now to display the available documents.

The Find dialog box finds only those documents that belong to the document category
and type that you select on the Associate Documents dialog box.
8. Select each document that you want to associate with the selected item and then click Apply.
To associate documents belonging to another category or type, return to the Associate
Documents dialog box, select the desired document category and type, click Associate again,
and repeat the succeeding steps in this procedure.

394

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical

Creating and Editing Report Templates


The tasks in this section deal with the creation and management of report templates.
You can create blank templates or you can base them on an existing one. The software allows you
to define the template headers, the content section, and define the report layout of tabular,
composite, or fixed format templates.

Display the Properties of a Report Template


You can inspect some of the properties that are currently in force for your template, such as the
report item type and the report format.
1. Click Reports > Edit.
2. Select a report from the Available reports list on the Edit Report Template dialog box.
3. Click Properties.

Create a New Blank Report Template


You can define a new report template which is not based on a pre-existing template.
1. Click Reports > New.
2. On the New Report Template dialog box, select Blank from the Source template list.

You can create a new report template based on an existing template by specifying a
source template also. For more information, see Create a Report Template Based on an
Existing Template (on page 396).
Since delivered reports are all in tabular format, you must choose Blank if you want a
fixed or composite format report template. You can select Blank for a tabular format
report template, nonetheless.
3. In the Name box, type a meaningful name to describe the report template you are creating.
This entry is the name of your Microsoft Excel workbook. When you save the template,
the software appends .xls to the name.
4. In the Item type box, select an item type.
5. In the Report type box, choose template format.
These options are only available when you choose Blank from the Source template list.
6. In the Description box, type a description for the template.
7. If you want this template to be available at the plant-level, select the Add to plant reports
option.
You must have the appropriate permissions, granted in SmartPlant Engineering
Manager, to create plant-level report templates.
8. Click OK to create the template.
9. When the software gives you the option to edit your new template in Microsoft Excel, click OK
and define the layout and contents of the template. For more information about these
procedures, see the following topics:
Define the Layout of a Tabular Format Report Template (on page 400)
Define the Layout of a Fixed Format Report Template (on page 402)
Define the Layout of a Composite Format Report Template (on page 402)
Define the Contents of Your Report Template (on page 398)

SmartPlant Electrical User's Guide

395

Reports in SmartPlant Electrical


When creating a new report template, the software saves the file in the format that depends
on the installed version of Excel: .xlsm for Excel 2007 and .xls for earlier versions of Excel.

Create a Report Template Based on an Existing Template


You can define a new report template by using another template as a source.
1. Click Reports > New.
2. On the New Report Template dialog box, select an existing template from the Source
template list.

3.
4.
5.
6.

In the list, the software displays all report templates with unique names. If templates
with the same name exist having .xlsm and .xls formats, the software displays only one of
these templates in the format that depends on the installed version of Excel: .xlsm for Excel
2007 and .xls for earlier versions of Excel.
In the Name box, type a name for the new report template.
In the Description box, type a description for the new report template.
Click OK.
When the software gives you the option to edit your template, click OK to open Microsoft
Excel and define the contents and layout of your report. For more information about these
procedures, see the following topics:
Define the Layout of a Tabular Format Report Template (on page 400)
Define the Layout of a Fixed Format Report Template (on page 402)
Define the Layout of a Composite Format Report Template (on page 402)
Define the Contents of Your Report Template (on page 398)

Edit a Report Template


You must have the correct privileges, granted in SmartPlant Engineering Manager,
to be able to edit a report template.
1. Click Reports > Edit.
2. On the Edit Report Template dialog box, select a report from the Available reports list.
In the list, the software displays all report templates with unique names. If templates
with the same name exist having .xlsm and .xls formats, the software displays only one of
these templates in the format that depends on the installed version of Excel: .xlsm for Excel
2007 and .xls for earlier versions of Excel.
3. Click Properties on the Edit Report Template dialog box in order to edit template properties
on the Report Properties dialog box.
Because you are modifying a template that already is defined, changing the Report type
option and the description are the only available actions on the Report Properties dialog box.
4. Click Open on the Edit Report Template dialog box to display the report in Microsoft Excel so
that you can edit the layout and contents of your report template. For more information about
these procedures, see the following topics:
Define the Layout of a Tabular Format Report Template (on page 400)
Define the Layout of a Fixed Format Report Template (on page 402)
Define the Layout of a Composite Format Report Template (on page 402)
Define the Contents of Your Report Template (on page 398)

396

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


If the SmartPlant Reports toolbar is missing when editing report templates in Microsoft
Excel, then on the Excel menu bar, click Tools > Macro > Visual Basic Editor and do the
following:
1. Select View > Immediate Window.
2. Type Sheet1.Application.CommandBars("SmartPlant Reports").Delete in the Immediate
window.
3. Quit Excel, and the toolbar is displayed the next time a report is edited.

Define Report Headers


This procedure explains how to define the headers in your report template.
1. Click Reports > Edit.
2. On the Edit Report Template dialog box, select a report template.
3. Click Open.
4. In the Excel report template, select the cells for the report headers and type the header text in
the selected cells.
5. Select another cell for the report header.
6. In the Name Box, type the appropriate name for mapping the report header, for example:

If you are working with Excel 2007 or higher and your report template is based on
Excel Macro-Enabled Workbook (*.xlsm), you cannot use the words "BUS" and "PDB" as
column names because these words are reserved names in Microsoft Excel. If you need to
use these words as headers, we suggest that you add another character or a number to the
text, for example BUS1.
For more details about reserved words in Microsoft Excel, see
http://technet.microsoft.com/en-us/library/cc179188(office.12).aspx
(http://technet.microsoft.com/en-us/library/cc179188(office.12).aspx).
7. Press ENTER.
8. After adding all the desired data, save the Excel template.

To include the properties of a document in your report, add the following macro to the
template:
d_attribute name (For example: d_ItemTag or d_Description)
You can add plant and plant group column headers to your templates. Use the following
macros to show plant and plant group names. Note that all macro names are case-sensitive:
Plant.Name
Area.Name
Unit.Name
Unit.<custom property>
You can use custom properties to add client information.

SmartPlant Electrical User's Guide

397

Reports in SmartPlant Electrical

For project and contractor information, use the following:


Project.<PropertName>
Contractor.<PropertName>

Define the Contents of Your Report Template


You can edit your report template in Microsoft Excel and specify what item properties are available
for you to report on.
1. In Microsoft Excel, click Define on the SmartPlant Reports toolbar.
2. If you want to add a new report item type so that its properties will be available to map onto
your report template, select the node in the Report on hierarchy under which you want the
new item type to appear. Click New.

When you click New on the Define Report Contents dialog box, you can choose from
only those items which are related to the item you selected in the Report on hierarchy.
The highest node in the Report on hierarchy that you can add a new item under is the
node that belongs to the report item type that you base your template definition on. You
can add items under any nodes subordinate to the main report item type as long as they
have items related to them.
Using the New command skillfully allows you to navigate in all directions in the plant
hierarchy and gather properties from throughout the plant database.
3. On the New Items dialog box (on page 782), select the new item you want to add to the
hierarchy.
4. You can change the name of the item that is displayed in the hierarchy by typing your choice
in the Name Box.
If the item you choose has the same name as an item elsewhere in the hierarchy, you
must type a different name for it in the Name box.
5. Click Apply.
6. When you have added all the items you want from this list, click Close.
If you want to add more new items under another node in the hierarchy, choose that
node and repeat steps 2 through 5.
7. On the Define Report Contents dialog box, select an item whose properties you want to be
available for your report template.
8. Click Define.
9. On the Properties tab of the Define Report Items dialog box, choose the properties that you
want to be available to map to your report template.

If you want to sort the order in which your items are listed when you generate a report,
choose the property or properties to sort on by using the Sort tab.
If you want to change the filter that finds your report items, use the Filter tab. For instance,
you may want to change from a filter that displays all pumps to using a filter that displays
only active pumps.
10. Click OK. The Define Report Contents dialog box remains open, and so you can repeat
steps 2 through 9 to continue adding more items and specifying their properties.

398

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


11. When you have chosen all the properties you want in your report, click OK on the Define
Report Contents dialog box.

All the properties you have specified to be available to map into your template are now
displayed when you click Map Properties on the SmartPlant Reports toolbar. Now you can
use the properties you have specified in the layout of your template.
To include the properties of a document in your report, add the following macro to the
template:
d_attribute name (For example: d_ItemTag or d_Description)
You can add plant and plant group column headers to your templates. Use the following
macros to show plant and plant group names. Note that all macro names are case sensitive:
Plant.Name
Area.Name
Unit.Name
Unit.<custom property>
You can use custom properties to add client information.
For project and contractor information, use the following:
Project.<PropertName>
Contractor.<PropertName>

Show Values and Short Values in a Report


If your report includes select list properties, you can instruct the software to display these
properties as they appear under Values in the Data Dictionary, as short text (as defined under
Short Values in the Data Dictionary), or both. You can display both definitions in your report and
have a column for Values and another column for Short Values if needed.
1. In SmartPlant Electrical, click Reports > New.
2. On the New Reports Template dialog box, select Blank from the Source template list.
3. Type a name for the new report.
4. Select an item type that the report will be based on.
5. Select a report type and add the report to plant reports if needed.
6. Click OK and then click Yes when prompted to edit the report.
7. In Microsoft Excel, click
on the SmartPlant Reports toolbar.
8. On the Define Report Contents dialog box, select the item type for the new report and click
Define.
9. On the Define Report Item dialog box, select the appropriate properties that you want to
include in your report. Make sure that you select the properties that belong to the select list
type data. (For more details, see steps 9 and 10 of the Define the Contents of Your Report
Template (on page 398) procedure.)
10. Make sure that the Use short text check box is not selected.
You can also display the index values. To do so, select the Use select list index
check box.
11. Click OK to return to Microsoft Excel.
12. Define the columns for your report as needed.
13. If you want to display Short Values in addition to the Values of select list properties in your
report, add a new column for the Short Value.

SmartPlant Electrical User's Guide

399

Reports in SmartPlant Electrical


14. Type the column headers for the Short Values and Values as needed.

15.

16.
17.
18.

19.
20.

The column header for Value and Short Value can be any text. For example, Long
Manufacturer or Short Manufacturer.
For the property column header that will display the Short value, type a name in the Name
Box of Microsoft Excel as shown below:
ShortValue_[property name]
For example:
ShortValue_Manufacturer
Save the report.
To activate this functionality, edit your Excel report.
In the Microsoft Excel, do one of the following:
Press Alt+F11.
Click View and then Macros > View Macros.
On the Macros dialog box, click Edit.
At the top of "ThisWorkBook" sheet code, type the following code:
Public m_objXLAgent As Object

21. In the BeginReport() function, type the following row:


Set m_objXLAgent = vParam
22. In the FinalReport() function, type the following row:
Call m_objXLAgent.UpdateShortValuesForExcel (me)
23. Save the report.

Define the Layout of a Tabular Format Report Template


You can edit your tabular format report template in Microsoft Excel and specify how the labels and
data are displayed.
1. On the SmartPlant Reports toolbar, click Options.
2. On the Options dialog box, choose the size of your report header.

The header is part of the tabular format report template where data is not mapped based
on rows. That is, you are free to type a label and map report item properties anywhere in
the lines that you designate for your header.
The header is a good place to put information that applies to all the items in your report,
such as Unit or Plant Name.
Also, you can add graphics in your report header.
Be sure to include space in your header for the labels of your columns.
3. Choose the number of empty lines that you want between rows in your report. Each row is
filled with properties for one item.
Some report templates, for example some Line List reports, designate two rows of data
for each report item and then an empty row.

400

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


4. If you want to sort the map properties, under 'Map Properties' sort order, click Ascending or
Descending.

5.
6.
7.
8.

When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have
sub-properties, sorted alphabetically.
For a summary report, the list entry Report Item Group Total that appears at the lowest
level is always at the bottom of the list, regardless of the sort order selected.
Click OK to close the Options dialog box.
Complete general labels and graphics, if needed, in your header.
Complete column headings in the last row of your header.
Select a cell in your report template where you want to map a particular property.

This cell can be either in the body of the report or in the header.
9. Choose the property that you want to map to your cell from the Map Properties menu. The
items on this menu are chosen when you define the contents of your template. For more
information, see Define the Contents of Your Report Template.

You only have to map properties for one item. Properties for all the items follow the format
you map for the first one.
Only one property can be mapped to a given cell, although the same property can be
mapped to more than one cell.
10. Repeat the previous steps until you have mapped all the properties that you want to map on
this report template.
11. Save the template and quit Microsoft Excel.

Because the delivered report templates have a tabular format, if you create a template based
on an existing template, the format of your report template is also tabular. Select Blank as
your source template if you want to create a fixed or composite format report template.
The location of plant-level report templates is specified in Options Manager. The location for
user-level templates is defined on the Files tab of the Options dialog box (Tools > Options).
When you add any property value in the header, a new Microsoft Excel worksheet is created,
and the header is saved on the new sheet because the entire header no longer fits in the
space allotted on the first sheet. You can customize the number of rows in the report header
by using the Options command on the SmartPlant Reports toolbar and choosing a larger
value in the Rows in report header option in the Options dialog box.

SmartPlant Electrical User's Guide

401

Reports in SmartPlant Electrical

Define the Layout of a Fixed Format Report Template


You can edit your fixed format report template in Microsoft Excel and specify how the labels and
data are displayed.
1. Choose a cell on your Microsoft Excel worksheet and type labeling information into it.
A label is not a required feature of a fixed format report template. You can simply map
properties to cells without any labeling if you want.
2. Choose a cell where you want the property associated with the labeling to appear.
3. On the SmartPlant Reports toolbar, click Map Properties and from the menu select the
property that you want to map to the cell you chose in the previous step.
The properties on the Map Properties menu are specified when you define the contents
of your report. For more information, see Define the Contents of Your Report Template.
4. Repeat the previous steps until you have labeled and mapped all the needed report item
properties to the corresponding locations in your template. When you generate a fixed format
report, the data for each report item appears in its own worksheet, and the layout for each
worksheet matches the layout defined for the first worksheet.
You use the Options command on the SmartPlant Reports toolbar to designate space for
your header and to specify the number of blank lines that you want between rows of data on your
report. The Options command is not available for fixed format report templates because you are
free to place headers and data anywhere on your worksheet.

Define the Layout of a Composite Format Report Template


You can edit your composite format report template in Microsoft Excel and specify how the labels
and data are displayed.
1. Define the layout of the first Microsoft Excel worksheet. In a composite format report template,
the first worksheet automatically uses the fixed format. For more information about defining
fixed format report templates, see Define the Layout of a Fixed Format Report Template (on
page 402).

Each item in the report has its own page. The properties of the first item are displayed on
the first worksheet, but the properties for subsequent items in the report are displayed
starting with the third sheet because the second worksheet is tabular format.
On the SmartPlant Reports toolbar, you use the Options command to designate space
for your header and to specify the number of blank lines that you want between rows of
data on your report. The Options command is not available for fixed format report
templates because you are free to place headers and data anywhere you want to on your
worksheet; however, the Options command is available for you to use in the tabular
portion of the composite report template.
2. Define the layout of the second Microsoft Excel worksheet. In a composite format report
template, the second worksheet is automatically tabular format. For more information about
defining tabular format report templates, see Define the Layout of a Tabular Format Report
Template (on page 400).

402

SmartPlant Electrical User's Guide

Reports in SmartPlant Electrical


3. After you have defined the layout for the first and second worksheets in your report template,
save the template and quit Excel.

You can map only one property into a given cell, although you can map the same property to
more than one cell.
When you add any property value in the header, a new Microsoft Excel worksheet is created,
and the header is saved on the new sheet because the entire header no longer fits in the
space allotted on the first sheet. You can customize the number of rows in the report header
by using the Options command on the SmartPlant Reports toolbar and choosing a larger
value in the Rows in report header option.

Delete a Report Template


You must have the correct privileges, granted in SmartPlant Engineering Manager,
to be able to delete a report template.
1. Click Reports > Delete on the main menu bar.
2. On the Delete Report Template dialog box, select a report from the Available reports list.
In the list, the software displays all report templates with unique names. If templates
with the same name exist having .xlsm and .xls formats, the software displays only one of
these templates in the format that depends on the installed version of Excel: .xlsm for Excel
2007 and .xls for earlier versions of Excel.
3. Click OK to delete the report template.
4. Click Close.

SmartPlant Electrical User's Guide

403

SECTION 27

Using KKS Naming Conventions in


SmartPlant Electrical
SmartPlant Electrical supports KKS naming conventions for process-related identification of the
following item types:
PDBs
Circuits
Loads
Converting equipment
Disconnect electrical equipment
Signal runs
Panels (control stations, cabinets, junction boxes, local panels)
Cables
In addition, the software supports point of installation identification for buses and cells.
For each of these item types, the following KKS segment properties are available:
KKS Level Name

Property

Description

Total Plant

Total Plant

Single character (numeric or alphabetic).

System Code

System Code Prefix


(optional)

Single digit.

System Classification

Three-character alphabetic key,


selected from a standard list, that
represents the type of system in use the
plant.

System Numbering

Two-digit number with leading zeros.

Equipment Unit
Classification

Two-character alphabetic key, selected


from a standard list, that represents the
type of equipment within the system
used for measuring or monitoring the
system, or the type of measurement
circuit (level, flow, and so forth).

Equipment Unit Numbering

Three-digit number with leading zeros.

Equipment Unit Additional


Code

Optional character (alphabetic) used for


special cases such as a thermocouple
with dual elements.

Component Classification

Two-character alphabetic key, selected


from a standard list, that represents the
type of component.

Component Numbering

Two-digit number with leading zeros.

Equipment Unit
Code

Component Code

SmartPlant Electrical User's Guide

405

Using KKS Naming Conventions in SmartPlant Electrical


KKS Level Name

Property

Description

Numbering
Element (for
cables only)

Tag Sequence Number (non- Four-character numeric or alphabetic


KKS)
value representing the unique
numbering of a particular cable.

Examples
For a switchgear or PDB, only the System Code segments are required in most cases. Thus a
suitable KKS name for a medium voltage PDB would be '1 0BBA01', where the values are
designated as follows:
Property

Value

Total Plant

System Code Prefix

System Classification

BBA

System Numbering

01

Description

BBA MV distribution board

Equipment Unit Classification (Not used)


Equipment Unit Numbering

(Not used)

For a motor, the KKS identification '1 0PAC01 AP001B M01' could be used, where the values are
designated as follows:
Property

Value

Total Plant

System Code Prefix

System Classification

PAC

System Numbering

01

Equipment Unit Classification AP


Equipment Unit Numbering

001

Component Classification

-M

Component Numbering

01

406

Description

Circulating (main cooling) water


pump system

Pump units

Motors

When making electrical associations, KKS naming is propagated between certain items. For
a complete list of propagation rules, see Propagation of KKS Names in SmartPlant Electrical
(on page 416).
You can change the terminology of a key on a project-specific basis provided that the contents
remain unchanged. Make sure that you do not select a code that is designated as Blocked.
Blocked coding letters are reserved for future technologies and new systems engineering
configurations. They may only be allocated and released by the VGB Technical Committee
on Technical Classification Systems.

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


Two methods are available for defining a new SmartPlant Electrical plant that works in KKS mode.
Create a plant in SmartPlant Engineering Manager using a default data dictionary template (a
.ddt file) and then import the KKS metadata. For details, see Creating a KKS Plant Using a
Default DDT File (on page 407).
Create a KKS plant in SmartPlant Engineering Manager using a supplied KKS dictionary
template (a .ddt file). For details, see Creating a KKS Plant Using a Supplied DDT File (on
page 409).
When you create a SmartPlant Electrical plant in SmartPlant Engineering Manager, the software
creates an empty plant which does not work in KKS mode. In order to be able to work in KKS
mode, you need to import the reference KKS metadata. This will enable you to work in KKS mode
using your own data dictionary template.
After importing the KKS metadata, you can configure the KKS naming conventions using rules or
hard-coded tag propagation. Note that it is also possible to use KKS mode in an existing plant.
For more information, see Create a KKS Plant Using a Default DDT File (on page 407).

Create a KKS Plant Using a Default DDT File


1. Create a new SmartPlant Electrical plant in SmartPlant Engineering Manager.
2. Do one of the following:
Download the KKSMetaData.mdb and ReferenceData.xml files from the following
location:
http://engineeringdata.intergraph.com (http://engineeringdata.intergraph.com/)
On the webpage, from the By Standard list, select KKS and save both files in the same
folder.
From the KKS zip file, extract the KKSMetaData.mdb and ReferenceData.xml files into
the same folder.
3. In SmartPlant Electrical Options Manager, click Options > Reference Data Import.
4. On the Reference Data Import dialog box, click Browse and navigate to the
ReferenceData.xml file which you extracted from the KKS zip file.
5. Click OK.
6. On the Reference Data Import dialog box, select the check box assigned to KKS Meta Data
Reference Data Type.
7. Click Import.
8. In Options Manager, in the Item Types window, for each item type where you require KKS
naming, define an appropriate plant group type and an item type uniqueness level.
For each item type where you require KKS naming, you can specify an appropriate
default value for the Component Classification property in the Project-Wide Parameters
window. Click Options > Project- Wide Parameters and select the desired plant group and
for each item type where you require KKS naming.
9. In Options Manager define the required naming conventions for each item type where you
need KKS naming.

SmartPlant Electrical User's Guide

407

Using KKS Naming Conventions in SmartPlant Electrical


10. An example of a KKS naming convention for a motor:

11. In Options Manager, on the General Settings page, under KKS mode, do one of the
following:
Select Yes to configure the KKS naming conventions using hard-coded tag
propagation. This completes the KKS mode configuration using hard-coded tag
propagation. Note that using the hard-coded tag propagation, the software does not
propagate properties of non-KKS segments.
Select No to configure the KKS naming conventions using copy rules. Selecting No
cancels the hard-coded tag propagation and you have to define your own tag propagation
by creating copy rules for each type of tag propagation in your project. Also, you need to
define a naming convention for each item type that requires KKS naming.

408

You can use the sample KKS_SAMPLE_SPELRules.rul file to see an example of rules that
copy KKS properties from a load to its metering equipment. To see the sample rules, extract
the KKS_SAMPLE_SPELRules.rul file from the KKS zip file into your SmartPlant Electrical
Reference data folder.
To preserve name uniqueness of KKS select list values (KKS key descriptors), the non-unique
value names end in suffixes denoted as their short values.

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


An example of a KKS copy rule:

Creating a KKS Plant Using a Supplied DDT File


When you create a SmartPlant Electrical plant based on a supplied KKS data dictionary template
file, the software creates an empty plant which includes KKS definitions. These definitions
include standard KKS select list items and predefined naming conventions.
Note that creating a plant based on this .ddt file, the software will create a plant with a
Plant-Area-Unit breakdown hierarchy structure. Also note that the supplied .ddt file is
version-dependent and you cannot use a .ddt file from another version.
Two methods are available for configuring SmartPlant Electrical to work in KKS mode:
Configuring SmartPlant Electrical for KKS mode using hard-coded tag propagation. For
details, see Configure SmartPlant Electrical for KKS Mode Using Hard-Coded Tag
Propagation (on page 409).
Configuring SmartPlant Electrical for KKS using rules. For details, see Configure SmartPlant
Electrical for KKS Using Rules (on page 413).
1. Download the SmartPlant Engineering Manager KKS upgrade files. These include the
KKS_R1_SPEL.ddt file, which you should place in the Templates folder.
2. Create a new plant for use with KKS naming.
3. Expand the tree view for your newly-created plant and right-click the Applications folder.
4. On the shortcut menu, click Associate Applications.

SmartPlant Electrical User's Guide

409

Using KKS Naming Conventions in SmartPlant Electrical


5. On the first wizard page, under Applications to associate, select the SmartPlant Electrical
check box and in the SmartPlant Electrical reference data path box, type the folder path or
use the ellipsis button

to navigate to the path.

6. Click Next.

410

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


7. On the second wizard page, under Data dictionary source, click Use custom template, and
in the Template path box, type the folder path or use the ellipsis button
the KKS_R1_SPEL.ddt file.

8.
9.
10.
11.

to navigate to

Add roles to the plant as desired.


Start SmartPlant Electrical Options Manager.
Click Options > General Settings.
In the General Settings window, for the KKS mode option, select Yes.

Selecting this option activates propagation of KKS names.


12. Click Options > Project-Wide Parameters.

SmartPlant Electrical User's Guide

411

Using KKS Naming Conventions in SmartPlant Electrical


13. In the Project-Wide Parameters window, select the desired plant group and for each item
type where you require KKS naming, specify an appropriate default value for the Component
Classification property.
14. Click Options > Naming Conventions > Copy for Plant Group.
15. Select Copy from reference data and select the desired source and target plant groups.
To preview the naming conventions in the reference plant group that you copied to your
plant, click Options > Naming Conventions > View in Reference Data.
16. Click Options > Naming Conventions > Define.
17. On the Define Naming Conventions dialog box, modify the naming conventions for each
item type as desired.
The Define Naming Conventions dialog box opens with the KKS naming conventions
already selected by default. You can delete segment properties that you do not require or
add freeform properties in addition to the KKS segments; however, note that in this KKS
mode, SmartPlant Electrical does not propagate properties of non-KKS segments.
To preserve name uniqueness of KKS select list values (KKS key descriptors), the
non-unique value names end in suffixes denoted as their short values.

412

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


An example of a KKS naming convention for a motor:

When propagating KKS naming, the software copies the naming from the source item
segments to the appropriate target item segments. For this reason, in the naming convention of a
target item, you should not delete segments that are likely to receive values by
propagation. Non-relevant segments in the target item are left blank. For a complete list of
propagation rules, see Propagation of KKS Names in SmartPlant Electrical (on page 416).
1. Download the SmartPlant Engineering Manager KKS upgrade files. These include the
KKS_R1_SPEL.ddt and KKS_Sample_SPELRules.rul files.
2. Place the KKS_R1_SPEL.ddt file in the Templates folder and the
KKS_Sample_SPELRules.rul file in the Reference Data folder.
3. Create a new plant for use with KKS naming.
4. Expand the tree view for your newly-created plant and right-click the Applications folder.
5. On the shortcut menu, click Associate Applications.

SmartPlant Electrical User's Guide

413

Using KKS Naming Conventions in SmartPlant Electrical


6. On the first wizard page, under Applications to associate, select the SmartPlant Electrical
check box and in the SmartPlant Electrical reference data path box, type the folder path or
use the ellipsis button

to navigate to the path.

7. Click Next.
8. On the second wizard page, under Data dictionary source, click Use custom template, and

9.
10.
11.
12.

in the Template path box, type the folder path or use the ellipsis button
the KKS_R1_SPEL.ddt file.
Add roles to the plant as desired.
Start SmartPlant Electrical Options Manager.
Click Options > General Settings.
In the General Settings window, for the KKS mode option, select No.

to navigate to

Selecting No cancels the hard-coded tag propagation and you have to define your own
tag propagation by creating copy rules for each type of tag propagation in your project.
You can use the sample KKS_SAMPLE_SPELRules.rul file to see an example of rules
that copy KKS properties from a load to its metering equipment. To see the sample rules,
extract the KKS_SAMPLE_SPELRules.rul file from the KKS zip file into your SmartPlant
Electrical Reference Data folder.
For each item type where you require KKS naming, you can specify an appropriate default
value for the Component Classification property in the Project-Wide Parameters
window. Click Options > Project- Wide Parameters and select the desired plant group
and for each item type where you require KKS naming.
13. Define your own naming conventions or copy the reference naming conventions.

414

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


14. To copy the reference naming conventions, click Options > Naming Conventions > Copy
for Plant Group.
15. Select Copy from reference data and select the desired source and target plant groups.
To preview the naming conventions in the reference plant group that you copied to your
plant, click Options > Naming Conventions > View in Reference Data.
16. Click Options > Naming Conventions > Define.
17. On the Define Naming Conventions dialog box, modify the naming conventions for each
item type as desired.

The Define Naming Conventions dialog box opens with the KKS naming conventions
already selected by default. You can delete segment properties that you do not require
or add freeform properties in addition to the KKS segments; however, note that in this
KKS mode, SmartPlant Electrical propagates properties based only on the set of
predefined copy rules.
To preserve name uniqueness of KKS select list values (KKS key descriptors), the
non-unique value names end in suffixes denoted as their short values.
An example of a KKS copy rule:

SmartPlant Electrical User's Guide

415

Using KKS Naming Conventions in SmartPlant Electrical

Propagation of KKS Names in SmartPlant Electrical


When an item, such as a motor, has KKS naming, and you make an electrical association, for
example to an MCC or a control station, the software automatically propagates the naming to the
associated item. The software also propagates naming when you create a hierarchy such as
PDB > Bus > Feeder in the Electrical Index and then rename the source item. The following table
shows how the software handles propagation, along with naming examples.
Target Item
Type

Inherited Components of
Target Item Name

Possible Source
Item Types

Bus

All populated segments of


PDB tag

PDB

Cell

All populated segments of


bus tag + number in group

Bus

Control station

KKS System and Equipment


Unit Codes

Feeder circuit
and internals

Load item tag + KKS


segments

Instrument

KKS System and Equipment


Unit Codes

Space heater

KKS motor naming + heater


component code, for
example: 1 0PAC01 AP01B
E01

Incomer circuit
and internals

Upstream power source KKS Upstream power


tag segments
source

Transformer
component

KKS System Code of


connected item + KKS
numeric segments for
secondaries, for example:
GT002, GT003

I/O signal

KKS System and Equipment Motor, feeder


Unit Codes + signal
circuit, control
application / origin code
station, instrument

Example of Source
Item Name

All loads

1 0PAC01 AP01B
E01 (heater)

Motor

1 0PAC01 AP01B
M01

Transformer (main GT
item)

For more details of how propagation works, see Examples of KKS Naming Propagation (on page
417).

416

The software performs propagation according to hard-coded rules. Name segments that are
not included in a propagation rule remain blank.
On connecting a cable side to a load or a panel, the KKS naming is propagated to the
cable. When both sides of a cable are connected, the naming comes from the first alphabetic
item. On disconnection, the cable retains the name it received by propagation until you
reconnect it.

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


This example shows how the software propagates naming when you associate a motor with a
control station to a PDB > Bus > Cell > Feeder hierarchy.

Example 1: Naming an item in an already created hierarchy


1. In the Electrical Index, create a hierarchy such as PDB > Bus > Cell > Feeder:

2. Rename the source item (PDB):

3. View the result in the Electrical Index:

4. Click Refresh

to update the display.

SmartPlant Electrical User's Guide

417

Using KKS Naming Conventions in SmartPlant Electrical


5. The software propagates the PDB naming to the bus and the cell as shown:

Note that the propagation does not continue to the Feeder circuit.

Example 2: Associating one item with another one by dragging


1. Create a new motor and assign it the following name:

2. Drag the motor from the Electrical Index and drop it on the target item (feeder circuit) in the
Electrical Engineer:

418

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical


3. The software propagates the motor naming to the feeder circuit as shown:

Example 3: Associating one or more items with another one by applying a profile
1. This example shows how naming is propagated when you add control stations to the motor by
applying a profile:

SmartPlant Electrical User's Guide

419

Using KKS Naming Conventions in SmartPlant Electrical


2. The software propagates the motor naming to the first control station as shown:

Adjust the naming of the target item tags manually if desired.


The current version of SmartPlant Electrical supports KKS naming conventions for
process-related identification of most electrical equipment items.

Out of Scope Issues


The following issues are not supported in the current development:
Operations in an integrated environment
Configuration rules for KKS establishments
Modification of the KKS classification keys
Copying KKS data from one plant group to another
Grouping of items hierarchically by a common physical system classification or equipment unit
Point of installation identification, other than for buses and cells
Location and connection identification

420

SmartPlant Electrical User's Guide

Using KKS Naming Conventions in SmartPlant Electrical

Signal identification (signal area, signal applications, and gated signals)


KKS naming conventions for cableways, cableway segments, and cable drums

The software does not automatically increment numbering properties of KKS segments.
When creating multiple items, the names of all the items, other than the first one, appear in the
interface as zeros, for example: '00000', even though KKS naming is actually applied to
them. In such cases, the user needs to rename the individual items by changing the
appropriate numbering segment, after which the software displays the item names correctly.
The software does not reset cable names when you disconnect one of the cable sides from an
associated item that originally propagated its naming to the cable.
Moving an item to a different level in the Electrical Engineer or changing item properties does
not affect the item name.
If you change the naming convention, it only affects new items. Existing items retain their
names according to the previous naming convention.
The software does not make any validations between the item type and the KKS code.
The software does not validate imported data.

1. Select an item and do one of the following:


On the item's Common Properties dialog box, beside Item tag, click the ellipsis button
.
Right-click the item and on the shortcut menu, click Rename.
2. Type appropriate values in each segment of the item tag.

Move the mouse pointer over a segment to display a Tool Tip indicating the name of the
segment.

Click the ellipsis button


beside a Classification segment to display the appropriate
Classification (on page 422)dialog box, from which you can select suitable values. If you
have already typed part of the key prior to clicking the ellipsis button, the Classification dialog
box opens at the appropriate place in the list.
When a numeric segment accepts more than one digit, if you enter fewer digits than the
maximum, the software automatically adds leading zeros to the value you typed. You cannot
remove the leading zeros from the segment.

SmartPlant Electrical User's Guide

421

Using KKS Naming Conventions in SmartPlant Electrical

The following is an example of a KKS tag name for a motor:

These dialog boxes allow you to select suitable classification keys when defining names of items
that use KKS naming conventions. The specific classification name depends on the segment that
you selected in the Item Tag dialog box.
Find key Allows you to type a 2- or 3-character code to drill down to an item in the Select key
list.
Select key Displays the set of available keys in a 2- or 3- level hierarchy. Click
to expand
the current portion of the hierarchy further and drill down until the full key appears in the Find key
field. You can hold the mouse pointer over longer values to display a Tool Tip showing the full
name. To select the key for the name segment, double-click the key or click the OK
command. Note that the OK command is only enabled when you select the appropriate level of
the hierarchy.

422

SmartPlant Electrical User's Guide

SECTION 28

SmartPlant Application Interfaces


SmartPlant Instrumentation Interface
The SmartPlant Instrumentation Interface allows you to exchange data between the two
applications using the following document types:
Power elements You initially define power supply requirements in SmartPlant Instrumentation
for tag numbers and for any panel type except for junction boxes and device panels. On
publishing the data from SmartPlant Instrumentation, SmartPlant Electrical uses the published
power supply data to create instruments from SmartPlant Instrumentation tag number data and
cabinets from panel data in SmartPlant Instrumentation. You can then publish the data and
retrieve it back to SmartPlant Instrumentation with SmartPlant Electrical PDB information.
Signals Signal data can originate in SmartPlant Electrical or in SmartPlant
Instrumentation. You can define signal data for generators, battery banks, converting equipment,
loads, control stations, any type of circuit, and disconnect equipment. On retrieving all
SmartPlant Electrical signals, SmartPlant Instrumentation creates special electrical tags, for which
you can perform wiring and I/O control system tag assignments. After the wiring is complete, you
can publish the data back to SmartPlant Electrical for further processing, and use it to display PLC
or other host I/O data in SmartPlant Electrical schematics.
Electrical Equipment You can publish electrical equipment such as motors and heaters, with
or without signals. For details of the procedure, see Publish Equipment from SmartPlant
Electrical (on page 445).

The documents published by the two applications do not contain the same properties. For
example, instrument and cabinet data includes power supply parameters such as rated
voltage, full load current, and so forth, which originate in SmartPlant
Instrumentation. However, SmartPlant Electrical only publishes PDB/Cell/Circuit
information. Similarly, SmartPlant Instrumentation publishes host data for signals that
originate in SmartPlant Electrical, but SmartPlant Electrical does not publish the host data
back to SmartPlant Instrumentation. For this reason, if, in SmartPlant Electrical, you change
data values that originated from SmartPlant Instrumentation, you should update those values
accordingly in SmartPlant Instrumentation, and vice versa.
If you publish signals in SmartPlant Electrical for circuits that feed items other than loads,
converting equipment, generators, battery banks, instruments, or cabinets, then on retrieving
the items in SmartPlant Instrumentation and running the tasks, SmartPlant Instrumentation
does not display the associated items.
Whenever you run tasks in the interface that create or update items in SmartPlant Electrical,
the software does not validate the data; however, you can select the items and perform batch
data validation (for details, see Fix Inconsistencies (on page 35)).

SmartPlant Electrical User's Guide

423

SmartPlant Application Interfaces

Prerequisites for Working with the SmartPlant


Instrumentation Interface
Before you can work with the SmartPlant Instrumentation Interface, do the following:
1. Install the latest version of the MSXML Parser prior to installing SmartPlant Electrical.
During SmartPlant Electrical installation, the software prompts you to install MSXML
Parser if it is not already installed on your computer.
2. Install the SmartPlant Schema Component from the SmartPlant Electrical CD Browser (click
Add-In Software, and then click Schema Component Installation).
On the Select Optional Features page, clear the Schema Editor check box if you do
not need to use the Schema Editor.
3. Install the SmartPlant Client from the SmartPlant Electrical CD Browser (click Add-In
Software, and then click SmartPlant Client Installation).
On the Select Features page, make sure that you clear the SmartPlant Automatic
Retrieval check box.
4. In SmartPlant Engineering Manager, set access rights for publish and retrieve to Full.
5. In SmartPlant Format Manager, set the accuracy or units of the following properties to be the
same as the corresponding properties in SmartPlant Instrumentation to ensure that there are
no mismatches when retrieving data into SmartPlant Electrical:
Property

Units or Accuracy Value

Instrument and cabinet rated power

kW

Rated active, reactive, and apparent


loads

kW, kVAr, kVA

Full load current and starting current

Coincidence factors x, y, z, zz and


power factors at 100%

Format = g3

6. In SmartPlant Engineering Manager, under Hierarchy Templates, set up a plant hierarchy


with an identical plant structure and with identical plant group names to the plant hierarchy
items in SmartPlant Instrumentation for which you are going to publish and retrieve data.
7. In SmartPlant Electrical Options Manager, under Item Types, select the following values for
the properties indicated:

424

Item Type

Plant group type

Item type uniqueness


level

Is unique (check
box)

Cabinet

Plant (or equivalent


highest level plant group)

Plant

Select

Instrument

Unit (or equivalent lowest Unit


level plant group)

Select

SignalRun

Unit (or equivalent lowest Unit


level plant group)

Select

SmartPlant Electrical User's Guide

SmartPlant Application Interfaces


8. In the SmartPlant Electrical program, publish the plant group data and structure (click
SmartPlant > Publish Plant Groups). This operation creates a file, Plant Groups.xml in the
folder of the current plant. SmartPlant Instrumentation uses the data in this file to map and
register the SmartPlant Electrical plant groups in the new SmartPlant Instrumentation domain.
Before working with the interface, ensure that the appropriate prerequisites are also met on
the SmartPlant Instrumentation side. For details, refer to the SmartPlant Instrumentation Online
Help topic: Prerequisites for Working with the SmartPlant Electrical Interface.

Mapping Plant Groups to SmartPlant Instrumentation


In SmartPlant Electrical Options Manager, you can determine for each item type the plant
hierarchy level to which that item type belongs, and at which level the item tags are defined as
being unique. In cases where uniqueness applies at a lower level than the entire plant, such as
per unit (or equivalent lower level plant group), it is possible for items with identical tags to exist in
different units. For example, you can have two motors in two different units, each of which has an
identical signal, JSM-100. If you then publish data for these signals for retrieval to the same
target unit, SmartPlant Instrumentation will not be able to distinguish between them and the data
does not get transferred correctly. Moreover, on transferring data back to SmartPlant Electrical,
the software cannot determine to which SmartPlant Electrical unit each set of data belongs.
To ensure that data published from SmartPlant Electrical is defined uniquely in SmartPlant
Instrumentation, you must define unique mapping between the plant groups in the two
applications. In this way, SmartPlant Instrumentation recognizes each SmartPlant Electrical item
as being unique.

Map Plant Groups to SmartPlant Instrumentation


1. In SmartPlant Engineering Manager, under Hierarchy Templates, set up a plant hierarchy with
an identical structure to the one in SmartPlant Instrumentation.
2. Create plant groups for SmartPlant Electrical with identical names to the plant hierarchy items
in SmartPlant Instrumentation for which you are going to publish and retrieve data.
3. In SmartPlant Electrical, click SmartPlant > Publish Plant Groups.
4. On the Publish to File dialog box, specify the folder in which to save the generated .xml files
by typing the path in the Folder to save XML files box.
5. In SmartPlant Instrumentation, log in to the default plant of the desired domain and retrieve
the published .xml file containing the SmartPlant Electrical plant group data and structure.
6. Run the generated tasks from the SmartPlant Instrumentation To Do List to create the target
plant hierarchy structure.

After you have defined the mapping between the source and target units (or equivalent lowest
level plant group) and you have transferred data to SmartPlant Instrumentation, you should
not change the target unit mapping definitions, because the data cannot be moved in
SmartPlant Instrumentation in certain cases (for example where no naming convention is
defined for the target unit).
You can create additional units in the SmartPlant Electrical plant group hierarchy if
needed. In this case, you must run the Publish Plant Groups command again to create
those units in SmartPlant Instrumentation and map them to the SmartPlant Electrical units.

SmartPlant Electrical User's Guide

425

SmartPlant Application Interfaces

Retrieve Data from the SmartPlant Instrumentation Interface


Follow these steps to retrieve data from SmartPlant Instrumentation:
1. Open SmartPlant Electrical.
2. Click SmartPlant > Retrieve.
3. On the Retrieve Document dialog box (on page 733), type the path to the folder where the
source .xml files containing the published data are located, or click Browse to navigate to the
folder.
4. From the Document list, select a document to retrieve.
The software automatically retrieves the appropriate .xml files associated with the
document that you select.
5. Click SmartPlant > To Do List.
6. On the To Do List dialog box, highlight one or more tasks (hold down CTRL for multiple
selection) and on the toolbar, click one of the following icons:

- Runs the selected tasks.

- Defers the selected tasks.

- Deletes the selected tasks.

- Displays the properties of the selected tasks.

The software retrieves data into the appropriate plant groups at various levels of the plant
hierarchy, regardless of the plant group that you are currently logged in to.
When you run a task that creates a new cabinet or instrument, the software changes the value
of the Override FLA calculation property to Manual to ensure that there is no inconsistency
between SmartPlant Electrical and SmartPlant Instrumentation for the values of the Full load
current property.
If you view the properties of a Create task, the destination item tag is the same as the source
item tag until you run the task. After you run the task, the destination item tag receives the
appropriate SmartPlant Electrical designation.
It is possible for SmartPlant Instrumentation users to delete items that originated from
SmartPlant Electrical, such as signals. In this case, when data is next published from
SmartPlant Instrumentation and retrieved into SmartPlant Electrical, the software creates
Delete tasks for those items on the To Do List dialog box. If you do not want those items to
be deleted from the SmartPlant Electrical database, you should click
from the To Do List dialog box.

426

to remove the task

SmartPlant Electrical User's Guide

SmartPlant Application Interfaces

Importing Cables from SmartPlant Instrumentation


Both SmartPlant Instrumentation and SmartPlant Electrical have their own cable libraries and
cable management features. Each of these applications manages its cables (instrumentation,
power, and control cables) differently. Oftentimes, cables that were created in SmartPlant
Instrumentation cannot be handled by SmartPlant Electrical although these cables are controlled
by the same control systems, routed in the same cable trays, and they serve the same equipment.
The software allows you to import SmartPlant Instrumentation cables and use all the available
cable management features of SmartPlant Electrical to handle the cables that were imported from
SmartPlant Instrumentation. You can carry out the following activities with the imported cables:
Design cable routing.
Create and edit cable block diagrams.
Effect drum assignment.
Publish cable routing to SmartPlant 3D.
Generate cable schedules.

To be able to import SmartPlant Instrumentation cables and manage them in SmartPlant


Electrical, you have to coordinate the reference cable libraries in both applications.
For sample cable import links, please contact SmartPlant Electrical support.
After importing SmartPlant Instrumentation cables, SmartPlant Electrical will indicate which
cables and equipment came from SmartPlant Instrumentation. You can distinguish
SmartPlant Instrumentation cables and equipment by using the SPIID property that is
available when filtering items and generating reports.

Synchronizing SmartPlant Instrumentation and SmartPlant


Electrical Reference Cables
SmartPlant Electrical requires all plant cables to be associated with reference cables. SmartPlant
Instrumentation, however, does not have such a requirement. In SmartPlant Instrumentation, the
functionality that can be comparable to SmartPlant Electrical reference cable is the cable type
property, which is a supporting table in SmartPlant Instrumentation.

SmartPlant Electrical User's Guide

427

SmartPlant Application Interfaces


Note that in SmartPlant Instrumentation, it is possible to set the software to work in the cable
dependency mode. This mode is set in the Administration module. This mode enables SmartPlant
Instrumentation to keep reference cables and plant cables consistent in terms of cable structure
and a few other properties. It is advisable that you work in this mode although it's not mandatory. If
you choose not to work in the cable dependency mode, there may be a number of discrepancies
between the plant cables and reference data. Also, SmartPlant Instrumentation users can create
new plant cables which will be without any reference cable. If you decide not to use the cable
dependency option, you can still set appropriate rules to make sure that a cable type is used and
that there is an association with reference cable.

As shown here, the SmartPlant Electrical equivalent of a reference cable is the SmartPlant
Instrumentation cable type property.

428

SmartPlant Electrical User's Guide

SmartPlant Application Interfaces


If you want to have SmartPlant Instrumentation cables in SmartPlant Electrical, create reference
instrumentation cables in the Reference Data Explorer. In most cases these cables are
instrumentation cables but this is not a limitation that will be imposed. Cables can also be control
or ground cables and in rare cases, power cables.

The software will import SmartPlant Instrumentation cables which do not have correlated
reference cables in SmartPlant Electrical (according to the cable-type). However, these cables will
not have conductors or any other cable specification since the definition of these cables is
incomplete.
Be aware that if you import cables that dont have a definite structure (that is, a number of sets and
conductors) and are not associated with a well-defined reference cable, at a later stage you will
not be able to synchronize the plant cables with the updated reference cable automatically. You
will have to do it manually, by using the Replace Cable command for each cable that you want to
synchronize or by doing it in batch mode.

SmartPlant Electrical User's Guide

429

SmartPlant Application Interfaces


One way to synchronize SmartPlant Instrumentation cable type list is to export SmartPlant
Electrical reference cables and to import the reference cable names into SmartPlant
Instrumentation cable type table.

Exporting SmartPlant Instrumentation Cables


SmartPlant Instrumentation utilizes a custom browser in order to export SmartPlant
Instrumentation cables. The software exports the data in the XLS format.
You have to create a new wiring browser view that includes the minimum data that is required for
the creation of cables in SmartPlant Electrical. You have to include the following data:
The cable names (including all the relevant KKS segments if working in KKS mode).
The cable types.
The item tag connected to the From side the panel_name or cmpnt_name to which the
cable is connected at its End 1.
The From description cmpnt_serv (if it is an instrument)
The From category the From panel/instrument category (instrument, device panel, junction
box, cabinet, DCS or PLC panel, and so on).
The To item tag the panel_name or cmpnt_name to which the cable is connected at its End
2.
The To description cmpnt_serv (if this is an instrument).
The To category the To instrument or panel category (instrument, device panel, junction
box, cabinet, DCS or PLC panel, and so on).
The pulling area.
The From item tag and the To item tag values reflect the cable destinations, that is an instrument
(cmpnt_name) or a panel (panel_name), depending on a particular case.
The destinations are included in the export so that SmartPlant Electrical is able to create them as
objects and add the relevant associations. The basic rules for these objects are:
For a device panel associated with a single instrument, the software retrieves the instrument
name.
If multiple instruments are associated with the same device panel and run in the same cable,
the software retrieves the first connected instrument.
SmartPlant Instrumentation also exports all the equipment that that is associated with the
cable ends regardless of whether this equipment is connected or not.

Importing Cables to SmartPlant Electrical


SmartPlant Electrical uses the Import Manager to import the SmartPlant Instrumentation cables
and the object with which the cables are associated (connected).
The following import links are shipped with the software in Import Manager for this purpose. You
can customize these links as you see fit.
Pulling area (select list)
Plant cables
Reference cable associations
Instruments (for cables that are associated with device panels)
Panels (various types)
End 1 cable association
End 2 cable association

430

SmartPlant Electrical User's Guide

SmartPlant Application Interfaces


The software does not import device panels that are not associated with instruments. If, at a later
stage, you associate a device panel with an instrument, you will have to run import again., Run the
following two links:
Instrument From Side (make sure that you select the Do not insert new records check box).
Instrument To Cable
For cables with multiple destinations on the same side: If a cable is connected to more than a one
panel on the same cable-end, the first destination panel name will be used. Since SmartPlant
Electrical does not support multiple cable destinations, you do not have to specify the other
destinations.
Note that the export file includes, in addition to the above data, the IDs of the panel, cable, and
instrument objects.

Importing the To and From Objects


When importing SmartPlant Instrumentation cables, the software also imports the objects that
connected to the To and From sides of the imported cables. The following table shows the
mapping of the imported objects from SmartPlant Instrumentation to SmartPlant Electrical.
SmartPlant Instrumentation

SmartPlant Electrical

Device panel (with an associated


instrument)

Instrument

Junction box

Junction box

Cabinet

Cabinet

DCS / PLC panel

Cabinet

Marshaling rack

Cabinet

The default plant break down system (plant - area - unit) for importing SmartPlant
Instrumentation cables and equipment is defined in the shipped links in Import Manager. The
default setting is that all the items will be imported on the highest plant hierarchy level. You can
customize this data by editing the shipped links as you require.

Workflow for Importing SmartPlant Instrumentation Cables


The following workflow describes the necessary steps that are needed to import SmartPlant
Instrumentation cables and their To and From equipment.

Do the following in SmartPlant Instrumentation:


1. Create a wiring browser view using the spi_cables. psr file that is shipped with SmartPlant
Instrumentation.
When defining the Powersoft Browser Settings dialog box in the SmartPlant
Instrumentation browser, select CABLE as the primary table.
2. Open the print preview of the new browser view and save it as Excel.
The name the Excel file must be SPIDomainCables.xls and you must save it in
the same location where SPI_Import.xml is stored.

SmartPlant Electrical User's Guide

431

SmartPlant Application Interfaces


Do the following in Microsoft Excel:

Open the SPIDomainCables.xls and define a name range for a range that starts at A1 and
includes the last cell in the PanelId2 column.
The name must be SPI_Cables.

Do the following in SmartPlant Electrical Import Manager:


1. In the left pane, under Link Groups, select the SPI_Import group and then select all the links
belonging to this group in the right pane.
2. Click Tools > Update Source Connection.
3. On the Data Link Properties dialog box, change the database name to SPI_Cables.xls and
make sure that the path points to the location where you saved the SPI_Cables.xls file.
4. Repeat steps 1 through 3 for the Ref. Cables group.
5. In the left pane, select all the links belonging to the Ref. Cables group and run import.
SmartPlant Instrumentation reference cables (called cable types in SmartPlant
Instrumentation) are imported into the SmartPlant Electrical cable list in order to create an
association between the reference and plant cables. Note that the import procedure only
imports the reference cable names without any other data. As a result, you must enter this
data manually so that the imported reference cables have all the required data (for example,
cable structure). If you decide to enter this data at a later stage and use these reference
cables to create plant cables, the software will create these plant cables without any sets or
conductors.
6. In the left pane, select all the links belonging to the SPI_Import group and run import.
For information how to create a browser view in SmartPlant Instrumentation and how to
define a name range in Microsoft Excel, refer to the pertinent topics in the documentation of
SmartPlant Instrumentation and Microsoft Excel.

432

SmartPlant Electrical User's Guide

SECTION 29

ETAP - SmartPlant Electrical


Bidirectional Interface
The ETAP - SmartPlant Electrical interface allows you to import ETAP data to SmartPlant
Electrical and export data to ETAP. When exporting data to ETAP you can publish single
electrical analysis SLDs or a complete set of all the existing electrical analysis SLDs in one set.
When retrieving ETAP data, you can retrieve a particular ETAP one-line diagram or publish all
project data to SmartPlant Electrical. (Note that this is an ETAP feature and the setting is defined
in ETAP.)
The interface is based on a fixed mapping file that is shipped with SmartPlant Electrical. This file
determines the mapping between the ETAP elements and various equipment types in SmartPlant
Electrical. ETAP users cannot modify the mapping of ETAP elements to SPEL item types.
However, it is possible to change the mapping of the properties in both SmartPlant Electrical and
ETAP and change the direction of the data propagation between the two applications.

Note the following limitations regarding publishing and retrieving parallel connections:
It is not possible to publish to ETAP electrical items that are connected in parallel. These
items will not be published at all.
When retrieving electrical items that are connected in parallel from ETAP, the software
creates a new bus in SmartPlant Electrical and connects these items to this bus using a
non-parallel connection.
When publishing junction boxes from SmartPlant Electrical to ETAP, ETAP retrieves these
items as bus nodes. When publishing these bus nodes back to SmartPlant Electrical, the
software identifies them as junction boxes. Note that the software disregards any existing
circuits in the junction boxes and publishes them as black boxes.

ETAP - SmartPlant Electrical Mapped Items


SmartPlant Electrical is shipped with a fixed default mapping of ETAP elements and SmartPlant
Electrical equipment. The table below shows this default mapping.
Note that in cases where the mapping is "many-to-one", you must define the type by specifying the
identifier that you select from the Equipment Type Identifier select list (shown here in
parentheses).
ETAP Element

SmartPlant Electrical Equipment

Bus

Bus

Cable

Cable

Capacitor

Capacitor

Charger

Battery charger

Contractor (ContractorType =
Contractor)

Contractor

SmartPlant Electrical User's Guide

433

ETAP - SmartPlant Electrical Bidirectional Interface

434

ETAP Element

SmartPlant Electrical Equipment

Contractor (ContractorType = Starter)

Starter

Current transformer

Current transformer

Fuse

Fuse

HVCB

Circuit breaker / High Voltage CB

In-line overload relay

Overload relay (In-line overload relay)

Induction motor

Generator (Induction Generator)

Lumped load

Other electrical equipment (Lumped load)

LVCB

Circuit breaker / Low Voltage CB

Motorized valve

Motor

Overload heater

Overload relay

Power grid

OffSite power

Reactor

Current limiting reactor

Recloser

Circuit breaker (recloser)

Single through switch

Disconnect switch

Static load (Load type = Resistor)

Resistor

Static load (Load type = Heater)

Heater

Static load (Load type = Trace)

Heat trace

Static load (Load type = Lighting)

Lighting fixture

Static load (Load type = Socket outlet)

Socket outlet

Static load (Load type = Welding outlet)

Welding outlet

Static load (Load type = Cabinet)

Cabinet

Static load (Load type = Instrument)

Instrument

Synchronous motor

Motor

SyncGenerator

Generator

Three-winding transformer

Three-winding transformer

Two-winding transformer

Two-winding transformer

Variable frequency drive

Variable frequency drive

SmartPlant Electrical User's Guide

ETAP - SmartPlant Electrical Bidirectional Interface

Unsupported Items
A number of items are not supported by the ETAP - SmartPlant Electrical interface. Publishing
an unsupported item can have the following possible results:
Items could be skipped or ignored in the importing application. After exporting these items
back to the original application, they may be deleted or become disconnected or dissociated
from their related items.
Inability to synchronize or update data.
Unexpected behavior.

Unsupported ETAP Items


The following ETAP items are not supported by the ETAP - SmartPlant Electrical interface:
Instrumentation
DC systems
Multi-function relays
Single-phase systems
Wind turbine generator
Transmission lines
MG sets
SVC
HVDC
Double through switches
Panels
Potential transformers
Inverters

Unsupported SmartPlant Electrical Items


The following SmartPlant Electrical items are not supported by the ETAP - SmartPlant Electrical
interface:
Junction boxes
When publishing junction boxes from SmartPlant Electrical to ETAP, ETAP retrieves
these items as bus nodes. When publishing these bus nodes back to SmartPlant
Electrical, the software identifies them as junction boxes. Note that the software
disregards any existing circuits in the junction boxes and publishes them as black boxes.
Local panels
Metering equipment (except for current transformers)
DC items
Single phase items
Other disconnect equipment
Potential transformers
Other converting equipment
Control stations (not exported at all)
Circuits (not exported at all)
Cells (not exported at all)
Power distribution boards (not exported at all)

SmartPlant Electrical User's Guide

435

ETAP - SmartPlant Electrical Bidirectional Interface

Preliminary Settings for ETAP


Prior to importing ETAP data or exporting SmartPlant Electrical data to ETAP, you have to define
a number of settings in SmartPlant Electrical Options Manager:
Define the ETAP Project Name (on page 436)
Map ETAP File Location (on page 436)
Import ETAP Mapping Data (on page 437)
Set the ETAP-SPEL Reference Cable Exchange File Location (on page 437)
Export SmartPlant Electrical Reference Cables (Power Cables) (on page 437)
Export SmartPlant Electrical Reference Cables (Cable Specifications) (on page 439)
Import ETAP Library Cables (on page 440)

Define the ETAP Project Name


Prior to working with the ETAP - SmartPlant Electrical interface, you have to define the name of
the ETAP project exactly as it appears in ETAP.
1. In Options Manager, click Options > General Settings.
2. In the General Settings window, to the right of Project name in external analyzing
software type the exact name of the project as it appears in ETAP.
3. Click Save

Map ETAP File Location


The mapping of SmartPlant Electrical item properties to ETAP item types is done in ETAP
Mapping Table. This information is stored in ETAP in an .mdb file and converted by SmartPlant
Electrical to an .xml file called ETAPSPELMapping.xml. SmartPlant Electrical provides a default
.xml file and you can change its default location if needed.
1. In Options Manager, click Options > Locations.
2. In the Locations window, to the left of the ETAP SmartPlant Electrical mapping file click
the ellipsis button
.
3. Navigate to the ETAPSPELMapping.xml file.
4. Click Save

436

SmartPlant Electrical User's Guide

ETAP - SmartPlant Electrical Bidirectional Interface

Import ETAP Mapping Data


One of the first things that you should do is to synchronize the mapping table of a specific ETAP
project with the SmartPlant Electrical mapping file. SmartPlant Electrical always checks the
compatibility of the mapping file when importing data from ETAP. In case of version
inconsistency, a warning message is displayed asking to import the latest mapping file from
ETAP.
1. In Options Manager, click Interfaces > ETAP > Build Mapping XML.
2. On the Build Mapping XML dialog box, navigate to the appropriate mapping .mdb file and
click Open.

This .mdb file is located in the ETAP home directory, under the specific project library >
DataEx_SPEL.
SmartPlant Electrical converts this .mdb file to ETAPSPELMapping.xml and overwrites
the file in the location specified in Option Manager under ETAP - SmartPlant Electrical
mapping file location.

Set the ETAP-SPEL Reference Cable Exchange File Location


SmartPlant Electrical and ETAP can exchange reference cable information so that cable libraries
become synchronized. SmartPlant Electrical provides a default exchange .mdb file and you can
use it or modify it as you see fit. The default location of this file is also set automatically in Options
Manager in the SmartPlant Electrical reference data library, under ETAP. However, you can
change this location if required.
1. In Options Manager, click Options > Locations.
2. In the Locations window, to the left of the ETAP - SPEL reference cable exchange file click
the ellipsis button
.
3. Do one of the following:
Navigate to the shipped default mdb file in the following location:
Program Files\SmartPlant\Electrical Reference Data\ETAP\ETAPSPELCableLib.mdb
Navigate to an appropriate .mdb file of your choice.
4. Click Save

Export SmartPlant Electrical Reference Cables (Power


Cables)
You can synchronize the SmartPlant Electrical reference cables with the ETAP cable library of a
particular ETAP project if you want to have a commonly shared cable library. This
synchronization is optional. If you do not synchronize the libraries, both applications function
independently of the cable library of the other application. However, if you synchronize the cable
libraries, each application will identify the reference cables that were specified by the other
application.
To effect this synchronization, you need to export your reference cables to ETAP and import
ETAP library cables to SmartPlant Electrical. The following procedure explains how to export
your reference cables by selecting the reference power cables from the entire list of all the existing
reference power cables.
1. On the Options Manager menu bar, click Interface > ETAP > Export Reference Cables.

SmartPlant Electrical User's Guide

437

ETAP - SmartPlant Electrical Bidirectional Interface


2. On the Reference Power Cable Selection Method page of the Export SmartPlant
Electrical Reference Cables wizard, select the All power cables option.
3. Click Next.
4. On the Reference Cable Selection page, select the reference power cables that you want to
export.
5. Click Finish.

438

The software exports the reference cables to the cable library file that you specified in Options
Manager and appends the new cables to the list of the existing cables in that library.
If you export reference cables that already exist in the cable library, the software ignores the
cables that have identical properties. The software exports only those cables whose
properties differ from the cables that already exist.
There are certain cable properties that must be defined for the reference cables prior to
exporting them. These properties form the ETAP cable headers and they are all mandatory
for ETAP. In addition to the properties required by SmartPlant Electrical to form reference
cables, you must define other properties that form the ETAP cable headers. Any reference
cable that lacks even one of these property definitions is rejected by the software after the
export process. The following properties must be defined before starting export:
Conductor Material
Frequency
Base Temperature
Installation
Insulation Material
Insulation Voltage Rating
kV Class
Length Unit of Measure
Number of Conductors
Source Name
Ta Base Above Ground
Ta Base Under Ground
Tc Base Above Ground
Tc Base Under Ground
Unit System
RHO
If you want to use SmartPlant Electrical cables in ETAP, you have to define all the electrical
properties that are required by ETAP. We recommend that you specify a distinct "source
name" for these cables so that they do not interfere with or override ETAP original library
cables.

SmartPlant Electrical User's Guide

ETAP - SmartPlant Electrical Bidirectional Interface

Export SmartPlant Electrical Reference Cables (Cable


Specifications)
You can synchronize the SmartPlant Electrical reference cables with the ETAP cable library of a
particular ETAP project if you want to have a commonly shared cable library. This
synchronization is optional. If you do not synchronize the libraries, both applications function
independently of the cable library of the other application. However, if you synchronize the cable
libraries, each application will identify the reference cables that were specified by the other
application.
To effect this synchronization, you need to export your reference cables to ETAP and import
ETAP library cables. This procedure explains how to export your reference cables by selecting
particular cable specifications.
1. On the Options Manager menu bar, click Interface > ETAP > Export Reference Cables.
2. On the Reference Power Cable Selection Method page of the Export SmartPlant
Electrical Reference Cables wizard, click the Power cables with selected cable
specifications option.
3. Under Cable specifications, select the appropriate specifications and click Add.
After clicking Next, the software will display a list of reference power cables that have the
cable specifications you select on this page.
4. Click Next.
5. On the Reference Cable Selection page, select the reference cables that you need.
6. Click Finish.

The software exports the reference cables to the cable library file that you specified in Options
Manager and appends the new cables to the list of the existing cables in that library.
If you export reference cables that already exist in the cable library, the software overwrites
the old cables with the newly exported cables.
There are certain cable properties that must be defined for the reference cables prior to
exporting them. These properties form the ETAP cable headers and they are all mandatory
for ETAP. In addition to the properties required by SmartPlant Electrical to form reference
cables, you must define other properties that form the ETAP cable headers. Any reference
cable that lacks even one of these property definitions is rejected by the software after the
export process. The following properties must be defined before starting export:
Conductor Material
Frequency
Base Temperature
Installation
Insulation Material
Insulation Voltage Rating
kV Class
Length Unit of Measure
Number of Conductors
Source Name
Ta Base Above Ground
Ta Base Under Ground

SmartPlant Electrical User's Guide

439

ETAP - SmartPlant Electrical Bidirectional Interface

Tc Base Above Ground


Tc Base Under Ground
Unit System
RHO
If you want to use SmartPlant Electrical cables in ETAP, you have to define all the electrical
properties that are required by ETAP. We recommend that you specify a distinct "source
name" for these cables so that they do not interfere with or override ETAP original library
cables.

Import ETAP Library Cables


You can synchronize the SmartPlant Electrical reference cables with the ETAP cable library of a
particular ETAP project if you want to have a commonly shared cable library. This
synchronization is optional. If you do not synchronize the libraries, both applications function
independently of the cable library of the other application. However, if you synchronize the cable
libraries, each application will identify the reference cables that were specified by the other
application.
To effect this synchronization, you need to import ETAP library cables and export your reference
cables to ETAP. This procedure explains how to import ETAP library cables.
ETAP exports project library cables to an .mdb file which is then used by SmartPlant
Electrical to effect the import.
1. On the Options Manager menu bar, click Interface > ETAP > Import Reference Cables.
2. On the Import ETAP Library Cables dialog box, click
and navigate to an ETAP .mdb file
that contains ETAP library cables.
3. Under Cable details, select the required cables, click Update Cable Specifications.

You must specify an appropriate cable specification for each ETAP library cable before
you import the cables to SmartPlant Electrical.
Make sure that before you start the import process, all the source names of the ETAP
library cables that you want to import have been added to the Source name select list in
the Data Dictionary.
4. On the Cable Specification dialog box, do one of the following:
Click the Select check box next to the cables that you want to import.
Click Select all to select all the cables in the Cable details data window.
5. Click OK to start the import process.

440

SmartPlant Electrical User's Guide

ETAP - SmartPlant Electrical Bidirectional Interface

Publish a Single SLD Drawing to ETAP (Partial


Publishing)
SmartPlant Electrical publishes single line diagrams to ETAP using electrical analysis SLDs.
After generating an electrical analysis SLD and saving it, ETAP will use its XML as the source for
import.
Note that publishing a single SLD to ETAP is called partial publishing. The XML that you create
by saving the SLD has this partial identifier. As a result, in ETAP there will be no indication of
deleted items after importing partial SLDs. To indicate that certain items have been deleted in
SmartPlant Electrical, use the full publishing method.
1. In SmartPlant Electrical, in the Electrical Engineer, select an appropriate item for which you
want to generate an electrical analysis SLD.
The item can be on any hierarchy level in the Electrical Engineer, for example a bus.
2. Right-click the item that you selected and then on the shortcut menu, click New SLD.
3. On the Single Line Diagram Options dialog box, in the SLD type group box, select
Electrical analysis SLD.
4. Click Generate.
5. Save the drawing.
6. In the Electrical Index, expand the Documents > Electrical Analysis SLDs hierarchy.
If you want to publish an existing SLD and make sure that you retain all the
changes made since the last time it was published, you must open this SLD and save it prior
to publishing. If you do not do that, the software will publish the updated items with
inappropriate coordinates. As a result, ETAP will position these SLD items in inappropriate
places on ETAP drawings.
7. Right-click the new SLD drawing and then on the shortcut menu, click Publish to External
Analyzing Tool.
8. On the Publish to External Analyzing Tool dialog box, save the drawing as an .xml file,
which will be used by ETAP as an import source.

Publish All Plant SLDs to ETAP (Full Publishing)


SmartPlant Electrical publishes single line diagrams to ETAP using electrical analysis SLDs.
After generating an electrical analysis SLD and saving it, ETAP will use its XML as the source for
import.
Full publishing of SLDs to ETAP is when you publish all the existing electrical analysis SLDs in a
single set of drawings. This set is identified as the complete SLD of the plant and it includes all
plant items that constitute the electrical analysis SLDs.
The full publishing method enables you to create an indication in ETAP of items that have been
deleted in SmartPlant Electrical. When ETAP imports a full xml, the software compares the items
that are included in the current session with the existing project as stored in the ETAP database
and deletes all the items that are not found in the full xml that was used for import.

The data transfer between SmartPlant Electrical and ETAP is based on the mapping table.
Only those properties that have been mapped with the appropriate mapping direction are
propagated from SmartPlant Electrical to ETAP. For more details, see ETAP - SmartPlant
Electrical Mapped Items (on page 433).

SmartPlant Electrical User's Guide

441

ETAP - SmartPlant Electrical Bidirectional Interface

If you want to publish existing SLDs and make sure that you retain all the changes made since
the last time these SLDs were published, you must open each SLD and save it prior to
publishing. If you do not do that, the software will publish the updated items with
inappropriate coordinates. As a result, ETAP will position these SLD items in inappropriate
places on ETAP drawings.
1. On the SmartPlant Electrical menu bar, click Tools > ETAP Interface > Publish All.
2. On the Publish to External Analyzing Tool dialog box, save the file as an .xml file, which will
be used by ETAP as an import source.

Retrieve ETAP Project Data


ETAP exports its project data in XML format. ETAP users can select all the project data or
specific items (see the documentation in ETAP on how to make this selection).
In order to preserve the electrical associations that exist in ETAP, before publishing
to SmartPlant Electrical, make sure that all the relevant electrical items are connected to a power
source in ETAP. The power source items themselves, however, need not be included in the
publish.
1. On the SmartPlant Electrical menu bar, click Tools > ETAP Interface > Retrieve.
2. Navigate to the appropriate ETAP project .xml file and click Open.

The retrieve process starts only if the ETAP project name specified in the selected .xml
file is the one specified in Options Manager. If the project name specified in Options
Manager is different from the one in the selected .xml file, the software rejects the retrieval
and displays a warning message.
The software checks the mapping table revision number, which is also part of the ETAP
project .xml file. If the mapping has been modified in ETAP and no new mapping has
been done, the software displays a warning. You can continue the retrieval if you want to
do so.
Once the retrieve is completed, it results in a To Do List action similar to the one used in
SmartPlant Electrical in integration. You can examine each task before committing the
whole action list to your SmartPlant Electrical database.
3. On the SmartPlant Electrical menu bar, click SmartPlant > To Do List.
4. In the To Do List window, double-click a task to check what data is going to be populated in
your database.
The following types of task can appear in the To Do List:
Create New items will be created in SmartPlant Electrical if the items are totally
new in SmartPlant Electrical. A new item in SmartPlant Electrical is an item that the
software cannot identify by its SmartPlant Electrical ID (SP_ID), ETAP IID, or
SmartPlant Electrical item tag. Note that if the retrieved item is a disconnect
equipment item, the software does not check for the item tag property.
Update Existing items will be updated if SmartPlant Electrical can identify them by
one of the properties mentioned above.
Delete Items deleted in ETAP will be deleted in SmartPlant Electrical. Note that
this type of task is only possible when performing a Full Retrieve from ETAP.
5. Select the tasks you want to run and click Run

442

SmartPlant Electrical User's Guide

SECTION 30

Publishing Data for Interfaces


Publish Data from SmartPlant Electrical
Follow these steps to publish data for SmartPlant Instrumentation. If you want to publish
electrical equipment, follow the separate procedure Publish Equipment from SmartPlant Electrical
(on page 445).
1. Prepare the data for the documents to publish by doing one or both of the following:
Create power-requiring cabinets or instruments by retrieving power elements from
SmartPlant Instrumentation and running the tasks on the To Do List for the retrieved
data. For details, see Retrieve Data from the SmartPlant Instrumentation Interface (on
page 426).
Create signals in SmartPlant Electrical for items that you want to associate with control
systems in SmartPlant Instrumentation. For details, see Working with Signals (on page
344).
2. Register a report template for each item type for which you want to publish data. For details,
see Register a Report (on page 391).

You can publish data for the following item types:


Cabinets owned by SmartPlant Instrumentation (the software identifies these using a
database flag).
Instruments owned by SmartPlant Instrumentation (the software identifies these using a
database flag).
Equipment (instruments and cabinets); the software does not publish other item types
specified under Equipment. You can define your own document for publishing
equipment data or you can use the shipped report, Instruments and Cabinets.xls, which
is located in the folder where you install SmartPlant Electrical Reference Data.
Electrical equipment, with or without I/O signals. You can define your own document for
publishing equipment data or you can use the shipped report, IO Signals and
Equipment.xls, which is located in the folder where you install SmartPlant Electrical
Reference Data.
SignalRun. You can define your own document for publishing I/O signal data or you can
use the shipped report, IO Signal List.xls, which is located in the folder where you install
SmartPlant Electrical Reference Data. You can apply a filter to limit the scope of the
signals to include, for example, only certain plant group types or certain I/O types.
When publishing data for item type Equipment, do not filter for cabinets or
instruments. You can however, define a filter that limits the scope of the plant group type
or the data subset.
Select an existing filter to define the scope of the data to publish. If you require, you can
register the same report template several times with different filters; however, each
registered report must have a unique name. (For details of how to create or modify a
filter, see Filter Manager Online Help.)
You must select the Enable document for publishing check box to ensure that the
software includes the data from the report in the generated .xml file when you publish from
SmartPlant Electrical.

SmartPlant Electrical User's Guide

443

Publishing Data for Interfaces


3. In the Electrical Index, expand the folder hierarchy Documents > Registered Reports.
Before publishing a document, you can specify its title and description by doing the
following:
1. Select the document

2. Enter values in the Properties window as shown:

These values will appear in the published .xml file.


4. Select one or more of the reports for which you have enabled publishing, and click
SmartPlant > Publish.
You can also right-click the document, and then click Publish.
5. If you are working in File mode, on the Publish to File dialog box, specify the folder in which
to save the generated .xml files by typing the path in the Folder to save XML files box and if
you require, change the default data file and meta file names.

444

SmartPlant Electrical User's Guide

Publishing Data for Interfaces

Publish Equipment from SmartPlant Electrical


Follow these steps to publish equipment with or without signals for SmartPlant Instrumentation.
1. Select an item of equipment such as a motor or heater, and if desired, add an I/O signal to it.
2. In the Properties window, display the Allow Publish Flag property and set its value to True.

3.
4.
5.
6.

Click the
Alphabetic toolbar button to display the properties alphabetically; the
Allow Publish Flag property appears at the top of the list.
Assign the equipment to a circuit and set the value of the Allow Publish Flag property of the
circuit to True.
Register a report for publishing as follows:
Click Actions > Register Report.
On the Register Report Common Properties dialog box, beside Report template, click
and select IO Signals and Equipment.

7. Beside Filter, click


8.
9.
10.
11.
12.
13.
14.
15.
16.
17.

and select Filters for Reports > EquipmentToPublish.

The EquipmentToPublish filter comes shipped with the software.


Type a name in the Document name field.
Ensure that the Enable document for publishing check box is selected.
In the Electrical Index, expand the folder hierarchy Documents > Registered Reports.
Right-click the document that you created and on the shortcut menu, click Open.
In the Registered Reports folder, right-click the document again, and on the shortcut menu,
click Document Properties.
On the Document Properties dialog box Revisions tab, click New.
On the SmartPlant Foundation Revise dialog box, beside Revision Scheme, select a value
from the list.
Under Revise in Tool, beside Major, select the value Next from the list.
Click OK to implement the revision.
Close the Revise and Document Properties dialog boxes.
Before publishing a document, you can specify its title and description by doing the
following:
1. Select the document

SmartPlant Electrical User's Guide

445

Publishing Data for Interfaces


2. Enter values in the Properties window as shown:

These values will appear in the published .xml file.


18. Click SmartPlant > Publish.
19. On the Publish dialog box, select one or more of the reports for which you have enabled
publishing, and click OK.
You can also right-click the document, and then click Publish.
20. If you are working in File mode, on the Publish to File dialog box, specify the folder in which
to save the generated .xml files by typing the path in the Folder to save XML files box and if
you require, change the default data file and meta file names.
If you publish an equipment item without a signal, you can create a signal (as an Electrical
Tag) and associate it in SmartPlant Instrumentation.

446

SmartPlant Electrical User's Guide

Publishing Data for Interfaces

Publishing Data to an External Analyzing Tool


In SmartPlant Electrical you can generate single line diagrams that allow you to publish the data
they contain to an electrical analysis application such as ETAP. When you set the SLD
generation options, you can specify the levels of the power distribution network for which the SLD
displays the data, and this, in turn, affects the published output data. The software generates an
.xml file in a format appropriate for ETAP, which you specify in the Options Manager. The data
transfer process is 'one-way', that is, from SmartPlant Electrical to the electrical analysis
application, according to the flow described in the following diagram:

After you publish the data from SmartPlant Electrical, ETAP has its own data exchange program
which enables the import and translation of the SmartPlant Electrical .xml file.

SmartPlant Electrical User's Guide

447

Publishing Data for Interfaces

448

SmartPlant Electrical User's Guide

SECTION 31

Project Management in SmartPlant


Electrical
SmartPlant Electrical supports owner operator and EPC activities with As-Built functionality. You
define the main plant as the As-Built and you can then add any number of additional plant groups
to create your projects. The Plant Administrator needs to activate the plant and scope it with the
particular As-Built. When you work with projects, the database is partitioned into several
schemas: a single schema for As-Built and separate schemas for projects. An operational plant
exists and most of the activities are concerned with routine maintenance or plant modernization
(revamp).
To facilitate plant modernization, the software enables you to create one or more projects using
existing electrical data for the operating plant as a starting point for plant modernization
(revamp). Each project is defined for one plant only, and a plant can have several associated
projects.
You can also use projects when working in SmartPlant environment.
It is strongly recommended that when working in a disconnected Project As-Built
mode, changes to meta data should be done in one source plant only and these changes have to
be propagated to all other targets. Failing to follow this process ( for example, modifying Data
Dictionary values in more than one plant) may result in the Reference Data Synchronization
Manager not being able to properly compare and synchronize the changes across the
source/target plants.
After merging project data with As-Built, you cannot reverse the process. For this reason, at all
stages of plant modernization, you should ensure that there is full coordination of engineering
activities between As-Built and projects to avoid inadvertent loss of data. It is also recommended
that you back-up your database before starting the projects.

You can work only in online mode that is, As-Built and projects must be connected to the
same database.
When working in a plant that is registered with SmartPlant, the software automatically
determines the project status in the database according to the SmartPlant project status.
To be able to view and edit data in As-Built, make sure that in the Options Manager, on the
General Settings page, Allow Full Access to As-Built is set to Yes.

SmartPlant Electrical User's Guide

449

Project Management in SmartPlant Electrical

Scoping the Project


The Plant Administrator must specify those plant groups from which it will be possible to scope
items. When the Plant Administrator specifies a plant group for scoping, the software includes in
the scoping all higher-level plant groups in the same branch as the selected plant group, for
example, if the plant groups are Plant-Area-Unit, and the Plant Administrator selects an area for
scoping, the plant above that area is also included in the scope. For more information, see
Engineering Manager User's Guide, Set Project Scope.

Understanding Statuses
A project status shows the stage of the project life-cycle. Possible project statuses are:
Active this is the initial state of a project right after its creation.
Completed shows that all the work on the project items has been completed and that the
items are ready to be merged back into As- Built. You cannot claim items in a project whose
status has been set to Completed or Merged.
In a project, when searching for completed items in the Project Management window,
it is now possible to select the related items which have not been completed yet and change
their status to Completed.
Merged shows that all the project items have been merged back into As-Built.
Canceled shows that the project has been canceled and it can be deleted. Selecting this
project status changes the status of the items in the project from Claimed to Scoped.
The status of an item in a project determines what you can do with the item, for example, editing
the properties in the project. Possible item statuses in the project are:
Scoped shows that the item becomes available for viewing in the project and it can be
claimed.
Claimed these are the scoped items that have been copied to the project and they are
enabled for editing. There are two modes of claiming:
Exclusive these items can only be edited in the current project and cannot be claimed for
another project.
Shared these items can be claimed for another project and edited in that project.
Completed shows that the work on the item has been completed and the item is ready to
be merged back into As-Built.
Merged shows that the item has been merged back into As-Built.
The Project Management table displays the status of claimed items.
To view the status of a claimed item in a project while in As- Built, right-click an item in the list view
pane of the Electrical Index and then click Item Status in Project. This command opens the
Item Status in Projects dialog box, which shows the item status, claim mode, and project name
for each project in which the selected item is claimed.

450

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Rules for Changing Statuses


The following general rules apply to the relationship between the project status and item status in
project:
1. To be able to scope items, the project status must be Active or Merged.
2. To be able to merge items, the item status in the project must be Completed.
3. You cannot re-scope an item (refresh the scope) if the item has already been claimed. You
have to change the status of the item to Scoped and then reclaim it.
4. To be able to merge a project, all the items of that project must have status Completed.
5. It is possible to set the status of a project to Completed in As-Built if all the status of all
claimed items is Completed.
6. In a project, it is possible to change the status of a project to Completed disregarding the
status of the items in project. This operation automatically sets the status of all the items in
the project to Completed, except for registered reports and all documents (SLDs,
schematics, miscellaneous drawings and electrical analysis SLDs). To include these items
when merging the project, you must mark them manually as completed in a separate session.
The following table shows the various commands available for changing the status of the items in
the project and how they affect these statuses.
Command

Initial Status

Final Status

Comments

Scope

None, Scoped

Scoped

Performed in As-Built. If the initial


status is Scoped, refreshes the
data by re- scoping the item.

Set Claim Mode


(Exclusive, Shared,
or Release Claim)

Scoped

Claimed

Performed in a project. Invoked


after clicking Apply.

Mark as Completed

Claimed

Completed

Performed in a project. Invoked


after clicking Apply. Item stops
being editable and is ready to be
merged.

Clear Mark as
Completed

Completed

Claimed

Performed in a project. Invoked


after clicking Apply and receives
same claim mode as when first
claimed. Makes the item editable.

Mark as Reclaimed

Merged

Claimed

Performed in a project. Invoked


after clicking Apply and receives
same claim mode as when first
claimed. Makes the item
editable. This command is option
is required when working with
SmartPlant.

Release Claim

Claimed

Claimed

Performed in a project. Invoked


after clicking Apply. The claim
mode changes to Release
Claim. Enables re- scoping of the
item in As- Built.

SmartPlant Electrical User's Guide

451

Project Management in SmartPlant Electrical


Command

Initial Status

Final Status

Comments

Merge

Completed

Merged

Performed in As-Built. Overwrites


the previous As- Built data.

In a project, when searching for completed items in the Project Management window, it is
now possible to select the related items which have not been completed yet and change their
status to Completed.

Modify Project Status


This procedure explains how to display the current project status, both with respect to SmartPlant
and the plant and to update or modify those statuses.
1. Open the project for which you want to view the status.
2. On the Project Management toolbar, click
to open the Project Status dialog box.
3. In the SmartPlant Electrical project status area, ascertain the current status of your project
with respect to the Plant.
A check mark denotes the current status. Possible statuses include Active,
Completed, Merged, and Canceled.
4. To change an active project to completed, click Complete Project. This button is available
only when the SmartPlant Electrical project status is Active.
When you change the project status to Completed, the software automatically sets the
status of all the items in the project to Completed, except for registered reports and all
documents (SLDs, schematics, miscellaneous drawings and electrical analysis SLDs). To
include these items when merging the project, you must mark them manually as completed in
a separate session.
5. To change a completed project back to active, click Return to Active. This button is
available only when the SmartPlant Electrical project status is Completed.
6. To merge a completed project into the Plant, click Merge Project. This button is available
only when the SmartPlant Electrical project status is Completed.
7. To cancel the active project, click Cancel Project.

452

If you are registered with SmartPlant, click Refresh Status on the Project Status (see "Project
Status Dialog Box" on page 754) dialog box to update the SmartPlant project status display.
In SmartPlant, the Complete Project, Reactivate, and Merge Project options are not
available unless the SmartPlant project status is also active. The Cancel Project option is
not available unless the SmartPlant project status is also Canceled.

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Scoping Items
Once the Plant Administrator has scoped the project, you can start specifying which items will be
available for viewing in the project. This selection is called scoping items.
You scope items by selecting the required items in As-Built. The selection can be one of the
following:
The entire plant hierarchy that was assigned in SmartPlant Engineering Manager, according
to the scoping definitions that the Plant Administrator has made.
Individual in the Electrical Engineer.
Individual items in the Electrical Index.
Several items in the Tabular Editor.
You can select loads, converting equipment, power sources, free cables, PDBs, and so
forth. Note that the software automatically scopes all the items that are associated with the
scoped items. These items are called related items. Related items are those items that have an
electrical or functional relationship to a main item. Related items may include control stations,
associated cables, circuits, and signals.
In addition to the items that are included in the scoped plant groups, you can also scope items that
belong to unscoped plant groups. However, you will not be able to claim these items or edit them
in the project.
When scoping, the software follows certain rules that govern which items become available for
viewing in the project. For details, see Rules for Scoping Items (on page 454).

Select a Project
This procedure shows you how to select a project for the current As-Built plant. Note that you
have to select a project every time you reopen the Project Management table.
1. In an As-Built plant, click Window > New > Project Management.
2. In the Project Management table, do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Select Project.

You have to select a project every time you reopen the Project Management table.
After closing the Project Management table, the software removes all the items from the
Project Management table.

SmartPlant Electrical User's Guide

453

Project Management in SmartPlant Electrical

Rules for Scoping Items


The general rule for scoping is that when selecting items, the software automatically scopes all the
related items and all the items that extend up to and including the item power source. For
example, selecting a motor that is connected to a feeder circuit, the software will scope the motor
control stations, the motor feeder cable, the feeder circuit, the bus, and the PDB.
The extent of the related items that are scoped along with the main selected item are indicated in
the following table.
Main Item

Related Item

Loads, converting
equipment, power
sources

(generators, battery
banks, offsite

power)

Power distribution
boards

Notes

Cables of any category

(from / to sides)
Control stations and their
cables
Instruments and their cables
I/O signals
Associated Circuits, their
internals and their

PDB-Bus-Cell associations
Metering equipment

When scoping loads and


equipment connected to a bus,
the scope includes all the items in
the Electrical Engineer branch
up to and including the circuit and
circuit internals, excluding the
PDB and bus and any other
irrelevant circuits of that PDB.
Any cables connected to the
circuit rather than directly to the
scoped load will not be scoped
with the circuit. Instead, those
cables will be scoped with related
equipment like control stations.

All buses, circuits and internals,


up to the boundary of the PDB
have to be scoped separately as
they are not included in the scope
automatically when scoping a
PDB.
No associated items external to
the PDB items, such as cables or
signals associated with the PDB
or circuits will be scoped.

None

Drums

Does not include cables assigned to


the drum that have not been scoped.

Cableways

All cableway segments


Entire cable that is routed
through one or more
segments of the cableway

Instruments

Cables of any category


(from / to sides)
I/O signals
Associated Circuits, their
internals and their
PDB-Bus-Cell associations
Metering equipment

454

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical


Main Item

Related Item

Local panels,
junction boxes,
cabinets

Notes

Cables of any category


(from / to sides)
I/O signals
Associated Circuits and
their internals
Metering equipment

To scope space heaters and auxiliary contacts, see Guidelines for Scoping Space Heaters
and Auxiliary Contacts (on page 455).
When scoping an item that is connected in parallel with another equipment item, the software
automatically scopes all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3,
the software will also automatically scope Motor-2 and Motor-3 together with their upstream
items all the way to their power sources.
You can scope the same item for more than one project.

Guidelines for Scoping Space Heaters and Auxiliary Contacts


When creating projects and scoping disconnect electrical equipment that have auxiliary contacts,
follow the guidelines specified below:
As-Built Items

Project Requirement

Scoping and Merging

A motor connected to a Design the space heater and Scope the motor branch and the PDB
standard feeder circuit its complete power source
with its circuit so that it can be
and add the required
claimed in the project.
disconnect equipment
Add a space heater, auxiliary When merging, select both the motor,
contacts, the power supply
its new circuits, and the space heater
circuits, and the
circuitry
interconnecting cables.
A motor with a space Delete all or part of the space
heater connected to
heater circuitry.
the auxiliary contact of
the motor circuitry and
the feeder to the
auxiliary contacts
circuitry

SmartPlant Electrical User's Guide

Select the motor as a scoped item all


its related space heater circuitry
(space heater, its feeder cable, the
auxiliary contacts, the cable that
feeds the auxiliary contacts. Note that
the bus and the PDB that feeds the
auxiliary circuitry will be scoped as
view only.

455

Project Management in SmartPlant Electrical

Add Items to the Project Management Table in As-Built


This procedure explains how to open the Project Management table and add the items that you
require. Note that you have to add items that you want to work with every time you reopen the
Project Management table.
1. In an As-Built plant, click Window > New > Project Management.
2. Select the desired project. For details, see Select a Project (on page 453).
3. Drag the desired items one-by- one to the Project Management table. You can drag items
from any of the following:
Electrical Index
Electrical Engineer
Tabular Editor
a schematic
a single line diagram

You have to add items every time you reopen the Project Management table.
You cannot add items to a project that has been set to Completed.

Scope Items
Once the Plant Administrator has scoped your project, you can start scoping the items that will be
available for viewing in the project.
1. In SmartPlant Electrical, click File > Open > Plant Group to open an As-Built plant.
2. On the Open Plant Group dialog box, click Select Plant.
3. On the Open Plant Group dialog box, select the appropriate plant hierarchy level and click
OK.
4. Click Window > New > Project Management.
5. In the Project Management table in As-Built, click
.
6. On the Select Project dialog box, select the project you require and click OK.
7. With the Project Management table in As-Built open, select the main items for scoping and
then do one of the following:
Drag the selected item to the Project Management table. Note that you can only drag
single items. For multiple items wherever possible, use the Add command.

Click

on the Project Management toolbar.

Note that you can use the buffer to make a preliminary selection of items that you may
want to add to the Project Management tables. For details, see Use the Buffer to Scope
Items (on page 457).
8. Select the check box beside each main item that you want to scope.

456

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical


9. Click

to scope the items.

The software also scopes related items automatically.


When scoping an item that is connected in parallel with another equipment item, the software
automatically scopes all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3,
the software will also automatically scope Motor-2 and Motor-3 together with their upstream
items all the way to their power sources.
Certain related items that are scoped, such as circuit internals, do not appear in the Project
Management table.

Use the Buffer to Scope Items


The buffer in the Project Management table allows you to make a preliminary selection of items
that you want to scope.
1. With the Project Management table in an As-Built plant open, do one of the following:
Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Show/Hide Buffer.
2. Drag the desired items one-by- one to the buffer in the Project Management table. You can
drag items from any of the following:
Electrical Index
Electrical Engineer
Tabular Editor
a schematic
a single line diagram
3. In the Buffer, click the check boxes next to the items that you want to scope.
4. Do one of the following:

Click
on the on the Project Management toolbar.
Right-click in the Project Management table and then click Paste from Buffer.

Claiming Items
You claim items by opening the project to which they were scoped, and then you select individual
items to claim. Once you have claimed an item, it becomes available for editing in the project.
You can claim main or related items separately. When claiming an item in a project, with the
appropriate Options Manager setting, you can choose claim mode Shared or Exclusive.

You cannot claim items in a project whose status has been set to Completed or Merged.
You do not need to claim new items that you create in the project.

SmartPlant Electrical User's Guide

457

Project Management in SmartPlant Electrical

Add Items to the Project Management Table in a Project


1. Open the desired project.
2. Click Window > New > Project Management.
3. Do one of the following:
Drag a single item to the Project Management table from the Electrical Index,
Electrical Engineer, or the Tabular Editor to the Project Management table.

Select a single item in a schematic or SLD and click

Select multiple items the Electrical Index, or the Tabular Editor and click

.
.

You cannot add items to a project that has been set to Completed.
After closing the Project Management table, the software clears the all the items from the
table.
You have to add items every time you reopen the Project Management table.

Claim Items
You claim items by opening the project to which they were scoped, and then you select individual
items to claim. Note that you can claim main or related items separately. When claiming an item
in a project, with the appropriate Options Manager setting, you can choose claim mode Shared or
Exclusive.
1. In a project, click Window > New > Project Management.
2. Add the items that you require. For details, see Add Items to the Project Management Table
in a Project (on page 458).
3. Select the check box beside each item that you want to claim. For details of item statuses in
the project that determine which items you can mark for claiming, see Rules for Changing
Statuses (on page 451).
4. For each item that you want to claim, select Shared or Exclusive as the claim mode. Note
that if, in the Options Manager, General Settings, the As-Built Claim Mode option is set to
Exclusive, the Shared claim mode is not available.
5. Click the Apply command to claim the items.

458

The items are now available for editing in the project. When you have finished editing items,
you can change their status to Completed. Items with status Completed are ready for
merging into As-Built.
Check the data under Result Status to make sure that there are no problems.
You cannot claim items in a project whose status has been set to Completed or Merged.

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Set Claim Mode


This option allows you to set the required claim mode. The following claim modes are available:
Exclusive Allows you to claim As-Built items in the current project only.
Shared Allows users of different projects to claim the same As-Built items for their projects.
Release Claim Allows you to cancel the claim of the selected items and then re- scope
them in As-Built. Re-scoping the items will update the data in the project.
Note that the Shared claim mode is available only after making an appropriate setting in the
Options Manager. Also, if your plant is registered with SmartPlant, the Shared mode is not
available, regardless of the setting you define in the Options Manager. For details, see General
Settings Window in the Options Manager User's Guide.
1. In a project, click Window > New > Project Management.
2. Add the items that you require. For details, see Add Items to the Project Management Table
in a Project (on page 458).
3. Select the check box beside each required item. For details of item statuses in the project,
see Rules for Changing Statuses (on page 451).
4. Do one of the following:

Click
on the Project Management toolbar and then select Exclusive, Shared, or
Release Claim.
Right-click in the Project Management table and then on the shortcut menu, point to Set
Claim Mode and then click Exclusive, Shared, or Release Claim.
5. Click the Apply command to claim the items.
The Shared claim mode is only available after selecting the appropriate setting in the
Options Manager.

Release Claim
Releasing the claim of an item enables you to cancel the claim of an item. This action makes it
possible to re-scope the item in As-Built if you need to update the data in the project. After the
item has been re-scoped, you can claim it again in the project and then edit the updated
data. Note that when releasing the claim of an item, it status in the project remains
Claimed. However, the claim mode changes to Release Claim. Items whose claim mode is
Release Claim behave exactly in the same way as the scoped items as the software re-scopes
these items.
1. In a project, click Window > New > Project Management.
2. Right-click in the Project Management table and then click Show Claimed Items
3. Select the check box beside each item for which you want to release the claim.
4. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then on the shortcut menu, click
Release Claim.

SmartPlant Electrical User's Guide

459

Project Management in SmartPlant Electrical


5. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Apply.

After setting the claim mode to Release Claim, the status of the items still remains behave
exactly in the same way as the scoped items as the software re-scopes them.
To claim the items whose claim mode to Release Claim, right-click in the Project
Management table and then on the shortcut menu, click Mark as Reclaimed.

Mark Selected Items as Completed


Just before you are ready to return the items from your project to As-Built, you have to change the
status of these items in the project to Completed. The items that have been marked as
completed are no longer available for editing in the project and are ready for merging into As-Built.
1. Open the desired project.
2. Add the items that you require. For details, see Add Items to the Project Management Table
in a Project (on page 458).
3. Select the check box beside each item that you want to mark as completed. For details of
item statuses in the project, see Rules for Changing Statuses (on page 451).
4. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then on the shortcut menu, click Mark
as Completed.
5. Click the Apply command to claim the items.
The items that have been marked as completed are no longer available for editing in the
project and are ready for merging into As- Built.

Clear Mark as Completed


This option allows to you to change the Completed status back to Claimed. These items will
again become available for editing in the project.
1. Open the desired project.
2. Add the items that you require. For details, see Add Items to the Project Management Table
in a Project (on page 458).
3. Select the check box beside each required item. For details of item statuses in the project,
see Rules for Changing Statuses (on page 451).
4. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then on the shortcut menu, click Clear
Mark as Completed.
5. Click the Apply command to claim the items.
The items whose status is Clear Mark as Completed become available for editing in the
project.

460

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Complete a Project
Prior to merging all the project items into As-Built, you have to change the status of all the project
items to Completed. Setting the project status to Completed automatically changes the status of
all the project items to Completed and allows you to run a full merge of the current project into
As-Built. For details about running a full merge, see Merge All the Project Items into As-Built (Full
Merge) (see "Merge All Project Items into As-Built (Full Merge)" on page 464).
1. In a project, click Window > New > Project Management.
2. On the Project Management toolbar, click
.
3. On the Project Status dialog box, click Complete Project.
4. Click Close.

You cannot claim items in a project whose status has been set to Completed or Merged.
A project can only be returned to an Active state from the Completed or Merged state. If a
project has been set to Canceled, it cannot be changed back to Active. Canceled is
permanent state.

Return a Project to the Active Status


This procedure explains how to reactivate a project which has been merged or set as Completed.
1. In a project, click Window > New > Project Management.
2. On the Project Management toolbar, click
.
3. On the Project Status dialog box, click Reactivate.
4. Click Close.

Release from Merge


After merging items into the As-Built plant, users of other projects cannot claim these items. This
option makes it possible to release merged items so that they can be claimed for other
projects. After applying this option, the merged items in your current project become marked as
scoped.
1. In a project, click Window > New > Project Management.
2. Right-click in the Project Management table and then click Show Merged Items
3. Select the check box beside each item you want to release.
4. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Release from Merge.
5. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Apply.

After releasing from merge, the status of the items in the project becomes Scoped, that is,
the items will be scoped after you click Apply again.

SmartPlant Electrical User's Guide

461

Project Management in SmartPlant Electrical

Merging Items into As-Built


Merging is the final stage of the project cycle. After you have edited items in your project, you can
merge those items into As-Built. The merge operation completely overwrites existing data in
As-Built with data from the project. For this reason, once you have committed to merge data, the
changes are irreversible.

You can merge all the project items into As-Built or only some of the completed items that you
select.
If you add a new item in the project, after merging the item, the software creates it in As-Built.
If you modify data for an item in the project, after merging, the software overwrites the existing
data for that item in As-Built.
If you delete an item in the project, after merging the item, the software deletes it in As-Built.
When merging an item that is connected in parallel with another equipment item, the software
automatically merges all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3,
the software will also automatically merge Motor-2 and Motor-3 and their upstream items all
the way to their power sources.
You can claim an item in a project and subsequently modify its data in As-Built. If you then
want to transfer the item changes from As-Built to the project, you must update the item
manually in the project. To assist you in doing this, it is recommended that you run a
comparison report first. You can also run the Release Claim command in the project to
automatically re-scope the item with the updated data from As-Built, but in this case any
changes you have made to the item in the project will be lost.
You can only edit data in As-Built if in Options Manager, General Settings, the Allow Editing
in As-Built property is set to Yes.
For the rules that govern document revisions, see Rules Governing Revisions for Documents
Merged Back into As-Built (on page 463).

Compare a Document in a Project with a Document in


As-Built
After scoping and modifying items in a project, you can compare documents of the same type in
As-Built and in the project, for example, registered reports, SLDs, schematics. If changes that
you made to the item are reflected in the document, the software compares the changes and
indicates them on a comparison report. Note that the software generates As-Built and project
reports automatically when you run this command. This comparison can serve as a
precautionary measure before merging project documents into As-Built.
1. In an As-Built plant, click Window > New > Project Management.
2. Select the desired project. For details, see Select a Project (on page 453).
3. From the Electrical Index, add the desired documents to the Project Management
table. For details, see Add Items to the Project Management Table in As-Built (on page 456).
4. In the Electrical Index, select a registered report, a schematic or an SLD that you want to
compare.
5. In the Project Management table, select the check box next to the document that you want to
compare.

462

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical


6. Right-click in the Project Management table and then click Compare Documents.

For the rules that govern document revisions when merging documents into As-Built, see
Rules Governing Revisions for Documents Merged Back into As-Built (on page 463).
In SLDs and schematics, the software displays clouds around the items that differ from the
current data. The last revision number is shown in a triangle beside the cloud.
The software uses index numbers to identify the changes in associations between electrical
items.
The software generates a tabular report where it shows all the changes and shows the
changes in associations using index numbers as they appear in the drawing.
For registered reports, the software opens two Excel files. One of the Excel files displays
changed data with blue shading. The second file is a summary of all changes and it is called
Registered Comparison Report. This report displays the previous and current data for
each tag that has undergone a change. Note that you can compare a registered report only if
it is a simple tabular report.
In SLDs, the software indicates the following changes:
All added and deleted electrical items except for control stations.
Added, deleted, and updated properties of electrical items.
Changes in associations.
Attachment to a different document template.
In schematic drawings, the software indicates the following changes:
Added, deleted, and updated properties of electrical items.

Rules Governing Revisions for Documents Merged Back into


As-Built
When merging a document from a project back into As-Built, the software manages the document
revisions according to the following rules:
The revision numbering of a document in a project is done manually. When merging a
document into As-Built, and the revision number of the document in the project is lower than
the one in As-Built, the software raises the revision number automatically.
If the revision number of the document in the project is higher than the one in As-Built, after
merging the document back into As-Built, the software treats the revision number that was set
in the project as the latest revision.
If a document has different revision methods in As-Built and a project, after merging such a
document back into As-Built, the software inserts the revision as it was used in the project and
treats this revision as the latest one. All consequent revisions of this document will use the
new method as it was set in the project.
If the revision number of the document that you want to merge into As-Built is identical to the
one in the project, the software can do one of the following according to the preference that
you have set on the General Settings page in Options Manager.
Reject the document the software will not merge the current document into As-Built
and will add an appropriate note in the log file.
Increment the revision number the software will raise the revision number in
As-Built.
Use the existing number and overwrite the revision the software will retain the
revision number in As-Built but will overwrite the revision information.

SmartPlant Electrical User's Guide

463

Project Management in SmartPlant Electrical

Run a Test Merge


You can run a test merge before merging the items into As- Built. This operation allows you to
check whether there are any problems with the items that you want to merge into As- Built. The
software creates a log file that describes the problem that may occur during a test run.
1. In the Project Management table (for As-Built), select the desired project.
2. Do one of the following:

On the Project Management table toolbar, click


.
Right-click in the Project Management table and then click Find Completed Items to
see which items have been completed in the project.
3. Right-click in the Project Management table and then click Test Merge.
The software generates a log file that shows any possible problems that might occur during
the test merge. For details, see Generate Error Log Files (on page 34).

Merge All Project Items into As-Built (Full Merge)


The following procedure explains how to merge all the project items into As-Built.
Merging is the final stage of a project cycle. After you have edited items in your project, you can
merge those items into As-Built. The merge operation completely overwrites existing data in
As-Built with data from the project. For this reason, once you have committed to merge data, the
changes are irreversible.
Note that in order to run a full merge, the status of the project must be set to
Completed. For details, see Complete a Project (on page 461).
1. In an As-Built plant, click Window > New > Project Management.
2. Select the desired project whose status has been set to Completed. For details, see Select
a Project (on page 453).
3. On the Project Management toolbar, click
.
4. On the Project Status dialog box, click Merge Project.
5. Click Close.

464

The software merges all the completed items into As-Built, including the child items.
The status of all the child items in the project must be Completed. If the status of some of the
child items is not set to Completed, full merge is not possible.
Once a project has been merged, the software sets the status of the project and the status of
all the items in the project to Merged. No further activities are possible in this project as all the
items in the project are locked and cannot be edited. If you want to edit some of the items in a
merged project, you must first reactivate the project. After reactivating a project, all the items in
that project become scoped and you will have to claim the items that you want to edit.

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Merge Selected Project Items into As-Built (Partial Merge)


The software allows you to run a partial merge of the project items that have already been
completed. You can instruct the software to find all the completed items in a project and add them
to the Project Management table. You can then examine these items and select the ones that
you want to merge into As-Built.
The merge operation completely overwrites existing data in As-Built with data from
the project. For this reason, once you have committed to merge data, the changes are
irreversible.
1. In an As-Built plant, click Window > New > Project Management.
2. Select the desired project. For details, see Select a Project (on page 453).
3. Do one of the following to find the items that have been completed in the project:
Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Find Completed Items.
4. On the Find dialog box, click Find Now.
5. Under Results, select the items that you require and click OK.
6. In the Project Management table, select the check box next to a completed item that you
want to merge into As-Built.
You cannot merge into As-Built items that have child items which have not been
completed yet.
7. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Merge.

If you select an item that has child items whose status is not set to Completed, the main item
cannot be merged.
When merging an item that is connected in parallel with another equipment item, the software
automatically merges all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3,
the software will also automatically merge Motor-2 and Motor-3 and their upstream items all
the way to their power sources.

Miscellaneous Options
The following additional options are available:
Filter the Project Management Table Display (on page 466)
Select a Display Option (Jump Template) (see "Select a Display Option" on page 466)
Generate an Excel Report (Jump Template) (see "Generate an Excel Report" on page 467)
Backup a Project
Restore a Project

SmartPlant Electrical User's Guide

465

Project Management in SmartPlant Electrical

Filter the Project Management Table Display


This option allows you to filter the display of the items in the Project Management table according
to the status of items in the project.
1. In an As-Built plant or project, click Window > New > Project Management.
2. If your work environment is an As-Built plant, select the desired project. For details, see
Select a Project (on page 453).
3. Do one of the following:
Click the required icon on the Project Management toolbar.
Right-click in the Project Management table and then click one of the following
commands:
Icon

Command

Explanation

Show Completed Items

Filters the display to show only those items that


have been completed in the project.

Show Merged Items

Filters the display to show only those items that


have been merged back into As-Built.

Show Claimed Items

Filters the display to show only those items that


have been claimed for the project.

Show Items Deleted from Filters the display to show only those items that
As-Built
have been deleted in As-Built.
Show Item Properties

Displays the values of the item properties for an


item similar to the Properties window view, but in
read- only mode. Click Alphabetic
to display
the properties in alphabetical order; click
Categorized
to display the properties
grouped by specific categories. The software
can display the properties of only one item at a
time; the item for which the row is highlighted.

Select a Display Option


This option allows you to specify the display mode in the data window. You can display the main
items only, the main items expanded to show their related items, or a list showing all items. If a
particular related item is associated with more than one main item, that related item appears once
only in the list view. In list view only, you can sort the items as desired by clicking the column
headers in the data window.
1. In an As-Built plant or project, click Window > New > Project Management.
2. If your work environment is an As- Built plant, select the desired project. For more information,
see Select a Project (on page 453).
3. Do one of the following:

466

Click
on the Project Management toolbar and then select the required option.
Right-click in the Project Management table, click Display, and then click a command:
Main Items Only, Main Items with Related Items, All Items as List.

SmartPlant Electrical User's Guide

Project Management in SmartPlant Electrical

Generate an Excel Report


This option allows you to generate a report in Excel showing the current selection in the Project
Management table, arranged according to the main items. In the report, you can expand the
main items to display their related items.
1. In an As-Built plant or project, click Window > New > Project Management.
2. If your work environment is an As- Built plant, select the desired project. For more
information, see Select a Project (on page 453).
3. Do one of the following:

Click
on the Project Management toolbar.
Right-click in the Project Management table and then click Excel Report.

SmartPlant Electrical User's Guide

467

SECTION 32

Working with Off-Site Projects in


SmartPlant Electrical
This section covers information about using off-site projects with SmartPlant Electrical. You use
off-site projects for performing plant engineering activities at distributed locations, for example,
where a project is executed at a remote location (off-site plant) which is physically not connected
to the operational plant (host). During project execution at the off-site plant, work can continue in
the host and the changes can be updated in the off-site plant. At any stage of the project, you can
merge back to the host all or some of the changes made in the off-site plant. Integration activities
are performed in the host As-Built.
The function of an off-site plant in SmartPlant Electrical parallels that of a standalone
Workshare satellite in SmartPlant P&ID, and therefore the terms 'satellite' and 'off-site plant' may
sometimes be used interchangeably; however, it is important to realize that the implementation is
different in the two applications.

Intercompany Collaboration Prerequisites for


SmartPlant Electrical
In order to enable project creation for a registered plant, or to enable registration of a plant that
contains projects, you must launch SmartPlant Engineering Manager using the '/eab' modifier.
For example, at the command prompt, type:
"C:\Program Files\SmartPlant\Engineering Manager\Program\SmartPlant
Engineering Manager.exe" /eab

The actual path that you type will depend upon the location where you installed the software.
Publish, Retrieve and other SmartPlant menu items are only available in the As-Built, not in
the projects.
You must first claim items in projects in order to modify them. The As-Built does not claim
items to edit them.
As-Built editing will be enabled according to As-Built access rights.

SmartPlant Electrical User's Guide

469

Working with Off-Site Projects in SmartPlant Electrical

Types of Information Handled by Off-Site Projects


Off-site projects handle several types of information, as summarized in the following table.
Information Type

Description

Examples

Plant items

Data that you create or import into the


Electrical Index and use to make
electrical relationships in the Electrical
Engineer.

Motors and other loads,


panels, cables, cableways.

Reference schema
items

Template data used to set standards for Reference cables, typical


work performed in the plant and to
blocks, cableway
improve the performance of the plant
components
creation by using a predefined set of data.
These items appear in the Reference
Data Explorer.

Reference data
(metadata)

Data that defines the structure or


presentation of plant and reference
schema items.

Data dictionary, drawing


templates, plant reports.

Information Handling
The following table summarizes how the software handles these different types of information at
various stages of the workflow.
Workflow Stage

Information Type

Initial data scoping Plant items


and transfer to
off-site plant

Data rescoping

470

Method of Handling
User specifies which data to scope in SmartPlant
Electrical. User creates package in SmartPlant
Engineering Manager for transferring the data to the
off-site plant.

Reference schema
items

The software copies all reference schema items in


the host to the package that the user creates for
transferring the plant items.

Reference data
(metadata)

The software copies all metadata in the host to the


package that the user creates for transferring the
plant items.

Plant items

User can specify additional data to rescope in


SmartPlant Electrical, but cannot de-scope existing
items that were previously scoped. User creates
package in SmartPlant Engineering Manager for
transferring the data to the off-site plant.

Reference schema
items

The software rescopes all new reference schema


items related to the plant items that the user has
rescoped. The software includes these reference
schema items in the package that the user creates
for transferring the plant items.

Reference data
(metadata)

No changes to metadata when rescoping.

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


Workflow Stage

Information Type

Method of Handling

Transfer of data
back to host

Plant items

User specifies which items to transfer in SmartPlant


Electrical by merging those items in the off-site plant.
User creates packages in SmartPlant Engineering
Manager for transferring the data to the host.

Reference schema
items

The software merges all new reference schema


items related to the plant items in the package that
returns to the host.

Reference data
(metadata)

If user edited metadata in the off-site plant, the user


must run the SmartPlant Reference Data
Synchronization (RDS) Manager for updating the
metadata in the host.

When saving a project for reloading into a plant or saving a plant for merging in the host,
SmartPlant Engineering Manager copies to the host or off-site plant all new reference schema
items of the following types only:
Reference cables
Typical blocks
Typical schematics
Cableway components
Existing reference schema items and other types of reference schema items remain unchanged.

Scope of Allowed Activities


Before you start working with an off-site project, you should familiarize yourself with activities that
you can perform and those that you should not perform. The following constraints apply:
You should avoid editing data in the host project, as this will result in data being overwritten
when transferring the package to the off-site plant.
Do not modify data in the off-site plant reconciliation area.

Out of Scope Items


The following features are out of scope in the current release:
The software does not perform validation of item tag sequence uniqueness in the off-site plant.
Instead, it is the responsibility of the Host Administrator to supply suitable sequence ranges to
the Off-Site Plant Administrator.
When saving a project for reloading into a plant or saving a plant for merging in the host,
SmartPlant Engineering Manager copies to the host or off-site plant all new reference schema
items of the following types only:
Reference cables
Typical blocks
Typical schematics
Cableway components
Existing reference schema items and other types of reference schema items remain
unchanged.

SmartPlant Electrical User's Guide

471

Working with Off-Site Projects in SmartPlant Electrical

Flowchart for SmartPlant Electrical Off-Site Projects

SmartPlant Electrical Off-Site Projects Workflow


This workflow provides a high-level description of how to implement off-site projects. For details
of the menu commands and dialog box options needed for each of the scenarios, refer to the
detailed procedure for that scenario.

Initial Scoping and Data Transfer


1. Create a plant, to be defined as the host, with one or more projects.
2. Scope the desired items to a project.
3. Export the project as a package.
Once you have created an initial package, you cannot de-scope items in the
As-Built.
The exported package includes reference schema items (reference cables, typical
blocks, cableway components, lookup tables, and so forth).

472

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


4. Import the package into the off-site plant.

In the off-site plant, the software creates a schema known as the reconciliation area.
The data in the reconciliation area is identical to that of the project that you exported.
On the page where SmartPlant Electrical is shown as the application to associate, if,
under the section Select the schema data for copying, you select the Project check
box, the software also creates an off-site project that initially contains data identical to that
of both the source project and the reconciliation area.
5. Edit data in the off-site project as needed.
Do not change the names of units in the off-site plant where you transfer data,
otherwise the software will not be able to merge the data back to the host later.

During editing in the off-site plant, it is possible to continue to make changes in the host
As-Built. To synchronize those changes with the off-site plant, you must rescope the
host data (for details, see below).
If, after exporting the project as a package, you create new metadata in the host As-Built
that affects the plant data, you must run the SmartPlant Reference Data Synchronization
(RDS) Manager to create a separate RDS package. You must synchronize metadata
with the host using this RDS package before importing the package containing the plant
items. For details of how to create the RDS package and how to synchronize the
metadata, refer to the SmartPlant Reference Data Synchronization Manager User's
Guide.

Transferring Data Back to the Host


1. In the off-site plant, merge data from the project into the reconciliation area.
If desired, you can perform a partial merge.
2. Export data from the off-site plant reconciliation area as a package.
3. If, in the off-site plant, you created new metadata that affects the plant data, you must run the
SmartPlant Reference Data Synchronization Manager to create an RDS package in the
off-site plant and then import this package into the host.
You may not make changes to the metadata in the plant breakdown structure table
in the off-site plant. For example, do not add any user-defined fields in your plant breakdown
structure. Doing so may damage the host project when you synchronize the metadata back to
it.
This step updates the entire set of metadata. You must run this step before
importing the package containing the plant items.
4. Import the package into the host.

The software copies all new reference cables, typical blocks, and cableway components
to the host. Changes in existing reference cables, typical blocks, and cableway
components do not propagate back automatically to the host at this stage, but will do so
when you rescope data from the host.
In the host, the software updates the project only. As-Built data remains unaffected.
5. Merge the project into the As-Built in the host.
If desired, you can perform a partial merge.

SmartPlant Electrical User's Guide

473

Working with Off-Site Projects in SmartPlant Electrical


Rescoping and Synchronizing Updated As-Built Data
1. Rescope the As-Built data in the host.
2. Export the rescoped project as a package.
This action creates an update of the existing package.
3. If you created an RDS package, import this package into the off-site plant using the
SmartPlant Reference Data Synchronization Manager.
Metadata is shared between the reconciliation area and projects in the off-site plant.
You must run this step before importing the package containing the plant items.
4. Import the updated package into the off-site plant.

The software copies all new reference cables, typical blocks, and cableway components
to the off-site plant. Existing reference cables, typical blocks, and cableway components
remain in the off-site plant unchanged.
In the off-site plant, the software updates data in the reconciliation area only. Data in the
project remains unaffected.
5. In the off-site plant, scope or claim items as desired into the project.
This step should be performed with care to ensure that you do not inadvertently
overwrite any of the data that you changed in both the off-site project and the host As-Built.

Scope Host Data and Transfer to Off-Site Plant


1. In SmartPlant Electrical, open the host plant (As-Built) and select the project that you want to
specify as the host project.

474

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


2. Scope the desired items to the host project.

3. Open the project and select the plant group where your data resides.

4. Claim the items to the project.

5. Close SmartPlant Electrical.

SmartPlant Electrical User's Guide

475

Working with Off-Site Projects in SmartPlant Electrical


6. Open SmartPlant Engineering Manager and connect to the host.
7. Select the host project and on the shortcut menu, click Save Project as Offsite.

8. On the Save Project as Offsite dialog box, accept the default location for exporting the plant
to, or change the location by clicking the ellipsis button

476

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


9. Click OK to export the host project data as a package. The status bar at the bottom of the
dialog box shows the current activity.

10. In SmartPlant Engineering Manager, connect to the off-site plant.


11. Click Plant Structures and on the shortcut menu, click Load Offsite Plant Structure.

12. On the following page of the Load Offsite Plant Structure Wizard, beside Zip file of plant,
click the ellipsis button

SmartPlant Electrical User's Guide

477

Working with Off-Site Projects in SmartPlant Electrical

13. Browse to the zip file containing the package from the host that you want to load.

478

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


14. Click Next. The page shows you details of the package.

15. In the Name field, type the name of the new plant to be created in the off-site plant.

SmartPlant Electrical User's Guide

479

Working with Off-Site Projects in SmartPlant Electrical


16. To create a project in the plant, select the Project check box.

17. Specify the plant structure path (in this example, the plant structure path was copied from the
folder path one level above the backup location).

480

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


18. In the System user and System password fields, type appropriate values for your database.

19. Accept the database server and user connection information. If desired, specify a different
path for the SmartPlant Electrical reference data.

SmartPlant Electrical User's Guide

481

Working with Off-Site Projects in SmartPlant Electrical


20. Click Finish to load the package and create the new As-Built and project for the off-site plant.

Transfer Data from the Off-Site Plant to the Host


Before commencing this procedure, if you have created or modified metadata in the
off-site plant, you must synchronize the metadata between the off-site plant and the host using the
Reference Data Synchronization (RDS) Manager. Refer to the appropriate user's guides as
follows:
For details of how to create or modify metadata, refer to the SmartPlant Data Dictionary
Manager User's Guide.
You may not make changes to the metadata in the plant breakdown structure table
in the off-site plant. For example, do not add any user-defined fields in your plant breakdown
structure. Doing so may damage the host project when you synchronize the metadata back to
it.
For details of how to create an RDS package and synchronize the metadata between the
off-site plant and the host, refer to the SmartPlant Reference Data Synchronization Manager
User's Guide.
1. In SmartPlant Electrical, open the off-site plant and select the project where you made
changes to the data.

482

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


2. Select the items that you want to merge back to the Reconciliation Area.

3.
4.
5.
6.

Change the status of those items to Completed.


Connect to the Reconciliation Area in the off-site plant and merge the items.
Open SmartPlant Engineering Manager and connect to the off-site plant.
Select the off-site plant and on the shortcut menu, click Save Plant for Merge in Host.

SmartPlant Electrical User's Guide

483

Working with Off-Site Projects in SmartPlant Electrical


7. Accept the values on the Save Plant for Merge in Host dialog box.

If you made revisions in the plant and you want to include those revisions in the
package, select Include SmartPlant Electrical revisions.
8. Click OK to export the off-site plant data as a package. The status bar at the bottom of the
dialog box shows the current activity.

484

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


9. Select the host project and on the shortcut menu, click Load Standalone Project.

10. On the following page of the Load Standalone Project Wizard, beside Zip file of plant, click
the ellipsis button

SmartPlant Electrical User's Guide

485

Working with Off-Site Projects in SmartPlant Electrical


11. Browse to the zip file containing the package from the off-site plant that you want to load.

12. Click Next. The page shows you details of the package.

486

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


13. Click Finish to load the package into the host project.

14. Open SmartPlant Electrical and merge the updated project data back to the As-Built.

Rescope and Synchronize Updated As-Built Data


1. In SmartPlant Electrical, rescope the desired items to the host project.
Once you have created an initial package, you cannot de-scope items in the
As-Built.
2. Close SmartPlant Electrical.
3. Open SmartPlant Engineering Manager and connect to the host.

SmartPlant Electrical User's Guide

487

Working with Off-Site Projects in SmartPlant Electrical


4. Select the host project, right-click, and on the shortcut menu, click Save Project for Reload.

5. On the Save Project for Reload dialog box, accept the default location for exporting the plant
to, or change the location by clicking the ellipsis button

6. Click OK to export the rescoped host project data as a package.


7. Select the off-site plant and on the shortcut menu, click Load Standalone Project.

488

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


8. On the following page of the Load Standalone Project Wizard, beside Zip file of plant, click
the ellipsis button

SmartPlant Electrical User's Guide

489

Working with Off-Site Projects in SmartPlant Electrical


9. Browse to the zip file containing the package with rescoped data from the host that you want
to load.

490

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


10. Click Next. The page shows you details of the package.

11. Click Finish to load the package into the off-site plant.

SmartPlant Electrical User's Guide

491

Working with Off-Site Projects in SmartPlant Electrical

The software loads the package into the reconciliation area only; data in the off-site
project is unaffected.
Data loaded into the reconciliation area from a rescoped package does not have any
status assigned.

SmartPlant Electrical EPC Greenfield Plant Workflow


This workflow applies to initiation of data in a greenfield plant that is subsequently transferred to
the host plant as a project. It applies to the creation of new items only in the host; this workflow
cannot be used to update or delete existing items in the host.
1. Create a greenfield plant at the desired site.

We recommend that you use the same Data Dictionary template for the greenfield plant
as the template that was used to create the host plant. If the plants were created using
different Data Dictionary templates, you must run SmartPlant Reference Data
Synchronization (RDS) Manager to create a separate RDS package. You must
synchronize metadata with the host using this RDS package before importing the
package containing the greenfield plant items. For details of how to create an RDS
package and how to synchronize metadata, refer to the SmartPlant Reference Data
Synchronization Manager User's Guide.
When running the Associate Applications command for the greenfield plant, the plant
can be associated with SmartPlant Electrical only and must not be associated with any
other applications.
2. Create the desired items in the greenfield plant.
Ensure that all the data in the greenfield plant is correct before saving the plant
as a package. This is important because later on, you will be able to load the package into the
target plant as a project only once.
3. Save the plant as a package using the Save Plant Structure command. For details, see Save
a Plant Structure (on page 493).
4. To synchronize reference schema items (reference cables, cableway components, typical
blocks, typical schematics, lookup tables, and so forth) between the plants, in SmartPlant
Electrical Options Manager, do the following:
a. Connect to the greenfield plant and create a reference data package. For details, see
Create a Reference Data Package (on page 493).
b. Connect to the host plant and update the reference data from the package you created in
the greenfield plant. For details, see Update Reference Data from a Package (on page
494).
These actions synchronize the items created in the SmartPlant Electrical Reference
Data Explorer of the greenfield plant by updating them in the SmartPlant Electrical
Reference Data Explorer of the host plant.
5. In SmartPlant Engineering Manager, right-click the desired host plant (target) and on the
shortcut menu, click Enable Projects.
6. Import the package into the host plant as a project using the Load Plant as Project
command. For details, see Load a Plant as a Project (on page 495).
The Load Plant as Project command is enabled only if the plant is associated with
SmartPlant Electrical alone and not with any other application and only after the Enable
Projects command has been run for the plant.

492

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Save a Plant Structure


When running the Save Plant Structure command, make sure that there is enough
free disk space on the machine where the software will create the .zip file.
1. In SmartPlant Engineering Manager, in the tree view, right-click the plant structure you want to
save, and on the shortcut menu, click Save Plant Structure.
2. On the Save Plant Structure dialog box, click the ellipsis button
beside the Export plant
to location field, and browse to the folder where you want to save the plant structure.
3. Click OK.

Create a Reference Data Package


The following procedure explains how to create a package file that will contain the reference data
that you want to send to an off-site plant.
1. On the Options Manager menu bar, click Tools > Update Reference Data > Create
Package.
2. On the Create Reference Data Package dialog box, do the following to select the reference
items that you want to include in the package:
a. Expand the Reference Data tree view and select a desired sub-folder.
b. Select or clear the Select check box beside each reference item in the grid. Note that if
you select an item that has child items (for example a motor with a space heater), the
software selects the child items automatically without displaying them in the grid.
You can also do the following:
In the Current view group box, click the Select all shown items check box to select
all the reference items that belong to the current folder in the Reference Data tree
view.
Do not clear the Select all mandatory items check box so that all the reference items
that have been used to create plant items in the current plant or project are included in
the package.
Select the Select all reference items check box to include all the reference items
that exist in the current plant or project.
3. Click the Create Package button to start the package creation process.

If a reference item has been used in the current plant, the software marks this reference item
as mandatory and it is recommended that you include it in the package. The following
reference items are considered mandatory if they are used the current plant:
All types of cables
Glands
Cableway components
Profiles
Typical circuits
Typical schematics
I/O sets
Lookup tables

SmartPlant Electrical User's Guide

493

Working with Off-Site Projects in SmartPlant Electrical

Click Save Session to save your selections if you want to pause the current session. Click
Open Session to resume your selections. You can open a saved session from a package or
session file.
Click Open Session to open a saved session. On the Open dialog box, from the Files of type
list, select one of the following:
Reference Data Selection Session (xml) to open a saved selections session.
Reference Data Package (zip) to open a session from an existing package.
Click Report to generate an Excel file that will contain all the selections that you have made.
Once the software finishes creating the package, a message is displayed informing you
whether or not the package has been created successfully. Click the Log button to open the
package creation log file to see if there are any reference items that failed to be included in the
package.

Update Reference Data from a Package


The following procedure explains how to update your reference data from a package that was
created in a host or an off-site project.
1. On the Options Manager menu bar, click Tools > Update Reference Data > Update from
Package.
2. On the Update from Package dialog box, click Open Package and navigate to the desired
package file.
3. In the Items grid, examine the items that have been selected by the software from the current
package and do one of the following:
Do not clear the Select check box to include the package item in the update.
Clear the Select check box to exclude the package item from the update.

In the Items grid, child items that were included with their parent items are not shown by
the software. For example, if the package contains a reference motor with a space heater,
both items are included in the package without displaying the space heater in the grid.
It is not possible to select existing items to be included in the update. In this version of the
software, only new items can be included in the update process.
Make sure that you click Save Selections after making a change in the selection. This
way the package will retain all the selections.
4. Click the Report button to generate an Excel file that shows all the items that you have
selected from the current package.
5. Click the Update Data button to start the update process.

494

If a reference item has been used in the current plant, the software marks this reference item
as mandatory and it is recommended that you include it in the package. The following
reference items are considered mandatory if they are used the current plant:
All types of cables
Glands
Cableway components
Profiles
Typical circuits
Typical schematics
I/O sets

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Lookup tables
Click Save Selections to save your selections if you want to pause the current session. The
software saves your selections in the current package. Click Open Package and navigate to
the package file to resume your selections.
Once the software finishes the update process, a message is displayed informing you whether
or not the update has been completed successfully. Click the Log button to open the update
log file to see if there are any package items that failed to be included in the update.

Load a Plant as a Project


While it is possible to load several projects into the target plant, you are allowed to
load a given source plant as a project only once; therefore you should ensure that all the data in
that source plant is correct before performing this procedure.
1. In SmartPlant Engineering Manager, in the tree view, right-click the plant into which you want
to load the project, and on the shortcut menu, click Load Plant as Project.
The Load Plant as Project command is enabled only if the plant is associated with
SmartPlant Electrical alone and not with any other application and only after the Enable
Projects command has been run for the plant.
2. On the Load Plant as Project dialog box, click the ellipsis button
beside the Zip file of
plant field and browse to the plant structure you want to load.
3. In the Project name field, change the name of the project as you require.
The project name must be unique in the site; therefore it cannot be the same as
the name of any existing plant in the target site.
4. Map the source and target plant groups by doing one of the following:
If the hierarchies in the source and target are identical, you can map each level of the
hierarchy in the source to its corresponding level in the target by clicking Map All.
Under Target plant groups, select a plant group and drag it to the desired row of the grid
under Mapped plant groups.
Under Mapped plant groups, select a row, and under Target plant groups, select a
plant group and then click Map.
5. Click OK to load the project.

SmartPlant Electrical User's Guide

495

Working with Off-Site Projects in SmartPlant Electrical

496

SmartPlant Electrical User's Guide

SECTION 33

SmartPlant Electrical Off-Site Projects Reference


This section describes the various commands, dialog boxes, and Wizards used for implementing
off-site projects in SmartPlant Electrical.

In This Section
Save Project as Offsite Command (File Menu) ............................. 497
Save Project as Offsite Dialog Box ................................................ 498
Save Project for Reload Command (File Menu) ............................ 499
Save Project for Reload Dialog Box .............................................. 499
Save Plant for Merge in Host Command (File Menu) .................... 500
Save Plant for Merge in Host Dialog Box ...................................... 500
Load Offsite Plant Structure Command (File Menu) ..................... 501
Load Offsite Plant Structure Wizard .............................................. 501
Load Plant as Project Command (File Menu) ................................ 512
Load Plant as Project Dialog Box .................................................. 513
Load Standalone Project Command (File Menu) .......................... 514
Load Standalone Project Wizard ................................................... 514

Save Project as Offsite Command (File Menu)


Opens the Save Project as Offsite dialog box, which allows you to save a project from the host
site for the first time as a package. You can load the package later in order to create an off-site
plant As-Built for the first time.

SmartPlant Electrical User's Guide

497

Working with Off-Site Projects in SmartPlant Electrical

Save Project as Offsite Dialog Box

Name Type the name of the project.


Export plant to location Click the ellipsis button
to specify the path for the location of the
.zip file package to be created containing the project data.

Include applications
Select the application that you want to include in the off-site project. The available options are:
SmartPlant P&ID
SmartPlant Electrical
SmartPlant Instrumentation

Revision and version options


Allows you to include revisions and versions for SmartPlant P&ID and revisions for SmartPlant
Electrical with the saved off-site project if desired.
Include SmartPlant P&ID revisions Select to include SmartPlant P&ID revisions with the
package.
Include associated SmartPlant P&ID versions Select to save associated versions with the
package. This option is only available if you select Include SmartPlant P&ID revisions.
Include SmartPlant Electrical revisions Select to include SmartPlant Electrical revisions with
the package.

498

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Save Project for Reload Command (File Menu)


Opens the Save Project for Reload dialog box, which allows you to create a package with
re-scoped host site data.

Save Project for Reload Dialog Box

Name Type the name of the project.


Export plant to location Click the ellipsis button
to specify the path for the location of the
.zip file package to be created containing the project data.

Include applications
Select the application that you want to include in the saved project. The available options are:
SmartPlant P&ID
SmartPlant Electrical
SmartPlant Instrumentation

Revision and version options


Allows you to include revisions and versions for SmartPlant P&ID and revisions for SmartPlant
Electrical with the saved project if desired.
Include SmartPlant P&ID revisions Select to include SmartPlant P&ID revisions with the
package.
Include associated SmartPlant P&ID versions Select to save associated versions with the
package. This option is only available if you select Include SmartPlant P&ID revisions.
Include SmartPlant Electrical revisions Select to include SmartPlant Electrical revisions with
the package.

SmartPlant Electrical User's Guide

499

Working with Off-Site Projects in SmartPlant Electrical

Save Plant for Merge in Host Command (File Menu)


Opens the Save Plant for Merge in Host dialog box, which allows you to save a project from the
off-site plant as a package for re-importing modified data into the host site.

Save Plant for Merge in Host Dialog Box

Name Type the name of the project.


Export plant to location Click the ellipsis button
to specify the path for the location of the
.zip file package to be created containing the plant data.

Include applications
Select the application that you want to include in the plant. The available options are:
SmartPlant P&ID
SmartPlant Electrical
SmartPlant Instrumentation

Revision and version options


Allows you to include revisions and versions for SmartPlant P&ID and revisions for SmartPlant
Electrical with the saved plant if desired.
Include SmartPlant P&ID revisions Select to include SmartPlant P&ID revisions with the
package.
Include associated SmartPlant P&ID versions Select to save associated versions with the
package. This option is only available if you select Include SmartPlant P&ID revisions.
Include SmartPlant Electrical revisions Select to include SmartPlant Electrical revisions with
the package.

500

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Load Offsite Plant Structure Command (File Menu)


Opens the Load Offsite Plant Structure Wizard, which allows you to import into an off-site plant
for the first time a package that was created in the host plant.

Load Offsite Plant Structure Wizard


The Load Offsite Plant Structure wizard guides you through the required process to load into an
off-site plant a package that was created in the host plant. At the end of the process, the software
creates a new plant structure with a project containing all the plant items that were scoped from
the host.

Source Path (Load Offsite Plant Structure Wizard)


This page allows you to specify the location of the plant structure files for the copied plant or
project.
All paths must use the Universal Naming Convention (UNC) format and cannot exceed 255
characters.

Zip file of plant Specify the path to the location of the plant structure you want to load.

SmartPlant Electrical User's Guide

501

Working with Off-Site Projects in SmartPlant Electrical

Plant Name (Load Offsite Plant Structure Wizard)


This page allows you to view and define a name and description for the new plant root item.
An asterisk (*) at the end of an item name indicates a value is required for that item.

Plant group type Displays the plant group type of the root item.
Name Displays the name of the copied plant structure. You must change this name if you are
copying the plant structure to the same site. This name is limited to 80 characters and cannot
contain any of the following characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |
Description Type a description for the plant (optional). The description is limited to 240
characters.
Address Type an address identification for the plant. This option appears only if the plant
structure uses Hierarchy 2: Site/Plant/Unit or uses a hierarchy with the Site plant group type as the
root item.

502

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Associate Applications (Load Offsite Plant Structure Wizard)


Allows you to select the applications you want to associate with the selected plant structure. Any
combination can be made, that is, one, two, or all three applications can be selected. This
selection determines the order in which the software opens the wizard pages. The wizard pages
and the options displayed in the pages are application-specific and depend on the order in which
you select the applications.

Applications to associate Select the application that you want to associate with the plant
structure, the options are: SmartPlant P&ID, SmartPlant Electrical, and SmartPlant
Instrumentation.

If you want to associate SmartPlant Instrumentation, you must first configure the
SmartPlant Instrumentation database for the site server. For details, see Configuring a
SmartPlant Instrumentation Database.

SmartPlant Electrical User's Guide

503

Working with Off-Site Projects in SmartPlant Electrical

Target Paths (Load Offsite Plant Structure Wizard)


Defines the paths to the storage locations relevant for the plant data and drawings.

The paths for the plant structure and backup location must use the Universal Naming
Convention (UNC) format and cannot exceed 255 characters.
An asterisk (*) at the end of an item name indicates a value is required for that item.

Plant structure path Specify the path to the storage location for the plant data and the drawing
files. You must create the plant structure share before running this wizard, using the form
\\siteserver\sitename\plantname. The wizard will create the 'plantname' folder if it does not
already exist.
Backup location Specify the path to the shared storage folder for backing up the plant files.
Seed location Specify the location of your plant templates, the default seed location is the
SmartPlant Engineering Manager home folder.
Save seed location as the preferred setting Select to make the current seed location your
default setting.

504

Select a backup location outside the Plant structure path to avoid recursive backups being
stored in a single backup file. For example, if the Plant structure path is
\\siteserver\sitename\plantname, do not set the backup location for plantname to
\\siteserver\sitename\plantname\backups.
Be sure the backup location has plenty of available space because the restore process
generates a temporary folder in this backup location while the plant data is being
restored. This folder is removed when the process finishes.

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical


Location paths cannot contain any of the following characters: ~ ` ! % * ( ) { } [ ] / ; : ' " < > ,
?|

Database Information (Load Offsite Plant Structure Wizard)


Define the database for your plant structure. An asterisk (*) at the end of an item name indicates
that a value is required for that item.

Database type Displays the database type used by the site in which the plant will be created.
Oracle alias Type the name of the Oracle Net Service name as defined by your database
administrator. This option appears only if Oracle is selected as the database type.
Database node Type the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type. This node
name cannot contain any spaces.
System user Type a database system user name. This name does not have to be the
database administrator user name, but this user must have sysadmin privileges (for SQL Server)
or the DBA role (for Oracle).
System password Type the system password.

Oracle system passwords cannot contain any special characters other than: @ ('at' symbol), .
(period), and _ (underscore). SQL Server database passwords cannot contain the character: '
On an Oracle 10g platform using different instances, when exiting this Wizard page, you may
receive a message about having insufficient privileges to create the plant structure, followed by a
list of the required privileges. To fix this problem, you must create one or more of these privileges
manually using Oracle tools.

SmartPlant Electrical User's Guide

505

Working with Off-Site Projects in SmartPlant Electrical

Plant Schema (Load Offsite Plant Structure Wizard)


Allows you to specify the tablespace and user name for the plant schema. An asterisk (*) at the
end of an item name indicates a value is required for that item.
Database type Displays the database type used by the site in which the plant will be created.
Oracle service/alias Displays the Oracle Net Service alias specified previously in which the
plant will be created. This option appears only if Oracle is selected as the database type.
Database server Displays the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type.
Database name Select the name of the SQL Server database in which the plant will be
created. This option appears only if SQL Server is selected as the database type.
Oracle tablespace Select the default Oracle tablespace name for your plant database. These
tablespaces were defined when the database administrator created the default database instance
using Oracle Database Assistant. This option appears only if Oracle is selected as the database
type.
Oracle temp tablespace Select the default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator. This option appears only if
Oracle is selected as the database type on the previous page.

We recommend that you do not use SYSTEM for the default tablespace because Oracle uses
this tablespace for its own use.
If you create new Oracle tablespaces or SQL Server databases after starting this wizard, you
must refresh the tablespace list by clicking Back and then clicking Next to return to this page
before the new information will display in the appropriate lists.
Database username Type the user name you want to use for the plant schema user. This
value, which must be unique in the database, defaults to the plant name that you specified
earlier. For more information about default database user names, see Understanding Default
Database User Names.
Database password Type the password for the plant schema user. We recommend using the
database user name specified above as this password.
Confirm password Re-type the password for the plant schema user.

506

The software sets the related password defaults for the above user name automatically to
<default user name> for Oracle and to <default user name> + '1' for SQL Server. In the case
of SQL Server 2005 running on Windows Server 2003, if you are using SQL Server
authentication, you can specify that SQL Server 2005 is to use the password validation rules
that are used by Windows Server 2003.
Database usernames cannot start with a numeric digit and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the name in creating the
default database user names.
Oracle database passwords cannot contain the characters: " ' @
SQL Server database passwords cannot contain the character: '

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Plant Data Dictionary (Load Offsite Plant Structure Wizard)


Allows you to specify the tablespace and user name for the plant data dictionary. The data
dictionary contains database tables, database table attributes, item types, select list definitions,
and select list entries. An asterisk (*) at the end of an item name indicates a value is required for
that item.
Database type Displays the database type used by the site in which the plant will be created.
Oracle service/alias Displays the Oracle Net Service alias specified previously in which the
plant will be created. This option appears only if Oracle is selected as the database type.
Database server Displays the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type.
Database name Displays the name of the SQL Server database in which the plant will be
created. This option appears only if SQL Server is selected as the database type.
Oracle tablespace Select the default Oracle tablespace name for your plant database. These
tablespaces were defined when the database administrator created the default database instance
using Oracle Database Assistant. This option appears only if Oracle is selected as the database
type.
Oracle temp tablespace Select the default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator. This option appears only if
Oracle is selected as the database type on the previous page.

We recommend that you do not use SYSTEM for the default tablespace because Oracle uses
this tablespace for its own use.
If you create new Oracle tablespaces or SQL Server databases after starting this wizard, you
must refresh the tablespace list by clicking Back and then clicking Next to return to this page
before the new information will display in the appropriate lists.
Database username Type the user name you want to use for the plant data dictionary
user. This value, which must be unique in the database, defaults to the plant name that you
specified earlier, with the letter "d" appended. For more information about default database user
names, see Understanding Default Database User Names.
Database password Type the password for the plant data dictionary user. We recommend
using the database user name specified above as this password.
Confirm password Re-type the password for the plant data dictionary user.

The software sets the related password defaults for the above user name automatically to
<default user name> for Oracle and to <default user name> + '1' for SQL Server. In the case
of SQL Server 2005 running on Windows Server 2003, if you are using SQL Server
authentication, you can specify that SQL Server 2005 is to use the password validation rules
that are used by Windows Server 2003.
Database usernames cannot start with a numeric digit and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the name in creating the
default database user names.
Oracle database passwords cannot contain the characters: " ' @
SQL Server database passwords cannot contain the character: '

SmartPlant Electrical User's Guide

507

Working with Off-Site Projects in SmartPlant Electrical

SmartPlant Electrical Schema (Load Offsite Plant Structure


Wizard)
Defines the SmartPlant Electrical schema database information for your SmartPlant Electrical
plant structure.

This screen is only displayed if an application was associated to the plant structure selected
previously in the Applications to associate page of the wizard.
An asterisk (*) at the end of an item name indicates a value is required for that item.

Oracle service/alias Displays the Oracle Net Service alias specified previously in which the
plant will be created. This option appears only if Oracle is selected as the database type.
Database node Displays the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type.
Database name Displays the name of the SQL Server database in which the plant will be
created. This option appears only if SQL Server is selected as the database type.
Oracle tablespace Select the default Oracle tablespace name for your plant database. These
tablespaces were defined when the database administrator created the default database instance
using Oracle Database Assistant. This option appears only if Oracle is selected as the database
type.

508

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

We recommend that you do not use SYSTEM for the default tablespace because Oracle uses
this tablespace for its own uses.
If you create new Oracle tablespaces or SQL Server databases after starting this wizard, you
must refresh the tablespace list by clicking Back and then clicking Next to return to this page
before the new information will display in the appropriate lists.
Oracle temp tablespace Select the default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator. This option appears only if
Oracle is selected as the database type on the previous page.
Database username Type the user name you want to use for the SmartPlant Electrical
schema user. This value, which must be unique in the database, defaults to the plant name that
you specified earlier, with the letters "el" appended. For more information about default database
user names, see Understanding Default Database User Names.
Database password Displays the default database password, as set by the database
software. You can change the password for the SmartPlant Electrical database user by typing a
new password in the Database password field. We recommend using the default SmartPlant
Electrical user name defined above as this password.
Confirm password Re-type the password for the database user.
SmartPlant Electrical reference data path Taken from the Plant Structure Path as set
previously in the Target Paths screen of the wizard. To select a different path, type the required
path or click the ellipsis button
to browse to the reference data path for the application
options. This field is limited to 255 characters.

The software sets the related password defaults for the above user name automatically to
<default user name> for Oracle and to <default user name> + '1' for SQL Server. In the case
of SQL Server 2005 running on Windows Server 2003, if you are using SQL Server
authentication, you can specify that SQL Server 2005 is to use the password validation rules
that are used by Windows Server 2003.
Database usernames cannot start with a numeric digit and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the name in creating the
default database user names.
Oracle database passwords cannot contain the characters: " ' @
SQL Server database passwords cannot contain the character: '

SmartPlant Electrical Reference Schema (Load Offsite Plant


Structure Wizard)
Defines the SmartPlant Electrical reference schema database information for your SmartPlant
Electrical plant structure.

This screen is only displayed if SmartPlant Electrical was associated to the plant structure
selected previously in the Applications to associate page of the wizard.
An asterisk (*) at the end of an item name indicates a value is required for that item.
Application to associate Displays the application being associated. This value is carried
forward from the previous page.

SmartPlant Electrical User's Guide

509

Working with Off-Site Projects in SmartPlant Electrical


Schema type Displays the application schema type. This value is carried forward from the
previous page.
Oracle service/alias Displays the Oracle Net Service alias specified previously in which the
plant will be created. This option appears only if Oracle is selected as the database type.
Database node Displays the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type.
Database name Displays the name of the SQL Server database in which the plant will be
created. This option appears only if SQL Server is selected as the database type.
Oracle tablespace Select the default Oracle tablespace name for your plant database. These
tablespaces were defined when the database administrator created the default database instance
using Oracle Database Assistant. This option appears only if Oracle is selected as the database
type.

We recommend that you do not use SYSTEM for the default tablespace because Oracle uses
this tablespace for its own uses.
If you create new Oracle tablespaces or SQL Server databases after starting this wizard, you
must refresh the tablespace list by clicking Back and then clicking Next to return to this page
before the new information will display in the appropriate lists.
Oracle temp tablespace Select the default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator. This option appears only if
Oracle is selected as the database type on the previous page.
Database username Type the user name you want to use for the SmartPlant Electrical
reference schema user. This value, which must be unique in the database, defaults to the plant
name that you specified earlier, with the letters 'elref' appended. For more information about
default database user names, see Understanding Default Database User Names.
Database password Displays the default database password, as set by the database
software. You can change the password for the SmartPlant Electrical database user by typing a
new password in the Database password field. We recommend using the default SmartPlant
Electrical user name defined above as this password.
Confirm password Re-type the password for the database user.

510

The software sets the related password defaults for the above user name automatically to
<default user name> for Oracle and to <default user name> + '1' for SQL Server. In the case
of SQL Server 2005 running on Windows Server 2003, if you are using SQL Server
authentication, you can specify that SQL Server 2005 is to use the password validation rules
that are used by Windows Server 2003.
Database usernames cannot start with a numeric digit and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |
Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the name in creating the
default database user names.
Oracle database passwords cannot contain the characters: " ' @
SQL Server database passwords cannot contain the character: '

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

SmartPlant Electrical Data Dictionary (Load Offsite Plant


Structure Wizard)
Allows you to enter all of the database and user information for SmartPlant Electrical data
dictionary. The tablespaces and other database information displayed in the drop-down lists are
based on the database used in the plant structure creation. The database user name must be
unique.
An asterisk (*) means a value is required for that box.
Application to associate Displays the application being associated. This value is carried
forward from the previous page.
Schema type Displays the application schema type. This value is carried forward from the
previous page.
Oracle service/alias Specifies the Oracle Net Service name as defined by your database
administrator. This value is carried forward from the plant structure definition and appears only if
using Oracle.
Database node Displays the Node Name of the server on which the SQL Server database
resides. This option appears only if SQL Server is selected as the database type.
Database name Displays the name of the SQL Server database in which the plant will be
created. This option appears only if SQL Server is selected as the database type.
Oracle tablespace Select the default Oracle tablespace name for your plant database. These
tablespaces were defined when the database administrator created the default database instance
using Oracle Database Assistant. This option appears only if Oracle is selected as the database
type.
Oracle temp tablespace Select the default Oracle temporary tablespace name for your plant
database. If this list is empty, contact your database administrator. This option appears only if
Oracle is selected as the database type on the previous page.

We recommend that you do not use SYSTEM for the default tablespace because Oracle uses
this tablespace for its own use.
If you create new Oracle tablespaces or SQL Server databases after starting this wizard, you
must refresh the tablespace list by clicking Back and then clicking Next to return to this page
before the new information will display in the appropriate lists.
Database username Type the user name you want to use for the application data dictionary
user. This value, which must be unique in the database, defaults to the plant name that you
specified earlier, with the letters 'eld' appended. For more information about default database
user names, see Understanding Default Database User Names.
Database password Type the password for the application data dictionary user. We
recommend using the application data dictionary user name defined in the field above as this
password.
Confirm password Re-type the password for the database user.

The software sets the related password defaults for the above user name automatically to
<default user name> for Oracle and to <default user name> + '1' for SQL Server. In the case
of SQL Server 2005 running on Windows Server 2003, if you are using SQL Server
authentication, you can specify that SQL Server 2005 is to use the password validation rules
that are used by Windows Server 2003.
Database usernames cannot start with a numeric digit and cannot contain any of the following
characters: ~ ` ! % ^ & * ( ) - + = { } [ ] \ / ; : " < > , . ? |

SmartPlant Electrical User's Guide

511

Working with Off-Site Projects in SmartPlant Electrical

Oracle database user names are limited to 30 characters. Because plant names can be up to
64 characters long, the software uses only the first 12 characters of the name in creating the
default database user names.
Oracle database passwords cannot contain the characters: " ' @
SQL Server database passwords cannot contain the character: '

Summary (Load Offsite Plant Structure Wizard)


Displays the settings you defined for loading your plant structure. Review these settings
carefully. If you are satisfied with the settings, click Finish. Otherwise, click Back to change one
or more of the settings.

Load Plant as Project Command (File Menu)


Opens the Load Plant as Project dialog box, which allows you to load a saved plant .zip file as a
project in the selected plant.
This command is enabled only if the plant is associated with SmartPlant Electrical alone
and not with any other application and only after the Enable Projects command has been run for
the plant.

512

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Load Plant as Project Dialog Box


This window allows you to select a source plant structure created from a Greenfield plant for
loading into your current plant as a new project.

Zip file of plant Specify the path to the location of the plant structure you want to load.
Project name The name of the new project, which comes from the name of the selected
source plant.
Project description If a description of the selected source plant exists, it appears in this field
as the description of the new project.

Mapping
Allows you to map the target plant groups in your current plant to the source that is used as the
basis of the new project.

SmartPlant Electrical User's Guide

513

Working with Off-Site Projects in SmartPlant Electrical


Mapped plant groups
Shows the relationship between the source and target plant groups.
Source Displays all the plant groups in the hierarchy of the selected source for mapping with
the target plant groups.
Target Displays the target plant groups that have been mapped to the sources.

Target plant groups


Shows the plant hierarchy for use in the mapping. To perform mapping, select a plant group at a
particular level and drag it to the Target column beside a suitable source plant group or select a
target and a source item and then click Map.
Include all parent plant groups of selected plant group when mapping The state of this
check box affects the outcome when you click the Map command. When this check box is
cleared, the Map command maps the selected target item to the highlighted source item. When it
is selected, the Map command maps the selected target item and all of its parent items in the
hierarchy to the appropriate source items. This option is only available if the plant group types
and number of levels in the target plant hierarchy match those in the source plant hierarchy.
Map Maps the selected source and target plant groups.
Unmap Removes the mapping between the source and target plant groups from the selected
row in the Mapped plant groups pane.
Map All Maps all the source and target plant groups. This option is only available if the source
and target plant hierarchies are based on identical templates.
Show Unmapped / Show All Toggles the list in the Mapped plant groups pane between
displaying only the rows that have unmapped source plant groups and displaying all the source
plant groups.
Locate Source Opens a dialog box displaying the selected source plant group in its location in
the plant hierarchy.

Load Standalone Project Command (File Menu)


Opens the Load Standalone Project Wizard, which allows you to import a package containing
modified data into a host site or to import a package containing re-scoped host data into an off-site
plant.

Load Standalone Project Wizard


The Load Standalone Project wizard guides you through the required process to load into an
off-site plant a package containing re-scoped host data.

514

SmartPlant Electrical User's Guide

Working with Off-Site Projects in SmartPlant Electrical

Source Path (Load Standalone Project Wizard)


This page allows you to specify the location of the plant structure files for the copied plant or
project.
All paths must use the Universal Naming Convention (UNC) format and cannot exceed 255
characters.

Zip file of plant Specify the path to the location of the plant structure you want to load.

SmartPlant Electrical User's Guide

515

Working with Off-Site Projects in SmartPlant Electrical

Summary (Load Standalone Project Wizard)


Displays the settings you defined for loading your plant structure. Review these settings
carefully. If you are satisfied with the settings, click Finish. Otherwise, click Back to change one
or more of the settings.

516

SmartPlant Electrical User's Guide

SECTION 34

Working with SmartPlant Integration


SmartPlant integration standardizes and improves the communication among the various
authoring tools you use in the course of designing, constructing, and operating a
plant. SmartPlant integration manages data exchange among these authoring tools, which
enables sharing and re-use of plant information throughout the plant life-cycle. SmartPlant
Foundation acts as a repository for data and a medium through which information is shared
among other tools, such as SmartPlant Instrumentation, SmartPlant P&ID, and SmartPlant 3D.
Most of the commands that provide access to SmartPlant integration functionality exist in the
common user interface available on the SmartPlant menu in Engineering Manager, SmartPlant
Instrumentation, SmartPlant Electrical, SmartPlant P&ID, and Drawing Manager.
The following graphic displays what SmartPlant Electrical publishes and retrieves and shows the
flow of data and the different types of data.

SmartPlant Electrical interacts with SmartPlant Foundation by correlating items between the plant
database and the SmartPlant Foundation database, retrieving documents such as Electrical
Power Elements, Electrical Signal List, Cable Schedule reports, and P&IDs, from SmartPlant
Foundation. Also, SmartPlant Electrical creates a set of tasks in the To Do List that you can run
to update the plant database. In SmartPlant Electrical, you can also use the commands on the
SmartPlant menu to publish documents and retrieve data, access the SmartPlant Foundation

SmartPlant Electrical User's Guide

517

Working with SmartPlant Integration


Web Portal in order to browse in SmartPlant Foundation, and subscribe to change notifications
and compare documents. For more information, see SmartPlant Engineering Manager Help.

Registering Tools
Before you can publish and retrieve documents from any of the other authoring tools, such as
SmartPlant P&ID or SmartPlant Instrumentation, you must register each plant in SmartPlant
Electrical with a SmartPlant Foundation database. The connection allows SmartPlant Electrical
to use the commands on the SmartPlant menu. A SmartPlant Engineering Manager
administrator typically registers a plant.
The software maps a plant and all its projects to a single SmartPlant Foundation URL, which
points to one, and only one, SmartPlant Foundation plant database and its projects. When you
use the Register command in any of the authoring tools, you are registering an authoring tool
plant with a SmartPlant Foundation URL and plant that you specify.
The system administrator must register each plant in the authoring tool once; this action takes
place in SmartPlant Engineering Manager. After the plant is registered, you can publish and
retrieve documents.

See Also
Access the SmartPlant Foundation Web Client (on page 520)
Schema Mapping (on page 521)
Publishing (see "Publishing Documents" on page 543)

Tool Requirements for Integrating SmartPlant


Electrical
This topic describes rules and settings that allow SmartPlant Electrical data to be shared correctly
with SmartPlant 3D, SmartPlant Instrumentation and SmartPlant P&ID, and the other tools that
are part of an integrated environment. Other tools that are not listed here have no known
SmartPlant Electrical / SmartPlant integration issues.

Working with SmartPlant Instrumentation


In order to have a successful data exchange between SmartPlant Electrical and SmartPlant
Instrumentation, make sure that:
Both SmartPlant Electrical and SmartPlant Instrumentation have the same plant hierarchy
structure
In SmartPlant Instrumentation, instruments and I/O signals are defined on the lowest plant
hierarchy level
In SmartPlant Instrumentation, cabinets are defined on the highest plant hierarchy level
In SmartPlant Electrical, you defined a registered report for both the I/O lists and for
Instruments requiring power supply.
You must also ensure that the following SmartPlant Electrical select lists and SmartPlant
Instrumentation supporting tables contain identical values:
System I/0 type
Rated Voltage
Power Supply AC/DC Flag
Number of Phases
Operating Mode
Process Function

518

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


Frequency
Furthermore, in SmartPlant Electrical Options Manager, in the General Settings window, you
need to make the following changes:
For the SmartPlant Instrumentation Default Domain setting, specify the name of a
SmartPlant Instrumentation domain which you want to set as a source domain for retrieving
detailed wiring data to be included in schematics.
If you want to retrieve enhanced reports to be included in schematics, select Yes for the
setting Include Enhanced Reports in Schematics.
In the two tools, the units of measure of certain properties might be defined using a different
precision accuracy. For example, 1.2 kW (one-digit accuracy of precision) in SmartPlant
Electrical corresponds to 1.23 kW (two-digit accuracy of precision) in SmartPlant
Instrumentation. This may result in inconsistencies and could be interpreted as an update when
retrieving data.
These properties are:
Rated Active Power
Rated Reactive Power
Rated Apparent Power
Full Load Current
Operating Mode Coincidence Factors (X, Y, Z, ZZ)
Starting Current

Working with SmartPlant 3D


In order to have a successful data exchange between SmartPlant Electrical and SmartPlant 3D,
make sure that SmartPlant Electrical reference cables used in the project match the cables
SmartPlant 3D has in its Catalog. SmartPlant 3D identifies the type of the retrieved cable by
looking at the reference cable name in the Catalog; if this cable in the Catalog does not exist, the
retrieved cable is identified as an unknown cable for cable routing purposes.

SmartPlant Electrical ships a sample report named Reference Data Cables Interface to
SmartPlant 3D, that you can use as a source to be transferred to SmartPlant 3D, so that
SmartPlant 3D users can create their Catalog using the report data.
If cables that originated in SmartPlant Electrical were subsequently deleted in SmartPlant 3D
and then published back from SmartPlant 3D, SmartPlant Electrical does not generate Delete
tasks for those cables.
Make sure that the following select lists in SmartPlant Electrical must match the content of the
related select lists in SmartPlant 3D:
Routing status
Segregation level
SmartPlant Electrical also publishes to SmartPlant 3D the relations to the cable side 1 and side
2. If SmartPlant 3D does not contain the relations, SmartPlant 3D cannot perform cable routing.
This means that:
In SmartPlant Electrical, the cables must have their side 1 and side 2 associated before
publishing.
In SmartPlant 3D, users must make sure that each object referenced in the cable sides has a
corresponding object in the SmartPlant 3D data model.

SmartPlant Electrical User's Guide

519

Working with SmartPlant Integration

Working with SmartPlant P&ID


SmartPlant Electrical can retrieve items of electrical equipment that were published from
SmartPlant P&ID. Electrical equipment in SmartPlant P&ID constitutes electrical motors and
heaters only.
SmartPlant Electrical retrieves any items of process equipment that are associated with the
electrical equipment: for example, if a motor is associated with a pump in SmartPlant P&ID, the
pump is retrieved along with the motor in SmartPlant Electrical. Likewise, if the software retrieves
a heater that is associated with a vessel, then that vessel is also retrieved. The software also
supports retrieval of multiple electrical equipment associations to a single item of process
equipment, for example, where several heaters are used to heat up one vessel. Note that
SmartPlant Electrical does not retrieve items of process equipment that are not associated with
electrical items.
When SmartPlant P&ID and SmartPlant Electrical are both enabled for a plant, they
are both enabled for all projects of that plant. If a project requires only one of these applications,
create separate plants for each application, and then enable SmartPlant P&ID for one plant and
SmartPlant Electrical for the other.
When retrieving an item of mechanical equipment associated with a motor from SmartPlant
P&ID, the numerical value and units of measure of the Power Driver Rated property as set in
SmartPlant P&ID must exactly match an existing value of the Motor Rated Power property in
SmartPlant Electrical for the task to run successfully. In addition, if you run the SmartPlant
Electrical command to copy the value of the process equipment Absorbed Power property to the
motor Brake Power property, the software only validates values of the brake power that do not
exceed the motor rated power, as determined by the standard SmartPlant Electrical rule.

Using Projects in an Integrated Environment


When working in an integrated environment with a plant that has projects, you need to make the
following changes in SmartPlant Electrical Options Manager, in the General Settings window:
For the Allow Full Access to As-Built setting, select No. To use such a plant in an
integrated environment, you must ensure that it is not possible to change As-Built data in
As-Built itself. After you select No for this setting, the software can only update As-Built when
you merge project data with As-Built.
For the As-Built Claim Mode setting, select Exclusive. SmartPlant integration does not
support having the same item claimed for different projects.

See Also
Publishing (see "Publishing Documents" on page 543)

Access the SmartPlant Foundation Web Client

Click SmartPlant > Browser.

This command is available only if the active plant has been registered. For more information,
see SmartPlant Engineering Manager Help.
From the SmartPlant Foundation Web Client, you can perform a number of tasks, such as
publishing or retrieving documents, comparing documents, subscribing to document changes,
and so forth. Many of these tasks can be performed from the authoring tools, such as
SmartPlant Instrumentation or SmartPlant P&ID, but the Web Client provides unique access
to other features such as the Web Client To Do List and search capabilities.

520

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Schema Mapping
This section describes the assumptions, rules, and limitations imposed by the SmartPlant
Electrical adapter on schema mapping.
This section describes the structure of the tool schema and how it is used by the authoring tool
SmartPlant integration adapter in support of the publish and retrieve operations. This topic does
not provide a list of the classes, properties, or enumerated lists (select lists) that are mapped by
the delivered SmartPlant Electrical tool schema. You can obtain this information by viewing the
tool schema directly. This set of topics does not describe the user interface of the Schema Editor.
Before modifying the mapping for SmartPlant Electrical, you must understand:
The SmartPlant Electrical software
The SmartPlant Electrical data model
The delivered mapping for SmartPlant Electrical
How the delivered mapping for SmartPlant Electrical works
SmartPlant schema modeling
The Schema Editor
The To Do List feature of SmartPlant Electrical
In the topics that describe schema mapping, the following terms are frequently referenced:
Tool schema Defines the SmartPlant Electrical objects to be published or retrieved and how
they map to objects in the SmartPlant schema. The tool schema implements mapping
between the objects in the SmartPlant Electrical data model and the objects in the SmartPlant
schema. Users who customize either the SmartPlant Electrical data model or the SmartPlant
schema may also need to customize the mapping contained in the tool schema.
SmartPlant schema Defines the SmartPlant integration data model.
Adapter The SmartPlant Electrical code module that supports the SmartPlant integration
commands.
When you publish SmartPlant Electrical data, the SmartPlant integration adapter extracts data
from the SmartPlant Electrical database and converts it into a set of objects and relationships that
are compatible with the SmartPlant schema. These objects and relationships are defined in an
.xml file, which is sent to SmartPlant Foundation for further processing. For SmartPlant Electrical,
the name of this file is SPELMap.xml, and it is located in the SmartPlant Electrical home folder.

General Information About Schema Mapping


This topic provides general information about the mapping in SmartPlant Electrical.

SmartPlant Electrical Adapter


Each authoring tool has an adapter that processes information during the publish and retrieve
operations. One of the adapter's functions is to map information between the SmartPlant
Foundation database and the particular authoring tool. The SmartPlant Electrical adapter is a
component that belongs to SmartPlant Electrical and requires installation of SmartPlant Electrical
Version 2009 on Oracle 9i, Oracle 10.2.0.4, or SQL Server 2000. Any communication between
SmartPlant Foundation and SmartPlant Electrical is performed via this adapter, which sends
information to SmartPlant Foundation through the Common UI where the user is shown the
appropriate user interface and data available.

SmartPlant Electrical User's Guide

521

Working with SmartPlant Integration


The adapter does not handle tool schema files directly, but uses them indirectly. The tool schema
files are used to define the retrieve map file, which is then used by the adapter. Direct use of the
schema files would mean that the adapter accessed them directly to do its work. Both retrieve
and publish operations only work through map files.

Mapping Configuration
The SmartPlant Electrical adapter uses the tool schema map file and the Schema Editor,
delivered with the SmartPlant Schema Component, to perform mapping between the SmartPlant
Electrical object structure and the structure of objects in the SmartPlant schema. The map file is
installed with SmartPlant Electrical Setup. This file includes all objects that are mapped for
SmartPlant (not all objects that exist in SmartPlant Electrical, not all properties, only those that can
be of any relevance for other applications that use SmartPlant ). In accordance with the
SmartPlant Electrical data model, the Schema Editor knows what SmartPlant Electrical object to
put a property on.

Tool Schema Location


The name of the SmartPlant Electrical tool schema file is SPELMap.xml. SmartPlant Electrical
uses this file for all types of published and retrieved documents. This file must exist in the
installation home folder of SmartPlant Electrical. The SPELMap.xml should be treated as an
installation file. Although, using the Schema Editor, it is possible to change the content of the
map file, the file name must remain SPELMap.xml.

Mapping Rules and Limitations


Schema mapping in SmartPlant Electrical has some important rules and limitations.

Rules for Mapping Documents and SmartPlant Foundation Revisions


In SmartPlant Electrical, a document object has various properties but only the document type
property is mapped to a document category enumeration list in the SmartPlant schema. A list of
SmartPlant Electrical documents that can be published and retrieved is defined in the SmartPlant
schema and can be viewed in the Schema Editor.
Also, SmartPlant Electrical adapter supports mapping of SmartPlant Foundation
revisions. Whenever a SmartPlant Electrical user creates a new revision, the SmartPlant Client
calls a common dialog box in which the user defines the revision schema and the revision number,
this number is saved in SmartPlant Foundation and SmartPlant Foundation returns this number to
SmartPlant Electrical via the adapter.

Rules for Property Naming


The names of the properties in the SmartPlant Electrical tool schema must exactly match the
names of the properties in the SmartPlant Electrical data model, including the case.

Limitations of the SmartPlant Schema


The retrieve map is updated directly from the contents defined in the SmartPlant schema;
therefore, the following restriction on the SmartPlant schema exists: in rare cases, if an entry is
removed from the SmartPlant schema, you may need to edit the retrieve map file to remove the
deleted entry. You should use the Schema Editor delivered with the SmartPlant Schema
Component for this purpose.

522

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


Map File Location and Definition Restrictions
You cannot change the location of the map file SPELMap.xml, installed in the SmartPlant
Electrical home folder. During publish and retrieve operations, the adapter looks for the map file
only in the SmartPlant Electrical home folder. Although, using the Schema Editor, it is possible to
change the content of the map file, the file name must remain SPELMap.xml.

Equipment Inheritance Mapping Restrictions


Currently, SmartPlant Electrical equipment inheritance is not implemented in the tool
schema. This is a subject of future development. You have to map properties of equipment
manually. Since there is no equipment inheritance, mapping is only performed on the level of a
concrete (tangible) object class. To define relationships between various object classes,
interfaces in the tool schema are used. Interfaces in the tool schema do not contain properties.

Objects and Relationships


This topic describes objects and object relationships that are relevant to the SmartPlant Electrical
tool schema. Relationship descriptions reference names shown in a diagram that represents the
data model of the SmartPlant Electrical tool schema. For details, see Tool Schema Data Model
Diagram (on page 529).

MapClass
The MapClass object corresponds to the IMapClassDef interface in the Tool Schema Data Model
diagram. In general, there is a MapClass object in the tool schema for each SmartPlant Electrical
class (ItemType) that needs to be published or retrieved. MapClass is referred to as
SPMapClassDef in the Schema Editor user interface. The properties and relationships for a
MapClass object can be viewed in the Edit Map Class Definition dialog box.

General
Property

Description

UID

The property value is required, must be unique, with all


characters in upper case. UID of a map class must be
SPEL_<CLASSNAME>, where CLASSNAME is the
name of a corresponding item type in the SmartPlant
Electrical data model. For example, the UID of the
Motor class must be SPEL_MOTOR.

Name

The property value is required. This property


designates the internal name of the SmartPlant
Electrical item type, exactly as defined in the Data
Dictionary.

SmartPlant Electrical User's Guide

523

Working with SmartPlant Integration


Tool Schema Relationships
Relationship

Description

Map Properties

The map properties associated with the


MapClass object must be defined and related to
the MapClass object. The relationship name in
the diagram is MapClassMapProperties

Mapping Relationships
Relationship

Description

Publish to SmartPlant
Class

This relationship must be set to a class


in the SmartPlant schema if this class is
to be published. When this relationship
is set, an instance of the target class is
published for each instance of the
source class in the document being
published. The relationship name in the
diagram is MapClassToClass.

Retrieve from SmartPlant The list of interfaces from which


interface
properties are to be retrieved must be
set if this class is to be used for
retrieval. The relationship name in the
diagram is ClassToMapClass.

MapProperty
The MapProperty object corresponds to the IMapPropertyDef interface in the Tool Schema Data
Model diagram. In general, there is a MapProperty object in the tool schema for each SmartPlant
Electrical property that needs to be published or retrieved. The properties and relationships for a
MapProperty object can be viewed in the Edit Map Property Definition dialog box.

524

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


General
Property

Description

UID

The property value is required, must be unique, with all characters in


upper case. UID of a map property must be
SPEL_<CLASSNAME>_<PROPERTYNAME>. For example, UID of
Motor.ItemTag property must be SPEL_MOTOR_ITEMTAG.

Name

The property value is required. This property designates the internal


name of the SmartPlant Electrical attribute, as defined in the Data
Dictionary.

Process
Criteria

Process criteria are used when retrieving properties of SmartPlant


Electrical objects in the following case:
1. In SmartPlant Electrical, there is an object mapped to an object in
the SmartPlant schema, for example SPEL_A to SmartPlant_A.
2. Not all of the SmartPlant Electrical object properties are mapped to
the properties of the mapped object in the SmartPlant schema.
For example, SPEL_A_Property_A is mapped to
SmartPlant_A_Property_A but SPEL_A_Property_B is not mapped
in the SmartPlant_A object because SmartPlant_A does not contain
the corresponding property SmartPlant_A_Property_B.
3. The corresponding property is available in another SmartPlant
schema object, for example, SmartPlant_AA. To map the
SPEL_A_Property_B, a relationship must exist between the
SmartPlant_A and SmartPlant_AA objects.
A relationship is designated by a text string that corresponds to the
process criteria setting of the SPEL_A_Property_B property in
SmartPlant Electrical. If there are intermediate objects between the
mapped SmartPlant schema object and the object in the SmartPlant
schema that has the required property, the process criteria of the
property in SmartPlant Electrical must contain all relationship definitions
of SmartPlant schema objects, separated by a comma delimiter.

Tool Schema Relationships


Relationship

Description

Exposed by Map
Classes

Every MapProperty object must be related to a


MapClass object. The relationship name in the diagram
is MapClassMapProperties.

Scoped by Enumeration

If the data type of the property is enumerated, the


MapProperty object must be related to a MapEnumList
object. If the data type of the property is UoM, the
MapProperty must be related to a MapUoMList
object. Otherwise, this relationship is not needed. The
relationship name in the diagram is
MapPropertyMapEnumList.

SmartPlant Electrical User's Guide

525

Working with SmartPlant Integration


Mapping Relationships
Relationship

Description

Map Property to Property This relationship defines the property in the SmartPlant
schema to which this tool property is to be published. If
this relationship is not defined, the property will not be
published. The relationship name in the diagram is
MapPropertyToProperty.
Property to Map Property This relationship defines the property in the SmartPlant
schema from which this tool property is to be
retrieved. If this relationship is not defined, the property
will not be retrieved. The relationship name in the
diagram is PropertyToMapProperty.

MapEnumList
The MapEnumList object corresponds to the IMapEnumListDef interface in the Tool Schema Data
Model diagram. In general, there is a MapEnumList object in the tool schema for each
SmartPlant Electrical enumerated list associated with a property that needs to be published or
retrieved. The properties and relationships for a MapEnumList object can be viewed in the Edit
Map Enumerated List Definition dialog box.

General
Property

Description

UID

The property value is required, must be unique,


characters are not case-sensitive. UID of an
enumerated list must be
SPEL_<EnumListName>. For example, UID of the
YesNo enum list must be SPEL_YesNo.

Name

The value of this property is the name of the


SmartPlant Electrical enum list.

Tool Schema Relationships

526

Relationship

Description

Scoped Map
Properties

A MapEnumList object must be related to


the MapProperty objects that it
scopes. The relationship name in the
diagram is MapPropertyMapEnumList.

Contains

A MapEnumList object can contain a


variable number of MapEnum objects. The
relationship name in the diagram is
MapEnumListMapEnum.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


Mapping Relationships
Relationship

Description

Maps To

To support the publish operation, a MapEnumList


object should be related to the corresponding
enum list in the SmartPlant schema by means of
the Maps To relationship. The relationship name
in the diagram is MapEnumListToEnumList.

Maps From

To support the retrieve operation, a MapEnumList


object should be related to the corresponding
enum list in the SmartPlant schema by means of
the Mapped From relationship. The relationship
name in the diagram is EnumListToMapEnumList.

SmartPlant Electrical User's Guide

527

Working with SmartPlant Integration

MapEnum
The MapEnum object corresponds to the IMapEnumDef interface in the Tool Schema Data Model
diagram. In general, there is a MapEnum object in the tool schema for each SmartPlant Electrical
enumerated list entry that needs to be mapped. The properties and relationships for a MapEnum
object can be viewed in the Edit Map Enumerated List Definition dialog box (the same dialog
box is used for MapEnumList objects.)

General
Property

Description

UID

The property value must be unique. UID of an


enumerated list entry must be
SPEL_<EnumListName>_<CodelistIndex>, where
CodelistIndex is the value of the index of the
corresponding select list entry in the SmartPlant
Electrical data model. Values of codelist index are
stored in the Data Dictionary table CODELISTS. For
example, UID of the Yes entry of the YesNo enum list
must be SPEL_YesNo_1.

Name

The value of this property is a text setting of the


SmartPlant Electrical enum list entry.

Tool Schema Relationships


Relationship

Description

Contained In

Every MapEnum object must be related to a


MapEnumList object. The relationship name in
the diagram is MapEnumListMapEnum.

Mapping Relationships

528

Relationship

Description

Maps To

This relationship defines the SmartPlant schema


enum value to which this SmartPlant Electrical
enum value is to be published. If this relationship
is not defined, the enum value will not be
published. The relationship name in the diagram
is MapEnumToEnum.

Maps From

This relationship defines the SmartPlant


Electrical enum value to which the SmartPlant
schema enum value is to be retrieved. If this
relationship is not defined, the enum value will not
be retrieved. The relationship name in the
diagram is EnumToMapEnum.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Tool Schema Data Model Diagram


The diagram below shows a representation of the objects and relationships that are relevant to the
SmartPlant Electrical tool schema. The rectangles on the left side of the diagram represent
objects within the tool schema. The rectangles on the right represent objects within the
SmartPlant schema. The relationships that connect objects on the left with objects on the right
are the mapping relationships. The map file contains both the tool schema objects and the
mapping relationships.

SmartPlant Electrical User's Guide

529

Working with SmartPlant Integration

SmartPlant Electrical Mapping Examples


The sections that follow provide mapping examples for SmartPlant Electrical. For more
information and mapping examples, see the SmartPlant Mapping User's Guide.

SmartPlant Electrical Example: Mapping a New Enumerated List


Starting in the Tool
The following topic provides an example of adding and defining mapping for a new complex
property called Engineering System and its entries starting in Data Dictionary Manager.

Before You Begin


1. Make a backup of the SmartPlant Foundation site database and any vaults for the site.
2. Make a backup of the SmartPlant Electrical database and the SPELMap.xml file located in the
SmartPlant resources directory.

Create the New Engineering System Property in Data Dictionary Manager


1. Click Start > All Programs > Intergraph SmartPlant Engineering Manager > Data
Dictionary Manager.
2. Connect to the appropriate plant server for SmartPlant Electrical.
3. Click Select List on the left side of the Data Dictionary Manager window.
4. In the first empty row in the Select List table, type EngSys as the name.
5. Select None from the Dependent List.
6. Click Select Entry on the left side of the Data Dictionary Manager window.
7. Under Selected List, select EngSys.
8. Click Add Row, and enter the following values:
Value

Short Value

AA

Steam Gen & Fired Htr, Water/Steam Side

BA

Steam Generator and Fired Heater, Air/Gas Side

CA

Ammonia/Urea

DC

Crude Oil Production

EA

Auxiliary AC Power Systems

9. Click Database Tables, then click Plant Item.


10. Click Edit > Add Property
.
11. In the Add Property dialog box, type the characteristics in the following table:

530

Property

Value

Name

EngSystem

Display Name

Engineering System

Data Type

Select List

Select List

EngSys

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


Format

Variable Length

Default Value

None

Display to User

Yes

User for Filtering

Yes

Category

Miscellaneous

Depends on

None

12. Click OK.


13. Click File > Save.
14. Click File > Exit.

Launch Schema Editor and Synchronize the Tool Map Schema


1. In the Desktop Client, check out the SmartPlant schema CMF file and launch the Schema
Editor.

SmartPlant Electrical User's Guide

531

Working with SmartPlant Integration


2. In the Set Active Configurations dialog box, select the schema version or versions that you
want your changes to apply to, and click OK.

3. In the Schema Editor, synchronize the authoring tool map schema for which you want to
define mapping.
The new enumerated list entry that you added in the authoring tool appears in the
Synchronization dialog box to be added to the tool map schema file.

Add the New Enumerated List to the Schema


1. In the Map Environment, expand SmartPlant Electrical > Loaded Map Schemas >
SmartPlant Electrical Tool Schema.
2. Expand the Map Enumerated Lists node, and right-click EngSys.
3. On the shortcut menu, click Edit SP_12001.
4. In the Edit Map Enumerated List Definition dialog box, click Advanced.

532

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


5. Expand MapEnum.
6. At the bottom of the dialog box, click New SmartPlant Enumerated List with Correlated
Entries.

7.
8.
9.
10.
11.
12.

In the Map Enumerated Lists node, right-click EngSys.


On the shortcut menu, click Edit SP_12001.
In the Edit Map Enumerated List Definition dialog box, click Publish.
Under SmartPlant, right-click EngSys.
On the shortcut menu, click Edit EngSys.
Click each entry, and under Overview, edit the number to match the values in the following
table:
Name/Short
Description

Long Description

Number

AA

Steam Gen & Fired Htr, Water/Steam Side

10111

BA

Steam Generator and Fired Heater, Air/Gas Side 10112

CA

Ammonia/Urea

10113

DC

Crude Oil Production

10114

EA

Auxiliary AC Power Systems

10115

SmartPlant Electrical User's Guide

533

Working with SmartPlant Integration

13. Click OK.

Add the New Property to the Schema


1.
2.
3.
4.

In the Map Classes node, right-click Motor.


On the shortcut menu, click Edit SPEL_MOTOR.
Click Publish.
Under SmartPlant, select Identification.

5. Above Unmapped SmartPlant properties on the right side of the dialog box, click New
Property Definition

534

on the toolbar.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


6. In the New Property Definition dialog box, define the new SmartPlant schema
EngineeringSys property, and click OK to create the property definition.

In the Exposed by interface definitions box, click


, and select IPBSItem as the
interface definition that exposes this property.
In the Scoped by property type box, be sure to select EngSys as the property type.
7. Under Unmapped application properties, select EngSystem.
8. Under Unmapped SmartPlant properties, select EngineeringSys.
9. On the toolbar, click Map

Save the Tool Map Schema and Schema Extensions File

Click File > Save > All Modified Files to save the SmartPlant schema extensions and the tool
map schema. For some tools, saving the tool map schema also saves changes to the tool
metadata database.

When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file.
If you extend the SmartPlant schema, you must load the changes into the SmartPlant
Foundation database. For more information, see the SmartPlant Schema Editor User's Guide.

SmartPlant Electrical User's Guide

535

Working with SmartPlant Integration

SmartPlant Electrical Example: Mapping a New String Property


Starting in the Tool
The following topic provides an example of adding and defining mapping for a simple string
property called SystemCode1 for SmartPlant Electrical.

Before You Begin


1. Make a backup of the SmartPlant Foundation site database and any vaults for the site.
2. Make a backup of the SmartPlant Electrical database and the SPELMap.xml file located in the
SmartPlant resources directory.

Create the New SystemCode1 Property in Data Dictionary Manager


1. Click Start > All Programs > Intergraph SmartPlant Engineering Manager > Data
Dictionary Manager.
2. Connect to the appropriate plant server for SmartPlant Electrical.
3. Select SmartPlant Electrical under application type and click Open.

536

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


4. In the Database Tables list, click Plant Item.

5. On the toolbar, click Add Property


.
6. In the Add Property dialog box, define information for the System Code property, and click
OK. Be sure to select String in the Data Type list.

7. Click File > Save to save your changes in Data Dictionary Manager.
8. Click File > Exit.

SmartPlant Electrical User's Guide

537

Working with SmartPlant Integration


Analyze the Schema
Before adding the property, determine the best interface definition is realized by the majority of
class definitions. Every interface definition is realized by one or more class definitions. Interface
definitions expose the property definitions for class definitions. By sharing specific interface
definitions, class definitions can also share property definitions, but not the data associated with
the properties.
1. In the Desktop Client, check out the SmartPlant schema CMF file and launch the Schema
Editor.
2. In the Set Active Configurations dialog box, select the schema version or versions that you
want your changes to apply to, and click OK.

3. After you open the SmartPlant schema in the Schema Editor, to the right of Another Schema
File in the Overall Workflows dialog box, click View.
4. On the View Schema dialog box, select Tree/Drag-Drop UML.
5. Click OK.
6. In the Map Environment, expand SmartPlant Electrical > Loaded Map Schemas >
SmartPlant Electrical Tool Schema.
7. Expand the Map Classes > PIDInstrumentLoop and select ELEElectricMotor.
8. Expand the Realized Interface Definitions
9. Repeat steps 7-8 for ELECable, ELEWire, and ELEInstrument.
IPBSItem is a common interface definition.

Synchronize
1. In the Schema Editor, synchronize the authoring tool map schema for which you want to
define mapping.
Synchronize Tool Metadata with the Tool Map Schema

538

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


The new property that you added in the authoring tool appears in the Synchronization
dialog box to be added to the tool map schema file.

2. Click OK in the Synchronize dialog box to update the tool map schema.

Add the New Property to the SmartPlant Schema


1. In the Map Environment, expand SmartPlant Electrical > Loaded Map Schemas >
SmartPlant Electrical Tool Schema.
2. Expand the Map Classes node, and right-click Motor.
3. On the shortcut menu, click Edit SPEL_Motor.
4. In the Edit Map Class Definition dialog box, click the Publish tab.
5. Expand the MapProperties node under Application.
6. Expand the MapForELEElectricalMotor node under SmartPlant.

7. Under SmartPlant, click New Property Definition


on the toolbar.
8. In the New Property Definition dialog box, define the new SmartPlant schema SystemCode
property, and click OK to create the property definition.

In the Exposed by interface definitions box, click


, and select IPBSItem as the
interface definition that exposes this property.
In the Scoped by property type box, be sure to select string8 as the property type for
the new string property.
9. Under Unmapped application properties, select SystemCode1.

SmartPlant Electrical User's Guide

539

Working with SmartPlant Integration


10. Under Unmapped SmartPlant properties, select SystemCode.
11. On the toolbar, click Map

12. Click OK.

Save the Tool Map Schema and Schema Extensions File

Click File > Save > All Modified Files to save the SmartPlant schema extensions and the tool
map schema. For some tools, saving the tool map schema also saves changes to the tool
metadata database.

When you close the Schema Editor, the software prompts you to save your connection
information, user interface options, and loaded tool map schemas to a session file. Click Yes
in the message box to save the session file.
If you extend the SmartPlant schema, you must load the changes into the SmartPlant
Foundation database. For more information, see the SmartPlant Schema Editor User's Guide.

Publish Operation Description


Documents that SmartPlant Electrical can publish are reports saved in Excel format. A
SmartPlant Electrical report contains an item list responding to certain criteria. Items in the list
can have relationships with other types of items that are not listed in the report. A published
document contains both the report items and the related items. The underlying logic of defining
relationships between the items in the SmartPlant Electrical data model is partly hard-coded in
SmartPlant Adapter.
When a SmartPlant Electrical document is published, SmartPlant Adapter extracts data from the
SmartPlant Electrical database and converts it into a set of objects and relationships that are
compatible with SmartPlant schema. These objects and relationships are written out to an .xml
file and are sent to the SmartPlant server for further processing. SmartPlant Adapter depends on
the data in the tool schema to support the publish operation. For each published class in the tool
schema, there is a code module in SmartPlant Adapter known as a Map Object.

540

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


The SmartPlant Adapter for SmartPlant Electrical contains these tasks:
Query the SmartPlant Electrical Database The adapter queries the database to obtain the
collection of items to be published. The adapter retrieves all SmartPlant Electrical items
according to the type of document being published:
SmartPlant Electrical Generic Reports - All SmartPlant Electrical ISPItems of the
Report based Electrical Equipment Type (defined when registering report). If the report
is registered with filter, the items are retrieved according to this filter.
SmartPlant Electrical Power Elements - If Report based Electrical Equipment Type
is Equipment, all Instruments and Cabinets will be retrieved. Otherwise, the items of the
specified type will be retrieved.
Cable Schedule -The scope is all SmartPlant Electrical cables.
Create a Data Object For each item to be published, the Map Object creates a data object
in the document container. Any item type that you want to publish must be mapped from the
tool map schema to the SmartPlant Schema. The class of this object is the SmartPlant Class
related to the MapClass via the MapClassToClass relationship.
Set the Property Values The property values on the data object are set according to the
values on the SmartPlant Electrical item. The list of properties to be published is defined by the
list of MapProperties related to the current MapClass.
Publish Relationships The Map Object defines the types of relationships that are to be
published for each data object it publishes.
When getting the scope for a document, if the setting Report Items to Publish to SmartPlant is
set to Main items and all related items, the adapter searches for the related items for each item
retrieved, according to the mapped relationships for this MapClass.
If the MapClass of the item realizes interface IPBSItem, the relation with PBSItemCollection
is added.
If the MapClass of the item realizes interface INonDrawingItem, the relation with
NonDrawingItemCollection is added.
For each item being published, all Same As values (properties SP_SameAsUID,
SP_SameAsUID1 through SP_SameAsUID9 having non-empty values) are published as
SameAs objects.

Retrieve Operation Description


When an external document is retrieved, SmartPlant Adapter compares the objects in that
document to the data in the SmartPlant Electrical database and generates the following tasks in
the To Do List:
Create Task Generated when a new item needs to be created
Update Task Generated when an existing item needs to be modified
Delete Task Generated when an existing item needs to be deleted
SmartPlant Adapter depends on the data in the tool schema to support the retrieve
operation. When a document is retrieved, SmartPlant Adapter receives two containers of data:
Document Container Includes all of the published objects and relationships for that
document
Tombstone Container Includes information about deleted objects and relationships

SmartPlant Electrical User's Guide

541

Working with SmartPlant Integration


SmartPlant Adapter Actions in the Document Container
SmartPlant Adapter iterates over all of the objects in the Document Container and performs the
following actions:
Use Primary Interface to Determine Class The incoming object is tested for a primary
interface to determine which Map Class should handle the retrieval of that object.
Generate Update Task SmartPlant Adapter searches for an existing SmartPlant Electrical
item to update. If an item is found, it generates an Update Task in the To Do List. The
properties of the incoming object are compared against the properties of the existing
item. When differences are found, property updates are added to the task. The list of
properties to be compared is defined by the properties in the tool schema.
Generate Create Task If no item is found to update, a Create task is generated in the To Do
List. Property updates are added to the task for each of the incoming property values. The list
of properties to be added is defined by the properties in the tool schema.
Generate Claim Task If no item is found in As-Built, a Claim task is generated in the To Do
List. Property updates are added to the task for each of the incoming property values. The
list of properties to be added is defined by the properties in the tool schema.
Retrieve Relationships Depending on the class being retrieved, SmartPlant Adapter
defines the types of relationships that are to be retrieved for each data object.

SmartPlant Adapter Actions in the Tombstone Container


SmartPlant Adapter iterates over all of the objects in the Tombstone Container and performs the
following actions:
Generate Delete Task When SmartPlant Adapter encounters a delete instruction in the
tombstone container, SmartPlant Adapter searches for an existing item in the SmartPlant
Electrical project that is correlated to the item that was deleted in the other application. If such
an item is found in the project and this item does not exist in As-Built, a Delete Task is
generated in the To Do List.
Generate Claim Task and Delete Task When SmartPlant Adapter encounters a delete
instruction in the tombstone container, SmartPlant Adapter searches for an existing item in the
SmartPlant Electrical project that is correlated to the item that was deleted in the other
application. If such an item is not found in the project but this item exists in As- Built, a Claim
Task and Delete Task are generated in the To Do List.
Generate Unclaim Task When SmartPlant Adapter encounters an unclaim instruction in the
tombstone container, SmartPlant Adapter searches for an existing item in the SmartPlant
Electrical As-Built that is correlated to the item that was unclaimed in the other application. If
such an item is found in As-Built, an Unclaim Task is generated in the To Do List.
Remove Delete Task When SmartPlant Adapter encounters a resurrect instruction in the
tombstone container, SmartPlant Adapter searches for an existing Delete Task that is
correlated to the item for which the resurrect instruction was issued. If such a task is found, this
Delete Task is removed.

542

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Publishing Documents
In an integrated SmartPlant environment, the authoring tools share data and relationships when
you publish documents containing the data and relationships. The publishing process involves
selecting a document to publish, assigning it to a workflow when necessary, and specifying a
version and revision of the document if specified in SmartPlant Foundation. For most documents,
the software also publishes the data that is associated with the document when you publish.
The authoring tools (SmartPlant P&ID or SmartPlant Instrumentation, for instance) publish data in
.xml format. All leading and trailing spaces are trimmed from all strings and from all values
without units. These spaces will not appear in the published data file. The software then loads
the data from the .xml files to the SmartPlant Foundation database. After the data is loaded into
SmartPlant Foundation, you can retrieve the data into other authoring tools.
When you publish documents, the software does the following things:
Creates a new master document and the first revision in SmartPlant Foundation the first time
that you publish a particular document. From that point on, the software creates new versions
and revisions each time that you publish the document. The software relates revisions to the
master document. You can publish subsequent revisions into a workflow, which can be a
different workflow from the original publish action. Changes in the document status of a
related revision change the status of the subsequently published versions and revisions of the
document.
Publishes a visual representation of the document that you can view without the authoring
tool. For many applications, this is an Intergraph proprietary file, called a RAD file. The
viewable file can also be an Excel workbook or another viewable file type, such as .pdf or
.doc. Users can review and edit the visual representation of the document using SmartPlant
Markup.
Publishes associated data, depending on workflow approval. If the data is approved and
loaded, it is used for reporting and subsequent retrieval by downstream applications. The
software publishes only meaningful engineering data. The published data is not enough to
re-create the document in the original authoring tool.
The software publishes some document types without the associated data, such as reports
from authoring tools (for example, line lists in P&ID). You can submit documents published
without data to workflows just like documents with data. The document types and data that you
can publish depend on the authoring tool that you use.
For more information about revisions and versions, see the SmartPlant Foundation Web Portal
User's Guide.

Reasons to Publish
You can publish documents and associated data for several reasons:
To exchange and enhance data among tools, to avoid creating data multiple times in multiple
authoring tools
To report on common data that originates in multiple tools
To provide enterprise-wide accessibility to published documents
To manage change, including workflow history and document revision management
You can also publish documents to share information with users in other tools without going
through a formal workflow. To share data, you can publish a document to a For sharing
workflow that has only a load step so that the data is loaded into SmartPlant Foundation as soon
as you publish the document.

SmartPlant Electrical User's Guide

543

Working with SmartPlant Integration


You can also publish a document by not assigning the document to a workflow, but rather by using
the default workflow from SmartPlant Foundation. When you do not select a workflow for a
document during publishing, SmartPlant Loader loads the document into SmartPlant Foundation
as soon as it reaches the top of the Loader queue.

Document Types for Publishing


Each authoring tool publishes different documents and data.
The published PBS document contains information about the physical plant with a structure
consisting of plants, areas, and units. The default structure is plant/area/unit, but you can define
a custom hierarchy in the Schema Editor. When a PBS document is published from SmartPlant
Foundation, the authoring tools are notified about the plant, areas, and units that need to be
created in each authoring tool.
The project breakdown structure, project definition document, and project list contain information
about projects and their statuses.
The project breakdown structure contains a single project and the hierarchy of contracts under
that project in a plant/project structure. The project definition document contains information for a
single project that needs to be created in the authoring tool. The project list contains a list of all
projects in a plant, and it is used by those authoring tools that create all projects at one time.
The plant breakdown structure and project breakdown structure used in the authoring tools
must match the structure in SmartPlant Foundation for publishing from the authoring tools and
object correlation to work correctly.
In SmartPlant Electrical, the following documents can be published out of the box. Your
administrator can configure other documents for publish.
Single Line Diagrams and Schematics, including items on the drawings
Cable Schedule Reports
Electrical Signal I/O Lists
Microsoft Excel Reports, such as Instruments and Cabinets Requiring Electrical Power

Prerequisites for Publishing

544

When publishing documents, the plant group type and uniqueness level set for publishable
item types must be the same as the settings for those item types in the retrieving tool.
When the retrieving tool is SmartPlant Instrumentation, the plant group type and
uniqueness level must be set to Unit for the following item types: Signal Runs, PDBs,
Motors, Heaters, Other Electrical Equipment, Instruments, and Circuits. Also the plant
group type must be set to Plant for Cabinets (the uniqueness level setting is not important
in this case).
In SmartPlant P&ID, the plant group type and uniqueness level can be set to any level
except for the highest plant group type. It is recommended that the plant group type and
uniqueness level are set to Unit in SmartPlant Electrical and SmartPlant P&ID for
SmartPlant Electrical publishable item types.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Publish Documents from SmartPlant Electrical


1. Click SmartPlant > Publish.

This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard. For more information, see SmartPlant Engineering
Manager Help.
If you logged on to Electrical with a user name that is not defined in the integrated
environment, you are prompted to log on when you use this command.
The documents that appear in the Selected documents list on the Publish dialog box
when it first opens are documents that you selected in Electrical before you clicked the
Publish command.
2. Add any additional documents to the Selected documents list by clicking the Engineering
Tool, File System, or Find buttons and choosing other documents to publish.

3. Edit information as necessary for the selected documents.


When multiple documents are selected, only property values shared by all the selected
documents appear in the table. Changing a value in the table changes that value for all of the
selected documents.

SmartPlant Electrical User's Guide

545

Working with SmartPlant Integration


4. Select the Publish Type.
Electrical supports Publish Type for delta publish.

The default setting for Publish Type is Changes Only. If the 3D model has not been
published before, the software automatically selects All and performs a complete
publish to ensure all filtered data is published and loaded into SmartPlant Foundation.
For subsequent publishes, select All to publish all filtered data in the 3D model, even
if it is unchanged. Select Changes Only to publish only the changes in the 3D model
since the last successful publish.
If the 3D model does not publish successfully during a delta publish, select All so that
data from the previous publish is published and loaded into SmartPlant Foundation.
Other SmartPlant applications do not support Publish Type. For these SmartPlant
applications, the default setting for Publish Type is All, and it cannot be changed.
5. Specify a method of publishing in the Operation box:
Click Publish to immediately start the publishing process as soon as you click OK.
Click Background publish to publish the selected documents immediately as a separate
process, allowing you to perform other tasks at the same time. When you use this feature,
an e-mail message alerts you when the process is complete.
Select the Scheduled publish option to indicate that the publish process should be run in
batch mode, if the authoring tool supports scheduled batch publishing.
Click OK to complete the publishing procedure.
When the publish is complete, a dialog box appears. If the View Log button on the dialog
box is enabled, messages are available concerning the operation. These messages may include
errors or warnings or even informational messages. Click the View Log button to see these
messages.

546

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Publish Workflows
When a SmartPlant application publishes, the user can publish documents using a workflow. The
following list describes the delivered publish workflows and use cases for the workflows.
Workflow

Workflow Description

Auto-Correlate

Compares the objects in a


Use Auto-correlate
published document to the
When a publishing tool
objects that are already in
does not have correlation
SmartPlant Foundation. If the
functionality.
object correlates (by name) to
When a publishing tool
an object with the same shared
does not retrieve.
object definition, SmartPlant
Foundation automatically
correlates the objects. If the
object can correlate to more
than one object through
multiple shared object
definitions, a task is placed in
the To Do list to allow the user
to select the correlation.

AutoLoadPublish

Generates a document load


task and consolidate task for
the publishing document.
These tasks are performed by
the SmartPlant Foundation
Scheduler.

Use AutoLoadPublish when


you intend to load the published
document data into SmartPlant
Foundation.

AutoLoadPublishMerge

Publish large 3D models.


Creates the published 3D
document, loads the 3D data in
SmartPlant Foundation, then
merges these object sets into a
new composite document that
represents the entire 3D model.

Use AutoLoadPublishMerge
when you intend to view or
navigate the complete plant in
one 3D view.

Correlate

Places published objects in the


To Do list. From the To Do list,
the user manually correlates
selected items. SmartPlant
Foundation creates a shared
object.

Correlate works similar to


Auto-Correlate except you can
view the possible correlations
before the actual correlation
takes place.

Publish

Takes the document through


an approval step. Upon
approval, it creates the
document load and consolidate
tasks.

Use Publish when you want the


published document approved
before it is loaded into
SmartPlant Foundation. The
approval step is added to the
To Do list.

SmartPlant Electrical User's Guide

Workflow Use Cases

547

Working with SmartPlant Integration


Workflow

Workflow Description

Workflow Use Cases

PublishWithDocLoad

Loads document into a


document configuration and
submits document to approval
step. Upon approval, it creates
document the load and
consolidate tasks.

Use PublishWithDocLoad
when you want to view the
document data in SmartPlant
Foundation before approval.
The approval step is added to
the To Do list.

Find Documents to Publish from SmartPlant Electrical


1. Click SmartPlant > Find Documents to Publish.

This feature is also available by clicking Find


on the Publish dialog box.
This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard. For more information, see SmartPlant Engineering
Manager Help.
The Find Documents to Publish command determines which documents need to be
published or re-published and displays the results on the Find Documents to Publish
dialog box.
2. From the Select documents to publish list on the Find Documents to Publish dialog box,
select the check box beside the documents that you want to publish.

You can quickly select the entire list by clicking Select All, or you can clear the entire list
by clicking Clear All.

548

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


3. Click OK to accept the selections. The documents you selected to publish now appear in the
Documents to Publish list on the Publish dialog box, and are ready to be published. For
more information about publishing documents, see Publish Documents from SmartPlant
Electrical (on page 545).
The lists displayed on the Find Documents to Publish dialog box are compiled at the time
indicated in the Last search performed box. You can update the lists by clicking Update, but this
process can be time-consuming, depending on whether you are running the applications in
synchronous or asynchronous mode.

Retrieving Documents
When you retrieve documents into an authoring tool, you are retrieving the document data that
was published by another authoring tool. For example, in SmartPlant Instrumentation, you can
retrieve engineering information from a published P&ID into the SmartPlant Instrumentation
database.
The authoring tools provide commands that let you select a document and retrieve it into that tool.
You can use either the SmartPlant > Retrieve command to open a wizard that assists you in
retrieving applicable documents, or with some authoring tools, you can configure an automatic
retrieval feature.
When you publish a 3D model, you must now enable the Scheduler and Loader in
SmartPlant Foundation to make the 3D model data document retrievable. The load, consolidate,
and merge tasks must complete successfully before the 3D model document can be retrieved.
The software trims all leading and trailing spaces from all strings and from all values
without units of measure. These spaces do not appear in the retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser command. This
allows you to select the document or documents that you want to retrieve from your Web Client To
Do List, the tree view, or by using the Web Client search functionality. After you select the
documents that you want to retrieve, you can use the Retrieve command on the Web Client
SmartPlant menu to start the retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the Retrieve
command available in the SmartPlant Foundation Web Client. The Web Client presents a list of
documents from which you can select those you want to retrieve. However, when you use the
command from an authoring tool without first selecting documents, the software searches the
SmartPlant Foundation project for documents to retrieve, and these are presented in a list on the
Retrieve dialog box.
You can retrieve a document in two ways:
As published Retrieves only the data the authoring tool originally published with the
selected revision and version of the document. Retrieving as-published data retrieves the
.XML file the authoring tool published from the appropriate SmartPlant Foundation vault.
With the latest data Retrieves the latest data associated with the selected document in the
SmartPlant Foundation database. If another, more-recently published document contains
updates to objects in the selected document, the software retrieves the most current data in
the SmartPlant Foundation database for those shared objects. When you retrieve the latest
data, SmartPlant Foundation generates an .XML file containing the published data.

SmartPlant Electrical User's Guide

549

Working with SmartPlant Integration


Document Types for Retrieval
The types of documents that you can retrieve depend on the authoring tool you are using. The
following lists include the documents that each authoring tool can retrieve:
Aspen
Equipment Data Sheets
P&IDs
Process Flow Diagrams (PFDs)
Plant Breakdown Structure (PBS)
Project Lists
Summary Sheet documents and data
SmartPlant P&ID
Equipment Data Sheets
Equipment Lists
Instrument Index documents
Instrument I/O Assignment documents
Instrument Master Lists
P&IDs
Process Flow Diagrams (PFDs)
Stream Data Sheets (published as Equipment Data Sheets)
SmartPlant Electrical
P&IDs
SmartPlant Instrumentation Electrical Signal Lists
SPI Electrical Power Elements
3D Cable Data (SmartPlant Review File Type)
SmartPlant Engineering Manager
PBS
Project Definition Documents
SmartPlant Instrumentation
Instrument Index documents
Instrument Process Data Sheets (IPD)
P&IDs
Plant Breakdown Structure (PBS)
Project Definition Documents
SPEL Electrical I/O Lists
SPEL Electrical Power Elements
SmartPlant 3D
P&IDs
Cable Schedules
Dimensional Datasheets (DDPs)
Plant Breakdown Structure (PBS)
Project Breakdown Structure
Project Lists
PDS
Does not retrieve

550

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


All Authoring Tools
From the authoring tools, you can retrieve the plant breakdown structure (PBS) and project
documents. The PBS and project documents, created in SmartPlant Foundation and published,
are retrieved by authoring tools to provide information about the plants, areas, units, projects, and
contracts that need to be created in the authoring tool so that the information is consistent across
all authoring tools.
The PBS document published by SmartPlant Foundation contains information about the physical
plant with a structure consisting of plants, areas, and units. The default structure is plant/area/unit,
but you can define a custom hierarchy in the Schema Editor. The project breakdown structure,
project list, and project definition document contain information about the project or projects and
their statuses in a plant/project structure.

Retrieving the project breakdown documents and the PBS into SmartPlant Engineering
Manager creates the appropriate structures automatically.
When using SmartPlant Instrumentation, you must create the plant hierarchy according to the
PBS information in SmartPlant Foundation before you retrieve either the PBS or the project
definition document. You must create a plant hierarchy with at least three levels with a
minimum of one unit before you can retrieve the PBS and project definition document.
For certain document types, the tool schema definition may specify that To Do List tasks
(Create, Update, or Delete) will not be generated for those document types. For details, see
Suppress Generation of Tasks on Retrieve.

Data Handling After Retrieval


The authoring tool that you use also determines how the system deals with changes in
downstream data when you retrieve a document. SmartPlant P&ID, SmartPlant Instrumentation,
SmartPlant Electrical, and Aspen analyze the impact of the newly retrieved data on the existing
database, then place tasks on the authoring tool's To Do List that allows you to create, delete, or
modify items at the appropriate time in the design process. The To Do list gives you the
opportunity to view and understand potential changes before accepting, deleting, or modifying
those changes. In SmartPlant 3D you can view the P&ID using the View > P&ID command to pull
in the data and correlate items.

Design Basis
Objects that tools retrieve from other authoring tool documents can become the design basis for
objects in downstream documents. Objects that become the design basis for other objects can be
specific objects that get richer as they move through the lifecycle or can be schematic or logical
objects in one application that evolve into more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example, a pump
retrieved from a PFD becomes the design basis for a pump in the P&ID. When you change
common properties for the pump and retrieve the changes into SmartPlant P&ID, tasks to update
property values automatically appear in the To Do List. The same process works for logical items
that are a design basis for other items, such as a stream in Aspen that results in multiple pipe
runs in SmartPlant P&ID, or a P&ID tag in SmartPlant P&ID can evolve into a control loop with
associated tag numbers in SmartPlant Instrumentation.

SmartPlant Electrical User's Guide

551

Working with SmartPlant Integration

Retrieve Documents to SmartPlant Electrical


When you publish a 3D model, you must now enable the Scheduler and Loader in
SmartPlant Foundation to make the 3D model data document retrievable. The load, consolidate,
and merge tasks must complete successfully before the 3D model document can be retrieved.
1. Click SmartPlant > Retrieve. The Retrieve dialog box appears.

This command is available only if you have registered the active plant using the
SmartPlant Registration Wizard. For more information, see SmartPlant Engineering
Manager Help.
If you logged on to SmartPlant Electrical with a user name that is not defined in the
integrated environment, you are prompted to log on when you use this command.
The Retrieve command searches the SmartPlant Foundation project for documents that
are ready to be retrieved into your tool and displays them in the Documents to retrieve
list.
Items retrieved to, and that can also be created by SmartPlant Electrical, such as a motor,
can be renamed or deleted from SmartPlant Electrical.
2. In the Document type box, specify the type of document to be retrieved.
3. In the Show section, select Documents to be retrieved only to include documents that have
been retrieved previously and have been published again since the last retrieval. Select All
documents to include all revisions and types of documents. Select New documents only to
retrieve documents that have not been retrieved yet.
4. In the Documents to retrieve list, select the check box beside each document you want to
retrieve. To help identify the documents, review the details in the Type, Revision, Version,
and Last Retrieved columns.
To quickly select the entire list, click Select All. To quickly cancel the selections, click
Clear All.
5. For each document you checked, use the Retrieve Option column to specify whether you
want to retrieve the document with the latest data or retrieve it as published.
6. Click OK to retrieve the specified documents.

552

Select the Batch retrieve option if you want the retrieve process to run in batch mode. If you
select this option, an e-mail message will alert you when the process is complete. Otherwise,
the retrieval process begins when you click OK.
The Deleted and Unclaimed Objects document is retrieved automatically every time you
retrieve, if there is a newer version of this document since the last retrieval. The document is
not included in the list, but it is retrieved automatically, when necessary, to ensure that the
applicable information is updated.
When the retrieval process is complete, the following dialog box appears. If the View Log
button on the dialog box is enabled, messages are available concerning the operation. These
messages may include errors or warnings or even informational messages. Click View Log
to see these messages.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Using the To Do List


The To Do List allows you to keep track of tasks required to keep your plant updated with
information in an integrated environment. Specifically, this feature aids in retrieving data by
providing a list of all the things that must be added, deleted, or modified to bring the plant data into
agreement with the latest retrieved information.
All the users of a plant database share a single To Do List. You can view the entire To Do List and
see the tasks that have been completed and those that are pending. Some types of tasks have
associated code and when you run those tasks, the software modifies the database.
From the To Do List, you can run, defer, or delete tasks, or specify tasks that you want the
software to ignore in future retrievals. Additionally, you can view properties for each task in the To
Do List and, if desired, specify that certain task properties are ignored when the task is
retrieved. The information that is available is specific to the type of task that is selected: Create
tasks and Update tasks, for instance, but certain information is provided for all types. The
available task types are
Create Creates a new item.
Update Updates the selected properties of the specified item.
Delete Deletes the specified item from the plant.
Each task in the To Do List has a status. Initially, the status is Open. If you successfully run the
task, the status changes to Complete
. If you attempt to run a task, but the process is not
completed successfully, the status is changed to Error
. Error status occurs, for example, if
you attempt to run an Update task assigned to a drawing that is not currently open. You can also
postpone running a task and change its status to Deferred
.

When an Update task is created in the To Do List, the units of measure used in properties are
automatically converted to the defaults for the plant. The units of measure used for properties
in Create tasks are converted to the plant defaults when the task is run.
By clicking the heading of columns on the To Do List, you sort the list by the values in that
column.
SmartPlant Electrical does not support task dependencies. For this reason, you must run Create
tasks in the appropriate sequence for items that have a dependency relationship. For example, if
the To Do List contains Create tasks for a motor and for some related process equipment, the
software cannot run the task for the motor first because in the SmartPlant Electrical database, the
process equipment ID already appears as a property of the motor. You must first run the Create
task for the process equipment, and only then for motor. In cases where the software fails to run
related Create tasks, you can restore the tasks and run them again in the correct sequence.

Open the To Do List


Click SmartPlant > To Do List on the main menu bar to open the To Do List dialog box (on page
561), from which you can organize and run tasks.

SmartPlant Electrical User's Guide

553

Working with SmartPlant Integration

Modify To Do List Task Properties


1. Click SmartPlant > To Do List.
2. From the task list on the To Do List dialog box (on page 561), select the task that you want to
edit.
3. On the toolbar, click Properties

You can also open the Task Properties dialog box by double-clicking a task in the To
Do List.
4. On the Task Properties (see "Task Properties Dialog Box" on page 563) dialog box, click
the Details tab.
The properties available for each task depend on the type of task. For all types, you can
edit the status, description, and notes for the task. For Create and Update tasks, you can ignore
task properties when running a task (for details, see ). For Create tasks, you can edit the catalog
item being created and turn off or on the values assigned to different properties for that item. For
Update tasks, you can turn off or on the new values assigned to properties for the item.

Run Tasks from the To Do List


1. Click SmartPlant > To Do List.
2. On the To Do List dialog box (on page 561), select one or more tasks to run.

You can select all the tasks on the To Do List by pressing CTRL + A.
You can select additional tasks that have a relationship with the selected tasks by clicking
Select Related Tasks
.

3. On the toolbar, click Run

Filter To Do List Tasks


1. Click SmartPlant > To Do List.
2. On the toolbar, click Filter/Sort Tasks
.
3. On the Filter/Sort Tasks dialog box, click the Filter tab.
4. Beside the Filter name box, click the ellipsis button

to select a filter.

If you cannot find a suitable existing filter, click New to create a new filter. For more
information about creating filters, see the Filter Manager User's Guide.
5. Click OK to apply the filter on the To Do List.

554

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Sort To Do List Tasks


1. Click SmartPlant > To Do List.
2. On the toolbar, click Filter/Sort Tasks
.
3. On the Filter/Sort Tasks dialog box, click the Sort tab.
4. Select up to three To Do List properties as sort criteria by selecting from the Sort by lists; for
example: Item Type, Task Status, Task Type.
5. For each sorting property, select whether to sort in ascending or descending order.

Defer Tasks from the To Do List


1. Click SmartPlant > To Do List.
2. On the To Do List dialog box (on page 561), select the tasks that you want to defer.

You can select all the tasks on the To Do List by pressing CTRL + A.
You can select additional tasks that have a relationship with the selected tasks by clicking
Select Related Tasks
.

3. On the toolbar, click Defer

Remove Tasks from the To Do List


1. Click SmartPlant > To Do List.
2. On the To Do List dialog box (on page 561), select the tasks that you want to remove.

You can select all the tasks on the To Do List by pressing CTRL + A.
You can select additional tasks that have a relationship with the selected tasks by clicking
Select Related Tasks
.

3. On the toolbar, click Delete

See Also
Display Deleted To Do List Tasks (on page 555)

Display Deleted To Do List Tasks


1. Click SmartPlant > To Do List.
2. On the To Do List (see "To Do List Dialog Box" on page 561) toolbar, click View Deleted
Tasks
.
To return to the To Do List, click this command again.
3. To delete tasks permanently, select the tasks that you want to delete, and on the To Do List
toolbar, click Delete
.

SmartPlant Electrical User's Guide

555

Working with SmartPlant Integration

Ignore To Do List Tasks


1. Click SmartPlant > To Do List.
2. On the To Do List dialog box, select the Create tasks that you want to be ignored.
3. On the toolbar, click Ignore

Ignore Task Properties


1. Click SmartPlant > To Do List.
2. On the To Do List dialog box (on page 561), select a Create or Update task for which you
want to ignore properties.
3. On the toolbar, click Properties

You can also open the Task Properties dialog box by double-clicking a task in the To
Do List.
4. On the Task Properties (see "Task Properties Dialog Box" on page 563) dialog box, click
the Details tab.
5. Select the Ignore check box beside each property that you want the software to ignore when
running the task.
When you select to ignore a property, the software does not update that property when
you run the task for the current or for subsequent retrieve sessions. If the new value of the
property changes in the published data, on the next retrieve, that property is no longer
ignored. If you want to ignore the property only for the current retrieve session, clear both the
Activate and Ignore check boxes beside the property.
After running a task that includes ignored properties, that task is copied from the To Do List
to the ignored tasks list, where only the properties that were selected to be ignored appear on the
Details tab.

Display Ignored To Do List Tasks


1. Click SmartPlant > To Do List.
2. On the toolbar, click View Ignored Tasks

To return to the To Do List, click this command again.


3. To delete ignored tasks permanently, select the tasks that you want to delete, and on the To
Do List toolbar, click Delete
. This action makes the task available from the To Do List the
next time you retrieve the document to which the task belongs.

Update the To Do List Display

556

On the To Do List (see "To Do List Dialog Box" on page 561) dialog box toolbar, click
Refresh
.

SmartPlant Electrical User's Guide

Working with SmartPlant Integration

Compare a Document with a Published Version


This procedure explains how to compare the current version of a document with a previously
published version.
1. In the Electrical Index, expand the folder hierarchy Documents > Registered Reports.
2. Select the desired document.
3. Click SmartPlant > Compare with Published Version to open a dialog box.

4. Click Engineering Tool to select a different tool document.


In Electrical, this command opens the Find dialog box.
5. In the Revision and version options, select the SmartPlant Foundation document you want
to compare.
Click OK. SmartPlant Foundation opens and displays a visual comparison of the document
versions, together with a list of properties that have changed. For more details, see the
SmartPlant Common UI User's Guide.

SmartPlant Electrical User's Guide

557

SECTION 35

Menu Commands
In This Section
Publish Plant Groups Command (SmartPlant Menu) .................... 559
Publish Command (SmartPlant Menu) .......................................... 559
Find Documents to Publish Command (SmartPlant Menu) ........... 559
Retrieve Command (SmartPlant Menu) ........................................ 559
Compare with Published Version Command (SmartPlant Menu) . 560
Publish to External Analyzing Tool Command (SmartPlant Menu) 560
To Do List Command (SmartPlant Menu) ..................................... 560
Browser Command (SmartPlant Menu) ......................................... 560
Upgrade Schema Command (SmartPlant Menu) .......................... 560

Publish Plant Groups Command (SmartPlant Menu)


Saves an .xml data file containing details of the plant groups and their structure in the current site
server.

Publish Command (SmartPlant Menu)


Opens the Publish dialog box to allow you to send the information of the selected documents for
retrieval by other tools.

Find Documents to Publish Command (SmartPlant Menu)


Opens the Find Documents to Publish dialog box, which helps you select the documents that
you want to publish and specifies those documents that have never been published or have been
modified and need to be published again, or have been deleted since the last publish. This list is
specific to the authoring tool from which you are working.

Retrieve Command (SmartPlant Menu)


Opens the Retrieve dialog box, and provides a list of the files that can be retrieved by Electrical.
You can select the documents that you want to retrieve and thereby bring in the information for the
published documents.

SmartPlant Electrical User's Guide

559

Working with SmartPlant Integration

Compare with Published Version Command (SmartPlant


Menu)
Allows you to compare the current document with a previous revision and version of that
document that was published. This command opens the Compare with Published Version
dialog box, from which you select the document revision and version for comparison. The
comparison result is displayed in SmartPlant Foundation.

Publish to External Analyzing Tool Command (SmartPlant


Menu)
Allows you to save the information in a saved electrical analysis SLD from the authoring tool to an
.xml file used to publish data to the ETAP external analyzing tools.
When you use the SmartPlant Instrumentation Interface, this command opens a dialog box that
allows you to specify the location and name of the file used for publishing the data.

To Do List Command (SmartPlant Menu)


Opens the To Do List dialog box, which lists tasks to be performed in Electrical. From this dialog
box, you can run, defer, or delete tasks, and you can organize your tasks.
This command is available regardless of whether a drawing is open or not.

Browser Command (SmartPlant Menu)


Opens a web-based user interface that allows you to interact with SmartPlant Foundation if the
active plant is registered. From this interface, you can perform a number of tasks, such as
browsing for documents that have been published, using the SmartPlant Foundation To Do List to
complete tasks, comparing published documents with the data in your authoring tool, and
subscribing to documents in order to receive notification of changes to the documents.

Upgrade Schema Command (SmartPlant Menu)


Upgrades the existing SmartPlant schema associated with the active plant to a newer version.
The software upgrades the SPELMap.xml file, including user customizations, with the latest
version data from the files in the SmartPlant Electrical home folder\Program folder path and
registers the schema version at the beginning of the .xml file.

560

SmartPlant Electrical User's Guide

SECTION 36

Windows and Dialog Boxes


In This Section
To Do List Dialog Box .................................................................... 561
Task Properties Dialog Box ........................................................... 563

To Do List Dialog Box


Provides the ability to manage tasks that need to be run within a SmartPlant Electrical database to
keep the plant current with information in the SmartPlant Foundation database. This dialog box
opens when you click SmartPlant > To Do List on the main menu bar. The commands
associated with the To Do List dialog box are all on the To Do List toolbar.

Properties Displays the Task Properties (see "Task Properties Dialog Box" on page
563) dialog box for the selected task. This dialog box shows the detailed properties of the
task. This command is available only when a single task is selected.

SmartPlant Electrical User's Guide

561

Working with SmartPlant Integration


Run Runs the task that you select from the list. This command is available when an
executable task is selected and the status of the selected task is Open or Error. If multiple tasks
are selected, this command is available only if each of the tasks meets these criteria.
When a task runs, the status of the task and the Run Date and Run By properties are
updated. If the task runs successfully, the status is updated to Completed
. If there is a
problem, the status changes to Error
, and a timestamp and error message are added to the
Notes area.
Defer Toggles the status of the selected tasks between Open and Deferred
. This
command is available only when the selected tasks have either Open, Error
, or Deferred
status.
Delete Allows you to delete the selected task from the To Do List. This command is
available only when one or more tasks are selected. When you use this command in the To Do
List, the software moves the tasks to the deleted tasks list. When you use this command to
delete permanently one or more tasks in the deleted tasks list, a confirmation dialog box appears
to verify deletion of the selected tasks.
Ignore Allows you to specify the selected task from the To Do List as an ignored
task. This command is available only when one or more tasks are selected. When you invoke
this command, the software moves all the selected tasks to the ignored tasks list. An ignored task
is skipped for all subsequent retrieve operations. To make a task available for running again the
next time you retrieve data, you must delete that task from the ignored tasks list.
View Deleted Tasks Toggles the view between the To Do List and the deleted tasks
list. To completely delete tasks, you select them from the deleted tasks list and click Delete

View Ignored Tasks Toggles the view between the To Do List and the ignored tasks
list. To make tasks available for running again the next time you retrieve data, you select them
from the ignored tasks list and click Delete
.
Filter/Sort Tasks Opens a dialog box that allows you to filter or sort the list of tasks by the
headings in the To Do List. This is useful if, for example, you want to filter or sort the tasks in
order to run tasks of one type only, such as Create tasks.
Select Related Tasks When you select one or more tasks, choosing this command selects
all tasks that have a relationship with the selected tasks, whether they are above or below those
tasks in the database hierarchy. For example, if process equipment such as a pump is
associated with a motor and you select a task for the motor, this command will also select related
tasks for the pump; likewise, if you select a task for the pump, this command will also select
related tasks for the motor. Note that only tasks that were retrieved from the same document are
selected.
Refresh Updates the information that is displayed in the To Do List. Since only one To Do
List is generated per plant, multiple users can be working in the To Do List at the same time, and
so the information can change at any time. You can use the Refresh command to stay
up-to-date.
Report Opens Microsoft Excel and runs a report on the contents of the To Do List. The
report is located in the reference data path.
Task List Populates automatically when you retrieve a document. This list provides
information about each task, including, for example, the type of the task, the item type, the item tag
affected by the task, and so forth. By clicking the heading of any of these columns, you can sort
the list by the values in that column. Alternately clicking the same column heading toggles the

562

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


sort between ascending and descending order. Double-clicking a task opens the Task Properties
(see "Task Properties Dialog Box" on page 563) dialog box for that task.

Task Properties Dialog Box


Provides information about tasks that are defined in the task list of the To Do List dialog box. The
type of task that you selected from the To Do List determines the information that appears on this
dialog box. There are three basic types of tasks: Create, Update, and Delete. You must select
a task from the To Do List in order to open this dialog box. This dialog box opens when you
double-click the task from the To Do List dialog box or when you select the task and click
Properties
. You must select a task from the To Do List in order to open this dialog box.

General Tab (Task Properties Dialog Box)


Displays properties that are common to all types of tasks.
Task Displays the status and type of task, and a description of what happens when the task is
run.
Name Provides a descriptive string that helps you identify the purpose of the task. This value
is not a unique identifier for the task.
Status Indicates the level of completion of the task. The following choices are available:
TaskOpen, TaskCompleted
, TaskDeferred
, and Error
. When a task is created,
the status is set to TaskOpen, which does not have an identifying icon in the list of To Do List
tasks.
Type Describes the task type, for example, Manual Create, Manual Update, or Manual
Delete.
Description Allows you to type a description for the task, for example, of what happens in the
database when the task is run.
Source Provides general information about the task source.
Engineering Tool Displays the name of the application that published the document.
Document Displays the name of the document from which this task originated, for example, an
instrument index from SmartPlant Instrumentation.
Item tag Displays the item tag of the source object from which this task originated. This
information is read-only.
Destination Provides general information about the item tag affected by the task.
Item tag Displays the item tag of the item to be processed in the SmartPlant Electrical
database. For Update and Delete tasks, this box displays the item tag of an existing item. For
Create tasks, this box displays the item tag of the item that the software is going to create. This
information is read-only.

SmartPlant Electrical User's Guide

563

Working with SmartPlant Integration

Details Tab (Task Properties Dialog Box)


Provides information that is common to all types of tasks and that concerns the source and
destination of the information being imported as part of the task.
Item type The item type that the software assigns to the item when entering the property
values in the SmartPlant Electrical database. Examples of item types are SignalRun,
Instrument, and Cabinet.
Item properties Displays the task data properties and enables you to select which properties
to include when you run the task. For an Update task, only those properties for which the values
have changed are shown.
Activate Creates or updates the value in the database when you run the task. This option
applies to Create and Update tasks only for which the status is New or Deferred.
Ignore Ignores the new value of the property when you run the task, unless the new value
changes after subsequent retrieval. This option applies to Create and Update tasks only for
which the status is New or Deferred. To ignore a property for the current retrieve session only,
clear both the Activate and Ignore check boxes.
Property The name of the item property as it appears in SmartPlant Electrical.
New Value The new value of the item property in the SmartPlant Electrical database as
indicated in the retrieved document. This column only appears if the task type is Create or
Update.
Old Value The current value of the item property in the SmartPlant Electrical database. This
column only appears if the task type is Update.

History Tab (Task Properties Dialog Box)


Provides information this is common to all types of tasks and that concerns the history of the
task. This information includes the user names and dates for the creation of an item, modification
of an item, and so forth. The information on this tab is read-only.

Created
Displays creation details for the task.
By Displays the user name of the task creator.
Date Displays the date and time that the task was created.

Modified
Displays modify details for the task, other than for Create tasks.
By Displays the user name that last ran, modified, or deleted the task.
Date Displays the date and time that the task was last run, modified, or deleted.

Run
Displays details for the task when last run.
By Displays the user name that last ran the task.
Date Displays the date and time that the task was last run.

Deleted
Displays details for a deleted task. Note that this refers to deletion of the task itself, not of the item
that the task affects.

564

SmartPlant Electrical User's Guide

Working with SmartPlant Integration


By Displays the user name that removed the task.
Date Displays the date and time that the task was removed.

Notes Tab (Task Properties Dialog Box)


Allows you to enter freeform text about the task. You can also enter hyperlinks to other
documents for more extensive information. Information about the execution of the task, such as
the success of the procedure, is added to the end of any existing notes for a task.

SmartPlant Electrical User's Guide

565

SECTION 37

Appendix
In This Section
SmartPlant Electrical Data Model .................................................. 567
Customizing Your Data .................................................................. 567
Electrical Calculations .................................................................... 569
Custom Validations and Calculations ............................................ 574
Switching the Plant Operational Mode .......................................... 579
Custom Common Properties Forms .............................................. 580
Typical Cable Block Diagram Utility Dialog Box ............................ 584

SmartPlant Electrical Data Model


The data model is the persistent storage structure for data manipulated by SmartPlant Electrical.
The SmartPlant Electrical Data Model Excel spreadsheet is a two-dimensional representation of
the SmartPlant Electrical data model. This spreadsheet lists item types, item properties, and data
types, as well as all the constructed item attributions that apply to Electrical objects. This list is
alphabetical according to item type.
The SPELDataModel.xlsx file is located in your SmartPlant Electrical installation folder > Program
Files > SmartPlant > Electrical > Program > resdls > 0009 > SPELDataModel.xlsx.

Customizing Your Data


Many of the data values that you use in SmartPlant Electrical appear in select lists. You can
customize the select lists by modifying existing values, hiding or displaying particular values, or
adding new values using the Update Select Lists (see "Update Select Lists Dialog Box" on page
618) dialog box. For further information on how to use this feature, refer to Online Help for the
Data Dictionary Manager.
The software uses the values in certain select lists to filter the values of other properties or to
perform calculations. We strongly recommend that you not make any changes to the values in
these select lists. If you do, proceed with extreme caution before modifying any of these select
lists, because doing so can adversely affect your data. The following select lists belong to this
category:
Application
Boolean Values
Boolean Yes/No
Cable Application Area
Cable Category
Cable Set Type
Cable Structure
Cable Tray Construction
Cableway Segment
Cell Function

SmartPlant Electrical User's Guide

567

Appendix

568

Cell Usage
Circuit Mode
Circuit Type
Claim Mode
Conductor Arrangement
Conformity To Standard
Connection Point Type
Core Phase Usage
Count Quality
Current Transformer Ratio
Document Category
Document Sub Type
Document Type
Electrical Equipment Class
Electrical Equipment Sub Class
Equipment Type Identifier
FLA Calculation Flag
Framework Document Type
Frequency
Function
Grounding For Impedance Calculation
InOut
Instrument Function Type
Instrument Process Function
Item Project Status
KKS Component Key
KKS Component Key B1
KKS Equipment Unit Key
KKS Equipment Unit Key A1
KKS System Key
KKS System Key F1
KKS System Key F1 F2
kVClass
Length Units of Measure
LRC Code Letter
Model Item Type
Naming Type
Neutral Grounding
Number of Phases
Operating Mode
Origin Point
Phase Arrangement
Phase Usage
Plant Group Type
Plant Item Type

SmartPlant Electrical User's Guide

Appendix

Project Setting Type


Ref Plant Item Profile Join Tape
Representation Class
Restart Flag
Routing
Routing Status
Section Side
Segment Category
Shielding
Source Name
Supply AC/DC Flag
System Cable Category
System of Units
Tapping
Task Ignored
Task Type
Tray Fill Validation Method
Unit of Measure
Unit System
Update Flag

Electrical Calculations
The software calculates electrical power requirements for motors based on the load data you
enter, which in turn comes from the motor manufacturer. On the Electrical Motor Common
Properties dialog box, Electrical Data tab (see "Electrical Data Tab (Electrical Motor Common
Properties Dialog Box)" on page 696), the software displays the results of the electrical power
requirement calculations.

Calculations for Motors


Input Data
The software requires the following data, which you enter on the Electrical Motor Common
Properties dialog box, Load Data tab (see "Load Data Tab (Electrical Motor Common Properties
Dialog Box)" on page 693):
Motor rated power - Specifies the maximum mechanical power requirement for the motor.
Brake power - Specifies the mechanical power requirement for the motor at the demand point.
Demand factor - The software calculates the demand factor as the ratio of the brake power to the
motor rated power. The demand factor represents the operating point of the motor that the
software uses for the calculations.
Power factor - The software calculates the power factor at the operating point based on the
standard power factor values at 50%, 75%, and 100% of the motor rated power.
Efficiency - The software calculates the efficiency at the operating point based on the standard
efficiency values at 50%, 75%, and 100% of the motor rated power.

SmartPlant Electrical User's Guide

569

Appendix
Power Factor Calculations
The software calculates the power factor and efficiency at the operating point by assuming a linear
relation between the standard values at 50%, 75%, and 100% of the motor rated power and
interpolating accordingly. For an operating point below 50% of the motor rated power, the
software extrapolates using the known slope between the values at 50% and 75% of the motor
rated power.
The following values apply to power factor calculations:
PF50 = power factor @ 50% (number between 0 and 1)
PF75 = power factor @ 75% (number between 0 and 1)
PF100 = power factor @ 100% (number between 0 and 1)
PF@DF = power factor @ demand factor (number between 0 and 1)
DF = demand factor (number between 0 and 1)
EF@OP = efficiency @ operating point (number between 0 and 1)
The graph shows how the software uses the user input values to calculate the power factor at a
given demand factor.

Based on the graph, the software calculates the power factor for different ranges of the demand
factor using the following formulas.
For a demand factor between 75% and 100%:

For a demand factor between 50% and 75%:

For a demand factor below 50%:

The software uses a similar set of formulas to calculate the efficiency.

570

SmartPlant Electrical User's Guide

Appendix
Locked Rotor Current Calculation by Code Letter
(Applicable for NEC)
Indicating a code letter copies a fixed value from the LockedRotorIndicatingCodeLetters lookup
table to the kVA to HP ratio property.
Apparent Power (VA) = 1000 kVA to HP ratio * Motor Rated Power (hp)

This equation is applicable only when setting the conformity standard to NEC and the FLA
calculation to TABLES.

Calculations for Static Loads


Rated Power
Rated power is the electrical output power of a load as it appears on the load nameplate. The units
of measure depend on the type of load.

Absorbed Power
This is the output electrical power at normal operating point.

Demand Factor
This is the ratio of the load power requirement at a specified operating point to the rated power.
The demand factor influences the consumed electrical power of the load.
The software calculates the demand factor as the ratio of the absorbed power to the rated
power. The demand factor represents the operating point of the load that the software uses for
the calculations. Demand factor values can be inserted manually or calculated as the ratio of
absorbed power to rated power.

Power Factor
This is the power factor of a static load at rated or operating point. Power factor values can be
between zero and one, entered manually.

Efficiency
This is the efficiency of a static load at rated and operating point. Efficiency values can be between
zero and one, entered manually.

Equations
The software uses the following equation to calculate absorbed power (or demand factor):

SmartPlant Electrical User's Guide

571

Appendix
Electrical Power Calculations
The software calculates the rated, particular, and consumed load, that is, the electrical power,
using the equations below.
The following equations are used to calculate rated value for all static loads except for capacitors
and harmonic filters:

The following equations are used to calculate consumed value for all static loads except for
capacitors and harmonic filters:

The following equations are used to calculate consumed values for capacitors and harmonic
filters:
Reactive Load (kVAR) = Absorbed Power (kVAR)

572

For static loads, the software uses the values of the absorbed and rated electrical power to
calculate the electrical quantities.
For capacitors and harmonic filters, the active load property is disabled and has a null value.
For heaters, the reactive load property is disabled and has a null value.

SmartPlant Electrical User's Guide

Appendix
Calculation of Full Load Current
The software uses the following formulas to calculate full load current.

Where:
k=1 for DC and single phase AC
k=3 for three-phase AC
Rated voltage is the line voltage

Calculation of Synchronous Speed


The software calculates the synchronous speed of a motor or a generator according to the
following equation:

Earth Loop Impedance Calculation


Earth loop impedance is the total resistance between the current source and earth when clearing
a faulty current to earth. The earth loop impedance determines the maximum potential between
the point at which the fault occurs and earth. The software performs earth loop impedance per
cable and calculates the total impedance as the sum of the grounding path impedance, external
loop impedance, and impedance of the cable carrying the current. According to the user's
requirement, the grounding path can be through the cable armor, or through a separate grounding
cable.
You can find this information in the Cable Algorithms.xls file, which resides in SmartPlant
Electrical program folder resdlls > 0009 and from there, double-click the Cable Algorithms.xls file.
In the file, maximize the window and click the EARTH LOOP IMPEDANCE tab.

SmartPlant Electrical User's Guide

573

Appendix

Custom Validations and Calculations


The software uses validations to check the input values of properties and if required, to change the
values of other properties prior to processing by the SmartPlant Electrical business layer.
Calculations provide a means of allowing data input for a property using a separate dialog
box. When you specify a calculation, an ellipsis appears beside the value of the property in the
Properties window of SmartPlant Electrical or beside the appropriate text box on a Common
Properties dialog box.

Implement Validation
1. Create a VB project with type ActiveX DLL.
2. On the project Properties dialog box, type a project name.
3. Ensure that the SPELCustomInf.tlb file is registered on the machine where you are going to
build your custom .dll file by using the regtlib command. This file should be located in the
folder where SmartPlant Electrical is installed and contains the appropriate interfaces that the
VB project must reference.

4.
5.
6.
7.

Validation implements the interface ISPELValidate, which contains the DoValidate


method and LastErrorMessage property.
In the References dialog box, ensure that SP Electrical Customization Interfaces is
selected, then click OK.
Create a reference to the file C:\Program
Files\SmartPlant\Electrical\Program\ISPClientData3V2.tlb.
Create a class containing your code (for an example of a validation task, see Validation Code
Example (on page 577)).
Compile the .dll file, place it in the desired folder, and register it in the Registry of the machine
on which you are running SmartPlant Electrical by entering the following code at the
command prompt:
Regsvr32 <File name>.dll

It is recommended that you compile the .dll file on a machine where you are going to run
SmartPlant Electrical, to facilitate testing of the code. In this case, you do not need to
register the .dll file.
If it is not possible to compile the .dll file on a machine where SmartPlant Electrical runs,
make sure that you register the ISPClientData3V2.tlb and SPELCustomInf.tlb library files
on the machine where you perform the compilation.
8. Open the Data Dictionary Manager (Data Dictionary Manager.exe) and click Database
Tables
.
9. Select the desired item (for example, Plant Item) and double-click the required property of
that item (for example, Name).
You need to have an understanding of the database table structure in order to decide
which item and property to select.
10. Beside Validation ID, type a ProgID which is usually made up of <VB Project name>.<Class
name>. For example, if the VB Project name is MyCustomValidation and the class name is
Class1.cls, the ProgID you would type is MyCustomValidation.Class1.
You can associate each item type property with one class only; however, the function
code in the class can specify any number of cases or conditions.

574

SmartPlant Electrical User's Guide

Appendix
11. Run SmartPlant Electrical to check that the code works (make sure that you are connected to
the correct plant).

The software performs the custom validation whenever you change the value of the property
in the Properties window, in the Tabular Editor, and if appropriate, in a Common Properties
dialog box. The software does not validate changed data input that originates from elsewhere,
for example, lookup tables.
The software performs custom validations prior to performing validations in the business
object layer; however, if a custom validation conflicts with a business layer rule, the software
ignores the custom validation.
If a custom validation affects other properties that have their own custom validation definitions,
the software only performs the validation for the property where you change the value directly;
it ignores the custom validations for the other properties.
When performing a total bus load validation, the software accounted only for those items that
are defined as consumers. In addition to loads, you can define other electrical items as
consumers. These items are converting equipment items, local panels, and junction boxes.
To define an item as a consumer, you have to set the Is Load property in the Properties
window for that item to True or define this electrical item as a Consumer in the Common
Properties dialog box of that item.

SmartPlant Electrical User's Guide

575

Appendix

Implement Calculation
1. Create a VB project with type ActiveX DLL.
2. On the project Properties dialog box, type a project name.
3. Ensure that the SPELCustomInf.tlb file is registered on the machine where you are going to
build your custom .dll file. This file should be located in the folder where SmartPlant Electrical
is installed and contains the appropriate interfaces that the VB project must reference.

4.
5.
6.
7.

Calculation implements the interface ISPELCalculate, which contains the DoCalculate


method.
In the References dialog box, ensure that SP Electrical Customization Interfaces is
selected, then click OK.
Create a reference to the file C:\Program
Files\SmartPlant\Electrical\Program\ISPClientData3V2.tlb.
Create a class containing your code.
Compile the .dll file, place it in the desired folder, and register it in the Registry of the machine
on which you are running SmartPlant Electrical by entering the following code at the
command prompt:
Regsvr32 <File name>.dll

It is recommended that you compile the .dll file on a machine where you are going to run
SmartPlant Electrical, to facilitate testing of the code. In this case, you do not need to
register the .dll file.
If it is not possible to compile the .dll file on a machine where SmartPlant Electrical runs,
make sure that you register the ISPClientData3V2.tlb and SPELCustomInf.tlb library files
on the machine where you perform the compilation.
8. Open the Data Dictionary Manager (Data Dictionary Manager.exe) and click Database
Tables
.
9. Select the desired item (for example, Plant Item) and double-click the required property of
that item (for example, Name).
You need to have an understanding of the database table structure in order to decide
which item and property to select.
10. Beside Calculation ID, type a ProgID which is usually made up of <VB Project name>.<Class
name>. For example, if the VB Project name is MyCustomValidation and the class name is
Class1.cls, the ProgID you would type is MyCustomValidation.Class1.
11. Run SmartPlant Electrical to check that the code works (make sure that you are connected to
the correct plant).

576

SmartPlant Electrical User's Guide

Appendix

Validation Code Example


The code in the following validation example allows you to change the value in the Name property
of a motor item type. Also, this code modifies the value in the Description property and changes
it to a string made up of the item type (motor), the item tag, and the string 'custom validated'.
1. In the General Declarations section of the class add the following lines:
Option Explicit Implements SPELCustomInf.ISPELValidate Private m_strLastErrorMessage
As String
2. Implement the DoValidate method as follows:
Private Function ISPELValidate_DoValidate(ByVal _
objISPItem As ISPClientData3.ISPItem, ByVal _
strPropName As String, ByVal varNewValue As Variant) _
As Boolean
If objISPItem.ItemType.Name = "Motor" Then
objISPItem.Attributes("Description").Value = _
objISPItem.ItemType.Name + " " + _
CStr(objISPItem.Attributes("ItemTag").Value) + _
custom validated"
ISPELValidate_DoValidate = True
Else
m_strLastErrorMessage = "Motors only allowed!"
ISPELValidate_DoValidate = False
End If
End Function

Item Type Validation Example


The code in the following example allows you to write an item type validation routine that will
improve the efficiency of your project.
The following example deals with the item type validation of capacitors. After implementing this
validation, you will be able to define a value for a capacitor's Absorbed Power (similar to brake
power of a motor) either in the Properties window or Tabular Editor and the software will calculate
the required demand factor. The software will also calculate the respective consumed electrical
power according to the following formula:
Demand factor = Absorbed Power/Capacitor Rated Power
Note that Absorbed Power cannot have a value greater than Capacitor Rated power.
This formula also works in reverse. Entering a Demand Factor value will calculate the required
Absorbed Power. The Demand Factor value will always be a number between 0 and 1. Note that
the Capacitor Rated Power value is not calculated and you must enter it manually.
For this code example to work, prior to implementing the item type validation, you have to create a
new custom property for capacitors in Data Dictionary. The name of the new custom property is
Absorbed Power and its data type is reactive power.

SmartPlant Electrical User's Guide

577

Appendix
You can use this example code to write your own programming routine for a different item type.
1. In the General Declarations section of the class add the following lines:
Option Explicit
Implements SPELCustomInf.ISPELItemValidation
Private m_LastErrorMessage As String
2. Implement the SavingItem method as follows:
Private Property Get ISPELItemValidation_LastErrorMessage() As String
ISPELItemValidation_LastErrorMessage = m_LastErrorMessage
End Property
Private Function ISPELItemValidation_SavingItem(ByVal objISPItem As
ISPClientData3.ISPItem) As Boolean
Dim nDemandFactor As Double
Dim nCapacitorRatedPower As Double
Dim nAbsorbedPower As Double
Dim objProperty As ISPPropertyInf.ISPProperty
On Error GoTo ErrHandler
If objISPItem.ItemType.Name <> "Capacitor" Then GoTo Exit_Proc 'Works
Only for 'Capacitor'
'Get the fields that are involved in calculation with SI(The
International System of Units) values
nCapacitorRatedPower = CDbl("0" &
objISPItem.Attributes("CapacitorRatedPower").SIValue)
nAbsorbedPower = CDbl("0" & objISPItem.Attributes("AbsorbedPower").SIValue)
nDemandFactor = CDbl("0" & objISPItem.Attributes("DemandFactor").Value)
If nCapacitorRatedPower = 0 Then GoTo Exit_Proc
in CapacitorRatedPower, nothing is calculated.

'If there is no value

'Calculate Demand Factor or Absorbed Power if the CapacitorRatedPower


property has been changed.
Set objProperty = objISPItem.Attributes("CapacitorRatedPower")
If objProperty.IsDirty Then 'Check if the CapacitorRatedPower property
has been changed.
If nAbsorbedPower > 0 Then
nDemandFactor = nAbsorbedPower / nCapacitorRatedPower
objISPItem.Attributes("DemandFactor").Value = CStr(nDemandFactor)
ElseIf nDemandFactor > 0 Then
nAbsorbedPower = nDemandFactor * nCapacitorRatedPower
objISPItem.Attributes("AbsorbedPower").Value =
objISPItem.Attributes("AbsorbedPower").Format.FormatUnit(CStr(nAbsorbedPower))
End If

578

SmartPlant Electrical User's Guide

Appendix

GoTo Exit_Proc
End If
'Calculate Absorbed Power if the Absorbed Power has been changed
Set objProperty = objISPItem.Attributes("AbsorbedPower")
If objProperty.IsDirty Then
nDemandFactor = nAbsorbedPower / nCapacitorRatedPower
objISPItem.Attributes("DemandFactor").Value = CStr(nDemandFactor)
GoTo Exit_Proc
End If
Exit_Proc:
'Set return value to True if the calculation is OK or to False if something is wrong
ISPELItemValidation_SavingItem = True
Set objProperty = Nothing
Exit Function
ErrHandler:
'If something is wrong, display an error message.
m_LastErrorMessage = Err.Description
Resume Exit_Proc

Switching the Plant Operational Mode


SmartPlant Electrical enables you to define various plant operational cases (modes). Typically,
such a mode can be, for example, Winter Loads, Summer Loads, and so on. After defining an
operational mode, you can, in one single operation, switch all the motors, instruments and
cabinets to a mode that you select.
For this operation to work, you need to add new properties in user-defined fields for the alternate
case (mode) load data, create appropriate rules in the Rule Manager, and define a filter in the
Filter Manager. Once you make all these definitions, you can select a specific operational mode
that will trigger the copying mechanism in SmartPlant Electrical, thus switching to the appropriate
scenario. After switching to another operational mode, the software makes a global update of the
relevant values that affect all the direct electrical calculations that use these values. You can see
these values in the Properties window or the Common Properties dialog box for specific
electrical items.
Contact SmartPlant Electrical technical support if you need help with the configuration of
an operational case.
1. In SmartPlant Electrical, click Actions > Switch Plant Operational Mode.
2. On the Switch Plant Operational Mode dialog box, select an appropriate operational mode.
3. Click OK.

SmartPlant Electrical User's Guide

579

Appendix

Custom Common Properties Forms


You can create custom common properties forms that you can use in addition to the standard
built-in common properties dialog boxes in SmartPlant Electrical. You can design your custom
common properties form in any way that fits your needs. You can include as many property fields
as you like as long as they appear in the Properties window for the item type for which your
custom form is intended. You cannot include a property field that does not appear in the
Properties window. You can create several forms for the same item type and all of these custom
forms will be available for all the electrical items belonging to that specific item types.
Note, however, that the custom forms are created per user and these forms will not be available to
other users unless you copy the SPELCustomForms.xml file and the project DLL file that you
created in Microsoft Visual Basic to the same locations on your computer, namely, the SmartPlant
Electrical installation folder, for example:
c:\Program Files\SmartPlant\Electrical\Program\...
The customization process consists of the following two work flows:
Creating a Custom Common Properties Form (see "Create a Custom Common Properties Form"
on page 580)
and
Defining Custom Forms in SmartPlant Electrical (see "Define Custom Forms in SmartPlant
Electrical" on page 582)
After completing these two work flows, you will be able to open either the standard built-in
common properties form or one of the custom forms that you have defined for the current item
type.

Create a Custom Common Properties Form


The following procedure contains the required work flow for the creation of a customized common
properties form in Microsoft Visual Basic 6.
1. In Microsoft Visual Basic 6, create a project. Make sure that you select the ActiveX DLL
template.
2. Rename the new project as needed.
3. In the Project window, rename the Class1 module as needed. For example,
SPELCustomForms.
4. Click Project > References.
5. On the References dialog box, select SP Electrical Customization Interfaces.
Do not clear the default references.
6. Click Project > Components.
7.
8.
9.
10.

580

Clear the Selected Items Only check box.


Select SmartPlant Electrical Controls and SPELCalcButton.
Click OK on the Components dialog box.
In the Project window, select the required project and then click Project > [Project Name]
Properties.
On the CustomForm - Project Properties dialog box, do the following:
a. Click the Make tab.
b. Clear the Remove information about unused ActiveX Controls check box.
c. Click OK.

SmartPlant Electrical User's Guide

Appendix
11. Type the following code for the module class that you created:
Option Explicit
Implements SPELCustomInf.ISPELCustomForm
Private
String,
Set
Dim

Function ISPELCustomForm_CreateForm(ByVal strFormName As


objFormEngine As SPELCustomInf.IFormEngine) As Object
g_objEdit = objFormEngine
customFrm As Object

On Error GoTo EH
Set customFrm = Forms.Add(strFormName)
Set ISPELCustomForm_CreateForm = customFrm
EXIT_FUN:
On Error Resume Next
Set customFrm = Nothing
Exit Function
EH:
MsgBox "Form " & strFormName & " does not exist", vbOKOnly +
vbExclamation, "Error"
Resume EXIT_FUN
End Function
12. Click Project > Add Module.
13. Type the following text:
Option Explicit

14.
15.
16.
17.

Public g_objEdit As SPELCustomInf.IFormEngine


Click Project > Add Form.
On the Add Form dialog box, select Form and click Open.
Rename the new form as needed. For example, MotorForm.
Define your custom form as you wish. Note the following requirements:
a. For each control that will enable you to display or enter data in SmartPlant Electrical,
define the control property. To make this definition, in the Tag property field of a control
property, type the SmartPlant Electrical property name exactly as it appears in the Data
Dictionary,
b. When setting the tab sequence and acceleration key for a property, make sure that the
Tab Index number for each label is smaller by one than the Tab Index of its control. For
example, If the Tab Index value for a particular label is 13, the Tab Index for its control has
to be 14.
c. It is recommended that you define all the SmartPlant Electrical ComboBox controls that
you include in your custom as an array.
d. For each control, select the LostFocus event and type:
g_objEdit.ValueChange [control name]
For example: g_objEdit.ValueChange txtItemTag
e. For each SmartPlant Electrical ComboBox control, type the following for the Click event:
g_objEdit.ValueChange [control name]
For example: g_objEdit.ValueChange SPELComboBox1

SmartPlant Electrical User's Guide

581

Appendix
f.

For each SmartPlant Electrical ComboBox control, type the following for the DropDown
event:
g_objEdit.OnDropDown [control name]

For example: g_objEdit.OnDropDown SPELComboBox1


18. Add at least two command buttons (Apply and Close).
a. To set the function of Apply, type the following code for the Click event:
g_objEdit.SaveChanges
b. To set the function of Close, type the following code for the Click event:
Unload Me
c. To set the function of OK, type the following code for the Click event:
g_objEdit.SaveChanges
Unload Me
19. Compile your custom form project by clicking File > Make [Project Name.dll].

If you are working with an array of controls, for each control, add the required indexes in
parentheses.
This concludes the form creation procedure. Now you have to ingrate the new custom form in
SmartPlant Electrical. For details, see Define Custom Forms in SmartPlant Electrical (on page
582).

Define Custom Forms in SmartPlant Electrical


The following procedure explains how to define the available custom common properties form in
SmartPlant Electrical.
SmartPlant Electrical provides two files that are located in the Program folder of your
SmartPlant Electrical installation. These two files are SPELCustomForms.xml and
SPELCustomForms.xsd. Make sure that you do not move these files from this location and that
you do not make any changes to the SPELCustomForms.xsd file.
To integrate your custom forms, edit the SPELCustomForms.xml file. If you want to keep the
SPELCustomForms.xml file as an example, rename it or copy it to another location.
Here is an example of such an XML file:
<?xml version="1.0" encoding="UTF-8"?>
<ItemTypes xmlns="http://www.lll.com"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.lll.com SPELCustomForms.xsd">
<ItemType Name="Motor" DefaultProgId =
"CustomForm.CustomEdit">
<Forms>
<Form Name = "Motor_Form1" Description =
"Motors - type 1 />
<Form Name = "Motor_Form2" ProgId
="CustomForm.CustomEdit" Description = "Motors - type 1" />
<Form Name = "Motor_Form3" ProgId
="CustomForm.CustomEdit" Description = "Motors - type 2" />
<Form Name = "Motor_Form4" ProgId
="CustomForm.CustomEdit" Description = "Motors - type 3" />
</Forms>
</ItemType>

582

SmartPlant Electrical User's Guide

Appendix
<ItemType Name="Generator" DefaultProgId =
"CustomForm.CustomEdit">
<Forms>
<Form Name = "Cable_Form1" ProgId
="CustomForm.CustomEdit" Description = "Power Cables" />
<Form Name = "Cable_Form2" ProgId
="CustomForm.CustomEdit" Description = "Instr. Cables" />
</Forms>
</ItemType>
</ItemTypes>
When editing the SPELCustomForms.xml file, remember the following:
For each item type, there has to be an <ItemType> node that points to the appropriate Visual
Basic project and module class according to the following syntax:
<ItemType Name="Motor" DefaultProgId = "[VB Project Name].[Module Class
Name]">
For example:
<ItemType Name="Motor" DefaultProgId = "CustomForm.CustomEdit">

If a form that you created belongs to a project different from the one indicated in the
DefaultProgId node, add a new line in the <Forms> node that points to the required project.
Under the <ItemType> node, there has to be a <Forms> node under which you add all the
forms that you want to have for this item type.
Each <Form Name> node must have a name definition and it can have a ProgId and
description definitions. Use the following syntax:
<Form Name = "[Form Name]" ProgId ="[VB Project Name].[Module Class
Name]" Description = "[Text]" />
Note the following:
There must be a name definition for each form. This name will appear on the Select
Common Properties dialog box, in the Common Properties Form field.
You can define a ProgId different from the default ProgId or you can omit this definition if
you like. If there is no ProgId for a particular form, the default ProgId will be in use.
The Description definition that you type here will appear on the Select Common
Properties dialog box, in the Description field. You can omit the Definition description if
you like.
If you want to add another form for a different item type, define an additional <ItemType
Name> node for that form.
If want to share your custom forms with another user, copy the DLL file that was created by the
Visual Basic project and the SPELCustomForms.xml file to the SmartPlant Electrical
installation folder of the user who will share your custom forms. There is no need to copy the
SPELCustomForms.xsd file as it is provided with every installation.

Remember that you must register the DLL file once it is copied to another
computer.

SmartPlant Electrical User's Guide

583

Appendix

Select Common Properties Form Dialog Box


Whenever you want to open the common properties of a particular electrical item, this dialog box
opens automatically if a custom common properties form exists for the current item type.
The dialog box allows you to select a custom common properties form or the standard built-in
common properties form that you want to open for the current electrical item. For information on
how to create custom common properties forms, see Custom Common Properties Forms (on
page 580).
The dialog options are as follows:
Common Properties Form Lists the names of all the existing custom forms for the current
item type. The custom form names are defined in the SPELCustomForms.xml file, under the
<Forms> node. For details, see Define Custom Forms in SmartPlant Electrical (on page 582).
Note that the standard built-in common properties form is always at the top of
the list.
Description Displays a brief description of the available common properties forms. This is the
text that has been entered in the <Form Name> node, after Description in the
SPELCustomForms.xml file.
OK Opens the selected common properties form and closes this dialog.

Typical Cable Block Diagram Utility Dialog Box


The typical cable block diagram utility enables you to save typical cable block diagram data as an
external ZIP file and then transfer the typical cable block diagram data to other plants created from
a custom Data Dictionary template. For example, if you created a new plant based on a custom
data dictionary template, you will have to copy the typical cable block data to your new plant. The
software saves the typical cable block diagram data in a ZIP file. The whole procedure consists of
two main steps: saving the data and then integrating it in a new plant.
To save your typical cable block diagram data:
1. Run the SPELTypicalCBDUtil.exe file which is located in the installation folder of your
SmartPlant Electrical, for example:
C:\Program Files\SmartPlant\Electrical\Program\SPELTypicalCBDutil.exe
2. Select the Save typical CBD data option.
3. Under File name, type the name of the new ZIP file.
4. Click
to navigate to the folder where you want to save the new ZIP file.
5. Click Run.
To integrate your typical cable block diagram data in another plant:
1. Run the SPELTypicalCBDUtil.exe file to start the utility if needed.
2. Select the Integrate typical CBD data option.
3. Click
to navigate to the appropriate ZIP file which contains the typical CBD data.
4. Click Run.
The dialog options are as follows:
Save typical CBD data Saves the typical CBD data as an external ZIP file in the location
indicated under File name.
Integrate typical CBD data Unzips the external file and integrates the typical CBD data into
the current plant (indicated in the title bar of this dialog box).

584

SmartPlant Electrical User's Guide

Appendix
File name Allows you to type and display the name and file path of the ZIP file that you want to
save or unzip. Click
to navigate to the appropriate location.
Run Saves the data as a Zip file or integrates the unzipped typical CBD data depending on the
option you selected above.
Change Plant Allows you to change the plant where you want to save the ZIP file or where you
want to integrate the unzipped typical CBD data.

SmartPlant Electrical User's Guide

585

SECTION 38

Menu Commands
New > Item Command (File Menu)
Creates a new item or adds a node under the selected node in the Reference Data Explorer or
Electrical Index.
Clicking on the down-arrow of the File menu button above accesses a list of the associated
commands. Clicking on the File menu button itself repeats the last command you used from the
File menu.

New > SLD Command (File Menu)


This menu option is available when you select an electrical item in the Electrical Engineer.
Opens the Single Line Diagram Options dialog box (on page 798), which allows you to define
generation settings for a single line diagram.

New > Template Command (File Menu)


Creates a new blank template in the current plant.
Templates created at the user- level instead of the administrator-level are not available
to other users for creating drawings.

New > Custom Folder (File Menu)


This menu command is available when you select an equipment folder in the Reference Data
Explorer or Electrical Index.
Opens the Create a Custom Folder dialog box, which allows you to create a custom folder within
the selected equipment folder.

Open > Plant Group Command (File Menu)


Displays the Open Plant Group dialog box (on page 612), which allows you to navigate to a
specific plant group within a plant.

Open > Drawing Command (File Menu)


This menu option is available when you select a schematic drawing in the Electrical Index.
Opens the schematic drawing that you select.

SmartPlant Electrical User's Guide

587

Menu Commands

Open > PDB Layout Command (File Menu)


This menu option is available when you select a PDB or a PDB layout drawing in the Electrical
Index.
Opens an existing PDB layout drawing. For more information, see Design a Power Distribution
Board Layout (on page 116).

Open > SLD Command (File Menu)


This menu option is available when you:
Select an existing SLD drawing in the Electrical Index.
Select an electrical item in the Electrical Engineer.
Opens a saved single line diagram for the item that you select.

Open > Template Command (File Menu)


Opens a template within the current plant. Templates are in the .spe file format. You can edit the
template by changing the page setup or modifying the border and title block.

Open > Log Files Command (File Menu)


Opens a dialog box with a list of categories from which you can select and view log files.

Close Command (File Menu)


Closes the active drawing or Tabular Editor. The software saves your changes automatically.

Save Command (File Menu)


Stores the active drawing or template. If you have not already named the drawing or template, the
Save As dialog box appears. If you have already named the drawing or template, no dialog box
appears. Project location and paths are set in SmartPlant Engineering Manager and Options
Manager.

Save As Command (File Menu)


Opens the Save As dialog box. Saves the active document to a new format.

Preferences Command (File Menu)


Opens the Preferences dialog box, where you can set preferences for general and single line
diagram generation options, load summary report options, and delete load options.

588

SmartPlant Electrical User's Guide

Menu Commands

Print Command (File Menu)


Sends a copy of the active drawing to a specified plotter, printer, or file. Options are available for
defining the printing area, range, number of copies, and other printing characteristics. Selecting
File > Print opens the Print dialog box.
Before using this command, you must install and select a printer. For help on installing a printer,
see the Windows documentation.

Sheet Setup Command (File Menu


Allows you to define a drawing sheet size, scale, and other print settings.

Properties Command (File Menu)


Accesses general information about the current drawing, and opens the File Properties dialog box
(see "File Properties Dialog Box (File > Properties)" on page 610). You can review and edit the
drawing summary and statistics.

Exit Command (File Menu)


Closes the active drawing and quits the software. The software checks for unsaved changes when
you quit.
On exiting the software, the positions and sizes of all dialog bars (Reference Data
Explorer, Electrical Index, and Electrical Engineer), as well as any filter settings, are retained.
The next time that you log on to the program, you see the same set of data displayed as it was in
the previous session.

Undo Command (Edit Menu)


Undoes the last action

Redo Command (Edit Menu)


Performs the last undone action.

Cut Command (Edit Menu)


Cuts selected items from the drawing and pastes them to the Clipboard. The selected items
replace the previous contents of the Clipboard.

SmartPlant Electrical User's Guide

589

Menu Commands

Copy Command (Edit Menu)


Copies selected items and their associated properties in the database to the Clipboard. This
command replaces the previous contents of the Clipboard with the new contents.

Paste Command (Edit Menu)


Inserts the Clipboard contents at the same location the items occupied in the source document or
drawing. The command is not available if the Clipboard is empty.

Delete Command (Edit Menu)


Removes the selected item from the database.

Select All Command (Edit Menu)


Selects all visible items in a view.
You can access this command when you right-click a blank area in a table. On the shortcut
menu click Select All.

Duplicate Command (Edit Menu)


This command is available when you select an item in the Electrical Index or the Reference Data
Explorer. When you duplicate an item, the software creates the new item with a unique item
tag. If a naming convention is defined for the item type, the new item tag follows that naming
convention.

On the Preferences dialog box, General tab, under Open after creating or duplicating an
item, you can specify whether to open the Item Tag dialog box when you duplicate the item.
Some items have a Common Properties dialog box from which you can edit the most
common properties for the item. You can specify in the preferences to open this dialog box
directly when you duplicate the item.

Rename Command (Edit Menu)


This menu option is available when you select an item in the Electrical Index, Electrical
Engineer, or Reference Data Explorer.
Opens the Item Tag dialog box (on page 710), which allows you to rename the selected item.

Align Command (Edit Menu)


Allows you to align two or more objects in a drawing.

590

SmartPlant Electrical User's Guide

Menu Commands

Nudge Command (Edit Menu)


Allows you to use the arrow keys on your keyboard to move a drawing item.

Move Command (Edit Menu)


Moves items from one location to another. You can specify the locations by clicking the drawing
sheet or by entering relative values in the Move ribbon. You can move one or multiple items at a
time, and you can move select sets. You can access this command from the Edit menu or the
main toolbar.
You can use other view manipulation commands, such as Zoom, Fit, and Pan, while you
are using the Move command. When you finish manipulating the view, the software returns you to
the Move command at the point where you were when you started manipulating the view.

Rotate Command (Edit Menu)


Rotates one or more items a precise distance or angle about a specified point. You can access
this command from the Edit menu and the main toolbar, too.
You can rotate an item about its center with the rotate component handle. The rotate
handle appears as a green circle to the right of the selected item.

Mirror Command (Edit Menu)


Reflects one or more selected items about a line or axis that you define. You can mirror without
copying, or mirror and copy. You can access this command from the Edit menu or the main
toolbar.
You can use mirror handles to mirror an item about its center. The mirror handle appears
as a green plus sign at the right center of the item when you select the item.

Fit to Page Command (Edit Menu)


Rescales the graphic items of a drawing into the drawing working area.

Activate Connection Mode Command (Edit Menu)


Allows you to add connectors between all available connection points on symbols.

Activate Association Mode Command (Edit Menu)


Allows you to create an association between a control station or instrument and an equipment
item.

SmartPlant Electrical User's Guide

591

Menu Commands

Show/Hide Association Connectors Command (Edit


Menu)
Toggles the display of logical connectors that show non-power flow associations between items in
cable block diagrams.

Activate Jumper Mode Command (Edit Menu)


Allows you to connect jumpers in a wiring diagram.

Disconnect (Edit Menu)


This menu option is available when working in a cable block diagrams.
Allows you to select a cable and disconnect the wiring items that the cable is connecting. This
action removes the cable from the current drawing. This action does not delete anything from the
database. Note that this action only disconnects the items from each other. The software retains
the association between the item and the cable.

Change Branch Orientation Command (Edit Menu)


This menu command is available when you select a root power source in an open single line
diagram.
Opens the Change Branch Orientation dialog box, which allows to change the orientation of a
branch connected between a selected power source and a bus.

Remove (Edit Menu)


This menu option is available when working with cable block diagrams, single line diagrams and
wiring drawings.
Allows you to remove an item from a cable block diagram, single line diagram, or a wiring
drawing. This action does not delete the item from the database.
This procedure only works for SLDs created using a blank SLD template. It cannot be
used on SLDs that were automatically created by the software.

Redlining Command (Edit Menu)


Turns on or off the redlining mode for single line diagrams.

Move Cell Command (Edit Menu)


Allows you to move a cell to another location in a PDB Layout grid.

592

SmartPlant Electrical User's Guide

Menu Commands

Remove Cell Command (Edit Menu)


Allows you to remove a cell to from a PDB Layout grid.

Insert > Image Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Opens a dialog box where you can navigate to an image to insert in the drawing.

Insert > Symbol Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Opens a dialog box where you can navigate to a symbol to insert in the drawing.

Insert > Text Command (Edit Menu)


This menu option is available after opening an SLD or a schematic drawing.
Opens the Text Properties dialog box (on page 762), which enables you to add or modify
annotation or redlining text and create a watermark.

Insert > Legend Command (Edit Menu)


This menu option is available after opening an SLD drawing.
Opens the SLD Legend dialog box (on page 811), which enables you to add a legend showing the
meaning of all the symbols that appear in the default symbol folder and any other symbols that are
specific to the current single line diagram.

Insert > Line Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Allows you to insert a redlining line in the drawing.

Insert > Circle Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Allows you to insert a redlining circle in the drawing.

SmartPlant Electrical User's Guide

593

Menu Commands

Insert > Rectangle Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Allows you to insert a redlining rectangle in the drawing.

Insert > Curve Command (Edit Menu)


This command is available after opening a single line diagram (SLD) or schematic drawing.
Allows you to insert a redlining curve in the drawing.

Text Command (Edit Menu)


This menu option is available after opening an SLD or a schematic drawing.
Opens the Text Properties dialog box (on page 762), which enables you to modify an annotation
text string that you have selected in a drawing.

Document Properties Command (Edit Menu)


This menu option is available when you open a drawing or select a drawing in the Electrical
Index.
Opens the Document Properties dialog box (on page 734), which enables you to enter or modify
the document name, description and revisions.

If you choose this command without first opening a pertinent document, all the options in the
dialog box options appear in read-only mode.
If you click outside the drawing, this command is not available. To access this command, first
select an item in the drawing.

Common Properties Command (Edit Menu)


Opens the Common Properties dialog box for the selected item where you can enter electrical
properties as you require. This command is only available for items that have a dialog box, such
as motors, loads, converting equipment, cables, control stations, and so forth.

Table Properties Command (Edit Menu)


Opens the Table Properties dialog box, which enables you to specify the item type (such as
Battery Bank, Cable, and Load), a layout for the item type which determines how the software
presents the item type data, and if required, a filter.

594

SmartPlant Electrical User's Guide

Menu Commands

Transformer Connections and Tapping Command


(Edit Menu)
This menu option is available when you select a transformer in the Electrical Index.
Opens the Transformer Connections and Tapping dialog box (on page 729), which enables you to
set options for defining the types of connection (Delta, Wye, and so forth) and neutral grounding
for 3-phase transformers in your project. Also allows you to specify tapping arrangements on the
primary and secondary transformer windings for transformers with all types of feeds.

Previous Zoom Level Command (View Menu)


Restores the previous view of a drawing.

Refresh Command (View Menu)


Refreshes the drawing or report with updated data.

Show Selected Electrical Branches Only Command


(View Menu)
Filters the display of the Electrical Engineer window and shows only the selected branches of the
network structure.
To display all the existing data in the Electrical Engineer, close the Electrical Engineer and
open a new session by clicking

on the main toolbar.

Show in New Window Command (View Menu)


Filters the display of the Electrical Engineer window and shows only the selected branches of the
network structure in a new Electrical Engineer window.

SmartPlant Electrical User's Guide

595

Menu Commands

Show Items of All Plant Groups Command (View


Menu)
Toggles the display of the Electrical Index, Reference Data Explorer, and Tabular Editor to
show all items in the plant for which you have the appropriate access rights or to show only items
that belong to plant groups in the current login path. For example, in a plant hierarchy 7 with the
following tree:

Logging into Unit 101 filters out all items except for those associated with Unit 101, Area 100, and
Plant 1. The software filters out items associated with Unit 100 or with Area 200 and its units (Unit
200, Unit 201).

Show Related Items (View Menu)


Opens a new frame and shows all items related to main selected item.

Add Filter Command (View Menu)


Adds a filter tab to the drawings in the Design window. This command displays the Select Filter
dialog box (SppidSelect_Filter_Dialog_Box.htm), which contains a subset of the commands in
Filter Manager.

Save Settings Command (View Menu)


Stores all filters if the active view is a drawing view. Stores the table layout and column widths if
the active view is a table view.
Your settings are automatically saved.

Zoom Area Command (View Menu)


Allows you to select an area of a drawing that zooms to fit the entire working area of a drawing.

Zoom In Command (View Menu)


Allows you to zoom in on a drawing by fixed increments.

Zoom Out Command (View Menu)


Allows you to zoom out on a drawing by fixed increments.

596

SmartPlant Electrical User's Guide

Menu Commands

Fit Command (View Menu


Allows you to resize the drawing to fit the working area of the drawing.

Pan Command (View Menu)


Allows you to pan across the drawing to view different areas of the drawing.

Show Grid Command (View Menu)


Allows you to display grid lines in an open drawing.

Snap to Grid Command (View Menu)


Snaps the cursor to grid points in an open drawing.

Show Auxiliary Graphics Symbology


Enables you mark the auxiliary graphics in a cable block diagram.

Display > Properties Window Command (View Menu)


Turns the display of the Properties window on or off.

Display >Working Area Command (View Menu)


Displays the working area of an automated drawing.

Display >Item Status in Project Command (View Menu)


Allows you to show the status of selected items in a project.

Toolbars Command (View Menu)


Opens the Toolbars dialog box, which allows you to create new toolbars and displays or hide
selected toolbars. You can change toolbar color schemes and button sizes.

SmartPlant Electrical User's Guide

597

Menu Commands

Design PDB Layout Command (Actions Menu)


This menu option is available after selecting a power distribution board in the Electrical Index.
Allows you to design a PDB layout for a selected power distribution board. After designing a PDB
layout, you can open a the layout drawing for a particular PDB and make the required cell
associations with appropriate layout grid units.

Batch Load Association Command (Actions Menu)


Opens the Batch Load Association dialog box (on page 674), which allows you to associate
multiple loads with a power distribution board (PDB) and display the aggregate calculated
electrical consumption.

Total Bus Load Validation Command (Actions Menu)


Opens the Total Bus Load Validation dialog box (on page 761), which allows you to validate the
total loads on buses for selected power distribution boards or buses.

Calculate Bus Loads > Selected PDBs or Buses


Command (Actions Menu)
Calculates load totals for selected buses or PDBs.

Calculate Bus Loads > All Plant Buses Command


(Actions Menu)
Calculates load totals for all the buses in your plant.

Associate Bus with PDB Command (Actions Menu)


Allows you to associate a free-standing bus with a power distribution board.

Dissociate Bus from PDB Command (Actions Menu)


Allows you to dissociate a selected bus from a PBD and make this bus a free-standing bus.

598

SmartPlant Electrical User's Guide

Menu Commands

Generate SLD for PDB Command (Actions Menu)


This menu option is available after selecting a power distribution board in the Electrical Index.
Opens the Single Line Diagram Options dialog box (on page 798), which allows you to define SLD
generation settings for a selected power distribution board.

Generate Schematic Command (Actions Menu)


This menu option is available after selecting a load in the Electrical Index.
Opens the Generate Schematic dialog box (on page 786), which enables you to generate a
schematic drawing for the selected load.

Define Document Reference Command (Actions


Menu)
Opens the Document Reference Definition dialog box (see "Define Document Reference Dialog
Box" on page 732), which enables you to define a reference for an external document.

Associate Documents Command (Actions Menu)


Opens the Associate Documents dialog box (on page 731), which enables you to associate
external documents with selected electrical items.

Global Revisions Command (Actions Menu)


Opens the Global Revisions dialog box (on page 741), which allows you to assign and manage
revisions for a group of documents.

Compare Documents Command (Actions Menu)


Opens the Document Properties dialog box (on page 734) where you can select an archived
version of the current document with which you want compare the document that you have
selected.

Resolve Symbol Inconsistencies Command (Actions


Menu)
Opens a dialog box that allows you resolve symbol inconsistencies in single line diagrams.

SmartPlant Electrical User's Guide

599

Menu Commands

Associate Custom Symbols Command


Opens the Associate Custom Symbols dialog box where you can associate a customized
symbol with a document type and specific item tag. You also remove a customized symbol from
here.

Dissociate Command (Actions Menu)


This menu option is available when you select an electrical item in the Electrical Engineer.
Cancels the electrical association of the selected electrical item with its feeding item in the
Electrical Engineer.

Move Items Command (Actions Menu)


Displays the Move Items to Plant Group dialog box (on page 612), which allows you to select the
plant group to which you want to move selected electrical items.

Switch Plant Operational Mode Command (Actions


Menu)
Opens the Switch Plant Operational Mode dialog box that enables you, in one single operation,
to switch all the plant loads, instruments and cabinets to a plant operational case (mode) that you
select.

Cables > Batch Size Cables Command (Actions Menu)


This menu option is available when you select a cable in the Electrical Index.
Opens the Batch Size Cables dialog box (see "Batch Size Cables Window" on page 624), which
enables you to size cables in batch mode.

Cables > Replace Cables Command (Actions Menu)


This menu option is available when you select a cable in the Electrical Index.
Opens the Replace Cables dialog box (on page 647), which enables you to replace the
characteristics of a group of project cables using specified properties from a common reference
cable.

600

SmartPlant Electrical User's Guide

Menu Commands

Cables > Apply Reference Data to Cables Command


(Actions Menu)
Opens the Apply Reference Data to Project Cables dialog box (on page 620), which allows you to
select project cables for which the reference data has changed and to apply the new reference
data values to those project cables.

Cables > Assign Drums to Cables Command (Actions


Menu)
Opens the Assign Drums to Cables Wizard (see "Drum and Cable Options (Assign Drums to
Cables Wizard)" on page 621), which allows you to assign cables automatically to cable drums.

Cables > Predefined Routes Command (Actions Menu)


Opens the Predefined Routes Dialog Box (on page 664), which enables you to organize cableway
segments in predefined routing paths.

Cables > Batch Cable Routing Command (Actions


Menu)
This menu option is available when you select a cable in the Electrical Index.
Opens the Batch Cable Routing Dialog Box (on page 657), which enables you to effect cable
routing in batch mode.

Cables > Define Color Pattern Command (Actions


Menu)
Opens the Define Color Pattern dialog box (on page 644), which allows you to specify wire color
patterns that you can apply to cables.

Cables > Refresh Load Data for Power Cables


Command (Actions Menu)
After you modify parameters that affect cable sizing in one or more loads in the plant, this option
refreshes the sizing data parameters for all the cables attached to those loads.

Cables > Associate Cables with Equipment Circuits


Command (Actions Menu)
Associates the 'From' side of all non-power cables for control stations or instruments with the
feeder circuit for the load.

SmartPlant Electrical User's Guide

601

Menu Commands

Cables > Batch Cable Side and Gland Associations


Command (Actions Menu)
Opens the Batch Cable Side and Gland Associations Dialog Box (on page 623), which enables
you to batch associate cable sides with an item for non-power cables and to associate cable sides
with glands for cables of all categories.

Cables > Batch Cable Connection Command (Actions


Menu)
Opens the Batch Cable Connection dialog box (on page 821), which allows you to connect
numerous project cables in batch mode.

Cables > Batch Cable Dissociation from Drums


Command (Actions Menu)
This menu command is available when you select a number of drums in the Electrical Index.
Allows you to select a number of cable drums and dissociate them from the assigned cables in
batch mode.

Cables > Insert Power Cable (Actions Menu)


This command is available when you select an equipment item in the Electrical Engineer.
This command opens the Insert Power Cable dialog box, where you select a power cable for
inserting between two items of equipment, under the item selected in the Electrical Engineer.
For example, you can insert a power cable between a transformer and a generator to create an
electrical connection.

Parallel Equipment Assistant Command (Actions


Menu)
Opens the Parallel Equipment Assistant that allows you to define parallel relations between
electrical items.

602

SmartPlant Electrical User's Guide

Menu Commands

Fix Inconsistencies Command (Actions Menu)


Opens the Fix Inconsistencies dialog box (on page 817), checks the selected items for
inconsistencies against the rules defined in the Rule Manager, fixes found inconsistencies, carries
out copy rules, and produces a summary detailing the number of inconsistencies found, the type
of inconsistency, and the number of items checked. You can also produce a more detailed log as
an Excel sheet, by clicking Show Log.

Copy Driver Power Absorbed (Actions Menu)


Opens the Copy Driver Power Absorbed dialog box (on page 689), which allows you copy the
value of the Driver Power Absorbed of process equipment items to the Brake Power value of
the associated motors. This functionality exists for process equipment and motors that have
been retrieved from SmartPlant P&ID.

Register Report Command (Actions Menu)


Opens the Register Report Common Properties dialog box (see "Registered Report Common
Properties Dialog Box" on page 742), which allows you to save a report based on a particular
template to the database for the purpose of assigning revisions.

Gap Now Command (Tools Menu)


Performs gapping on the current drawing - that is, on the entire drawing. Gapping refers to the
condition that exists when two lines intersect graphically on the drawing but do not physically
intersect in the plant.

Optimize Overlapping Connectors


Repositions overlapping connectors so that they do not overlap on the drawing sheet.

Apply Options Command (Tools Menu)


Opens the Apply Options dialog box (on page Error! Bookmark not defined.), which enables
you to apply default profiles, circuits, control stations, and lookup tables, all of which you define in
the Reference Data Explorer.

Drawing Options Command (Tools Menu)


This menu option is available after opening a single diagram drawing.
Opens the Single Line Diagram Options dialog box (on page 798), which allows you to redefine
SLD generation settings and regenerate the drawing.

SmartPlant Electrical User's Guide

603

Menu Commands

Update Select Lists (Tools Menu)


Opens the Update Select Lists dialog box (on page 618), which allows you to add or edit items on
SmartPlant Electrical select lists.

Apply Naming Conventions (Tools Menu)


Applies the naming conventions as defined in the Options Manager, to the items in your plant.

ETAP Interface > Publish All (Tools Menu)


Publishes all the available electrical analysis SLDs to ETAP (full publishing).

ETAP Interface > Retrieve (Tools Menu)


Allows you to navigate to the ETAP project XML file from which you retrieve ETAP project data.

New Command (Reports Menu)


Opens the New Report Template dialog box that allows you to create plant-level and user-level
report templates.

Edit Command (Reports Menu)


Opens the Edit Report Template dialog box. This dialog box lists all the available report
templates. You can select a template and view its properties and edit it in Microsoft Excel.
You must have valid privileges to edit a report template.

Delete Command (Reports Menu)


Displays the Delete Report Template dialog box, which allows you to select and delete a report
template.
You must have valid privileges, granted in SmartPlant Engineering Manager, to delete a
report template.

Plant Reports Command (Reports Menu)


Allows you to choose a report and specify what items to report on.

My Reports Command (Reports Menu)


Allows you to choose one of your custom reports and to specify what items to report on.

604

SmartPlant Electrical User's Guide

Menu Commands

New > Table Command (Window Menu)


Creates a table view, which allows you to view and edit item data in a tabular format. The Table
Properties dialog box appears so that you can define the items and properties for the new table
view.

New > Electrical Index Command (Window Menu)


Opens a new Electrical Index window.

New > Electrical Engineer Command (Window Menu)


Opens a new Electrical Engineer window.

New > Reference Data Explorer Command (Window


Menu)
Opens a new Reference Data Explorer window.

New > Reference Electrical Engineer Command


(Window Menu)
Opens a new Reference Electrical Engineer window.

New > Project Management Command (Window Menu)


Creates a table view, which allows you to perform various operations relating to
projects. Depending on whether you are in As-Built or a project, this command opens the Project
Management (As-Built) table (see "Project Management Table (As-Built)" on page 748) or the
Project Management table (see "Project Management Table (Project)" on page 751) (for the
project) respectively.

SmartPlant Electrical Help Command (Help Menu)


Opens the SmartPlant Electrical Online Guide.

SmartPlant Electrical User's Guide

605

Menu Commands

Printable Guides Command (Help Menu)


Opens the Printable Guides Help page for accessing the printable guides as .pdf files.

SmartPlant Electrical on the Web Command (Help


Menu)
Activates your World Wide Web browser and opens the SmartPlant Electrical World Wide Web
page. On this page, you can access registration and support information, learning tools, and other
items to help you use SmartPlant Electrical more efficiently.

SmartPlant Electrical Web Forum Command (Help


Menu)
Allows you to access Intergraph's online community of SmartPlant Electrical users. In addition to
facilitating communication between Intergraph personnel and other SmartPlant Electrical users,
the forum also provides access to short, informative video clips that illustrate step-by-step
guidelines for performing sophisticated workflows. These clips may be viewed online, or they may
be downloaded to your local machine for later viewing.

About SmartPlant Electrical Command (Help Menu)


Opens the About SmartPlant Electrical window.

Copy Command (Edit Menu - Tabular Editor)


Copies the value in the selected row, cell, or group of cells, to the Clipboard so that it can be
pasted somewhere else. This command does not remove the value from the table. Values
placed on the Clipboard remain there until newer values are copied over them.

Paste Command (Edit Menu - Tabular Editor)


Places the value or values on the Clipboard into the selected row, cell, or group of cells. Values
do not paste successfully if you have selected a cell for which the value is strictly generated by
validation or calculation, or is read-only. When pasting, you must select the same number of rows
as the number of rows that were copied to the Clipboard.

Select All Command (Edit Menu - Tabular Editor)


Selects all the cells in the active Tabular Editor view. You can use this command to create a
select set and view its properties in the Properties window, for instance.
You can access this command when you right-click an area within the Tabular Editor. On
the shortcut menu click Select All.

606

SmartPlant Electrical User's Guide

Menu Commands

Tabular Editor Shortcut Menu


The shortcut menu included commands that are frequently used when you are working with the
Tabular Editor.
Copy
Copies the value in the selected row, cell, or group of cells, to the Clipboard so that it can be
pasted somewhere else. This command does not remove the value from the table. Values
placed on the Clipboard remain there until newer values are copied over them.
Paste
Places the value or values on the Clipboard into the selected row, cell, or group of cells. Values
do not paste successfully if you have selected a cell for which the value is strictly generated by
validation or calculation, or is read-only. When pasting, you must select the same number of rows
as the number of rows that were copied to the Clipboard.
Multi-Tag Paste
Pastes data copied from a single row into the selected rows. This command is only available
where you select more than one row to paste into. The software validates and calculates those
properties that are based on input properties. Properties such as item tags and read-only data
are not copied.
Refresh
Refreshes the table with current data from the database. Note that in a multi-user environment,
more than one person may be updating data. Your opened table does not refresh automatically
and you therefore need to run this command periodically to display the most recent data. Where
another user has made a change on an item for which you have opened the properties in the table,
the software notifies you that your input will be rejected until you first refresh the data.
Delete
Deletes the selected items from the database.
Select All
Selects all the cells in the active Tabular Editor view. You can use this command to create a
select set and view its properties in the Properties window, for instance.
Duplicate
Creates a new item identical to the selected item. If the value of the Comply To Naming
Convention tag property for the item is set to True, the duplicated item tag is based on the
naming convention for the item type.
Rename
Enables you to rename an existing tag name. Depending on the value of the Comply To Naming
Convention tag property for the item, you can either completely override the tag or modify only
that section of the tag structure that is not protected by the naming convention.
New Item
Creates a new item of the same item type as the item type selected for the active Tabular Editor
view. Where selected items belong to more than one item type, for example a motor and a motor
with a space heater, the software prompts you with a list from which you need to select the type of
item you want to create.
Common Properties
Opens the Common Properties dialog box for the selected item where you can enter the
required electrical properties. This command is only available for items that have a dialog box,
such as motors, cables, control stations, and so forth.

SmartPlant Electrical User's Guide

607

Menu Commands
Table Properties
Opens the Table Properties dialog box, which enables you to specify the item type (such as
Battery Bank, Cable, and Load), a layout for the item type which determines how the software
presents the item type data, and if required, a filter.
Save Settings
Stores the table layout and the order and width of the Tabular Editor columns.
Auto Filter
Allows you to filter the tags according to various values that the selected property contains. When
you click the Auto Filter command, arrows appear at the top of each column. Click on the arrow
at the top of the column that contains the data you want to filter on and choose the value from the
list that appears. You can include more than one property in the auto filter of your table, creating
a chained filter.
Click this command again to remove the filter.
To create more elaborate filters and displays, you need to use the Table Properties command
and enter options on the Table Properties and Advanced Table Properties dialog boxes.
Freeze Panes
Allows you to scroll through the Tabular Editor while keeping the display of specified rows and
columns constant. For instance, the first column can contain the item tag, but you want to always
see the item tag as you scroll to the right end of the rows to view the supplier.

608

SmartPlant Electrical User's Guide

SECTION 39

Windows and Dialog Boxes


General
Customize Dialog Box
Changes the display of toolbar buttons and menus according to your needs. This dialog box
opens when you click Tools > Customize on the main menu bar.
Menu Tab
Toolbars Tab (see "Toolbars Tab (Customize Dialog Box)" on page 610)

Menu Tab (Customize Dialog Box)


Adds or removes commands from menus or the main menu bar. You can add a command to an
existing menu or build a custom menu with the commands that you want. Or you can add a single
command to the main menu bar.
Add Command Places a command on a menu. This button is available only when you select a
command or macro in the Commands box or Macros box.
Add Menu Places a menu at the level currently open on the menu tree. When you add a menu
with this option, you can add commands to the new menu later. If you add a menu to an existing
menu, you create a cascading menu. After you click this button, you can type the name that you
want in the tree view and then enter it by clicking any other location on the dialog box.
Browse Opens the Select Macro Directory dialog box. When you select a folder and click OK,
the Macros list displays the macros for the folder that you selected. The Browse button appears
only when you choose Macros in the Categories list.
Categories Allows you to specify the category that you want to select a command or macro
from. Then you can add the command or macro to the menu or main menu bar. When you select
the title of a group of commands in this box, you can click the title of a command in the
Commands list. When you select Macros in the Categories list, you can select a macro from the
Macros list.
Commands Allows you to specify the command that you want to add to the menu.
Description Displays a description of the command that you selected before you add it to a
menu. Descriptions do not appear for macros.
Macros Allows you to specify the macro that you want to add to the menu. If you select a
macro, you can click Browse to change the folder for macros.
Menu Tree Lists the menus and their associated commands or macros. To see all the
commands on a menu, double-click a menu name or click the "+" next to the menu name. When
you click Add Command, Add Menu, or Remove, the changes show up on the menu tree. Also,
you edit menu and command names in this view.
Place Into Selected Menu Overrides the default placement and places a command or macro
on the menu that is currently selected in the menu tree. If you do not set this option, then the
macros, commands, or menus are added at the level that is currently open in the menu tree.
Reset All Restores all menus and the main menu bar to the original settings.
Remove Removes the command or menu that you selected in the menu tree.

SmartPlant Electrical User's Guide

609

Windows and Dialog Boxes

Toolbars Tab (Customize Dialog Box)


Adds or removes commands from toolbars.
Categories Lists the categories of the toolbars that you can customize. Choose one and the
corresponding buttons appear in the Buttons area.
Buttons Lists the buttons available in the active category. You can drag a button from this area
onto a toolbar.
Description Describes the button selected in the Buttons area.

Custom Button Dialog Box


Allows you to assign a toolbar button icon to a macro. This dialog box opens when you drag a
macro from the Toolbars tab of the Customize dialog box to the toolbar.
Buttons Displays the available icons.
Assign Specifies the icon for your button and closes the dialog box.
Browse Opens the Select Bitmap File dialog box, which allows you to look for an icon on your
local computer or on the network.

Description Dialog Box


This dialog box allows you to enter a long text value in the Description text box in the Common
Properties dialog box for an item. For long descriptions, click the ellipsis button
the Description dialog box.
Description Allows you to enter a description for the item.

to bring up

Very long descriptions cannot be displayed in their entirety in labels, reports, and so forth.

File Properties Dialog Box (File > Properties)


Tracks information about the properties of a drawing. There are five tabs:
General (see "General Tab (File Properties Dialog Box)" on page 739)
Summary (see "Summary Tab (File Properties Dialog Box)" on page 739)
Statistics (see "Statistics Tab (File Properties Dialog Box)" on page 740)
Units (see "Units Tab (File Properties Dialog Box)" on page 740)
Browser
You must save the drawing before you can access the Statistics and Summary tabs of
the File Properties dialog box.
Allows you to search for a specific item based on user-defined search criteria. The items that are
available depend on the object from which you invoke the Find command.
Tag Enter the tag name of an item for which you want to search. You can type an asterisk (*)
as a wildcard character to find multiple characters or a question mark (?) as a wildcard character
for a single character.
Equipment type Specifies the type of item for which you want to search. When you use Find
from the Reference Data Explorer, the equipment type that appears is Ref Plant Item; when you
use Find from the Electrical Index or the Electrical Engineer, the equipment type that appears
is Plant Item. In specific dialog boxes, where you use the Find dialog box to associate items, the
software displays only the equipment type appropriate for the item that you select.

610

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Layout If one or more layouts are defined in the Tabular Editor for the selected equipment type,
you can select a specific layout to specify the property columns that appear in the list of results. If
you do not specify a layout, the software displays the results using the default columns.

Properties
Show only properties that have data values Select to filter the list of properties so that only
those properties that have data values are displayed.
You can display properties alphabetically or by categories by clicking the corresponding
display mode button. Click
to display alphabetically. Click
to display by categories.
Property Displays the properties of the selected equipment type.
Value Enter the value of the property that appears in the Property box to search for items that
have that value only. You can type an asterisk (*) as a wildcard character to find multiple
characters or a question mark (?) as a wildcard character for a single character. If the property
has values that appear in a list, select the desired value from the list.

Results
Displays the search results with a list of the items that correspond to the criteria that you entered in
the upper part of this dialog box.
No. The sequence of the item as it appears in the list of results.
Item Tag The tag name of the item.
Equipment Type The equipment type to which the item belongs.
Find Now Click to start a search of the items that correspond to the equipment type, and where
relevant, the other filter criteria that you select for the search.
New Search Click to clear all search criteria in preparation for a new search.
Results Displays a list of the items that meet the search criteria. Highlight an item on the list
and select it by doing one of the following:
Press the ENTER key.
Double-click the item.
Where you are allowed to select more than one item, for example when adding typical
control stations to a motor profile, press the CTRL or SHIFT keys to make multiple
selections, and then click OK or Apply.
OK Click to navigate to or select items that are highlighted in the Results window and close the
Find dialog box.
Cancel Click to close the Find dialog box without navigating to or selecting highlighted items.
You can also press the ESCAPE key to cancel the operation.
Apply Click to navigate to or select items that are highlighted in the Results window. This
option is useful when it is possible to select more than one item and you want to do so without
closing the dialog box.

SmartPlant Electrical User's Guide

611

Windows and Dialog Boxes

Move Items to Plant Group Dialog Box


This dialog box appears when you click Actions > Move Items.
You can move multiple or single items to another plant group regardless of the hierarchy level
definitions made in the Options Manager. The plant group definitions made in the Options
Manager serve only as default settings and do not prevent you from moving items to other
hierarchy levels. Also, you can move items to a plant group that is different from the one in which
these items were created.
Expand the hierarchy to the desired plant group type and select the plant group to which you want
to move the items.

New Item Dialog Box


This dialog box appears when you select an item type in the Reference Data Explorer, in the
Electrical Index, or in the Tabular Editor, and you click File > New > Item where it is possible to
create more than one type of new item. The dialog box displays a list of available item types from
which you select the desired item type for the new item.
Available items Displays a list of item types. The available item types depend on the
selection you made prior to opening the dialog box. Select the desired item type from the list.

Open Plant Group Dialog Box


This dialog box appears when you click File > Open > Plant Group and it allows you to navigate
to a specific plant group within a plant.
Expand the hierarchy to the desired plant group type and select the plant group where you want to
work.
Select Plant Opens a dialog box with a list of plants for selection.

Open Plant Structure Dialog Box


Displays the structure of the plant to which you are connected. Enables you to set options for
connecting to a site with a different plant structure.
Available plant structures Lists the available plant structures. You can select only one plant
structure at a time.
Application type Displays the application associated with this database.
Open Connects you to the selected database and checks whether you have the correct access
privileges for the selected plant.
Site Server Opens the Open Site Server dialog box, where you can select a SmartPlant
initialization file from local and network directories. Plants that correspond to the initialization file
you choose are subsequently displayed in the list of available plants in the database.

612

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Preferences Dialog Box


Allows you to customize default preferences for various general options, preferences related to
single line diagram (SLD) options, PDB load summary generation settings, and delete loads
settings.
General Tab (see "General Tab (Preferences Dialog Box)" on page 613)
SLD Tab (see "SLD Tab (Preferences Dialog Box)" on page 613)
Reports Tab (see "Reports Tab (Preferences Dialog Box)" on page 615)
Delete Loads Tab (see "Delete Loads Tab (Preferences Dialog Box)" on page 616)

General Tab (Preferences Dialog Box)


Allows you to customize default preferences for creating and duplicating new items, displaying
PDB item tags in the Electrical Engineer, and activating log file generation.

Open after creating or duplicating an item


Allow you to customize a preference for software response after creating or duplicating an item.
None Displays a created or duplicated item in the Electrical Index or the Reference Data
Explorer without opening either the Item Tag or Common Properties dialog box, with a default
property value and naming convention defined in Options Manager.
Item Tag dialog box Opens the Item Tag dialog box that allows you to type the item tag name
for the new item. The text can either be free text or a mask that fits the item naming convention.
Common Properties dialog box Opens the Common Properties dialog box for the created
or duplicated item, where you can enter electrical properties as you require.

Electrical Engineer display options for buses, incomers, bus risers, and auxiliary contacts
Allows you to display in the Electrical Engineer the names of associated PDB item tags as part of
the names of buses, incomers, bus risers, and auxiliary contacts.
Include associated PDB item tags Displays in the Electrical Engineer buses, incomers, and
bus risers together with the associated PDB item tags. For example, MCC 200 \ Bus A.

Log file options


Allow you to generate various error log files to display errors that can occur during a batch
operation, such as batch generation of schematics, batch cable sizing, batch deletion of items,
batch load association, and so forth.
Activate log file generation Enables log file generation options.

Display license expiration reminder days in advance


Allows you to specify the number of days (between 1 and 30) prior to license expiration that the
software will display an advance warning.

SLD Tab (Preferences Dialog Box)


Allows you to specify various preferences for single line diagrams (SLD).

SLD drawings
Allow you to set general preferences for SLD generation.

SmartPlant Electrical User's Guide

613

Windows and Dialog Boxes


Save settings of last generated drawing Saves and then applies all the settings defined on
the Single Line Diagram Options dialog box apart from the settings defined on the Preferences
dialog box (SLD margins and Distance for SLD internals). This preference option takes effect
after generating an SLD and applies to all subsequent SLD generations. Clearing the Save
settings of the last generated drawing check box saves only the SLD margin preferences and
returns all the other SLD options to the application defaults.
Use bus tie symbols This option deals with the way the software represents the connection
between two redundant buses in a power distribution board.
Select this option to show a horizontal representation between two buses using the
BusTie.sym file. In this case, the software shows the connection between the two buses as a
straight bus-tie connection without showing the items connected between and within the
circuits. Note that the BusTie symbol is a "circuit" type symbol and has its first connection
point on the rightmost side and the second connection point at the leftmost side. Also, the
item property in the SLD displays only the coupler information. Furthermore, if you use the
Find in SLD command, the software finds the pertinent coupler and not the bus riser.
Clear this option to show a vertical representation of a connection between two buses. This is
the standard bus coupler-riser circuit connection representation that includes both coupler and
the riser circuits and displays them as vertical objects, connected to each other. The software
displays both circuits as standard arrows.
Retrieve last saved position of electrical items This option deals with the way the software
shows the position of electrical items in an SLD that you open from the Documents folder in the
Electrical Index. Every time you open an existing SLD, the software regenerates the SLD by
retrieving the relevant data from the database. The software optimizes the positioning of the SLD
elements in the drawing every time the SLD is generated. If you move an electrical item and then
save the SLD, the software can open the saved SLD showing the last saved position of the
electrical items or regenerate the SLD and thus optimize the positioning of the electrical
items. Also, you can move and resize the frames that the software draws around items belonging
to PDBs and around circuits in each cell. The software retains these changes after saving the
drawing. Before reopening a saved SLD, you can choose whether or not to display the last saved
position by selecting or clearing the Retrieve last saved position of electrical items check box.
Note that this option affects the positioning of electrical items only. The software always retains
the position of redlining, annotation, and legend elements as they were saved the last time.
Select this option to show the position of electrical items as they were in the last saved
drawing.
Clear this option to revert to the optimized positioning of electrical items by regenerating the
SLD.

SLD margins
Define the default unit of measure for SLD margins and distance between the page edges and the
SLD drawing so that the drawing does not overlap the title block and the SLD border.
Units Select the unit of measure for the SLD margins (mm or inches). The unit of measure for
top, bottom, left and right margins changes dynamically, according to the selection that you make.
Top Allows you to type the value for the top drawing margin.
Bottom Allows you to type the value for the bottom drawing margin.
Right Allows you to type the value for the right drawing margin.
Left Allows you to type the value for the left drawing margin.

Distances for SLD internals


Set a distance between buses, circuits and circuit internals in a generated SLD.

614

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Distance between buses Allows you to type a value for the horizontal distance between the
buses and select a unit of measure.
Distance between circuit internals Allows you to type a value for the vertical distance
between the circuit internal components (fuses, starters, and so forth) and select a unit of
measure.
Distance between circuits Allows you to type a value for the horizontal distance between the
circuits above and below the buses and select a unit of measure.

Reports Tab (Preferences Dialog Box)


Allows you to specify the PDB loads that will take into account the coincidence factors and
whether and how to account for any loads connected to redundant buses.

Calculation method for All Feeder Load Summary Report


Allows you to specify the coincidence factor to be used in the calculation of the total connected
loads.
Use each load coincidence factor Uses the coincidence factor of each individual load to
calculate the total connected loads on the bus.
Use Bus PDB coincidence factor Uses the average coincidence factors of the bus to
calculate the total connected loads on the bus.

Inclusion of coupled buses in All Feeder Load Summary Report


Allows you to specify inclusion options of coupled buses in the All Feeder Load Summary
calculation.
Do not include coupled buses Includes in the calculation only those loads that are connected
to the current bus and does not include the loads that are connected on the redundant buses.
Include coupled buses connected by couplers only Includes in the calculation the loads
connected on the current bus as well as loads connected on all the redundant buses that are
connected to the current bus by a coupler circuit.
Include coupled buses connected by couplers and risers Includes in the calculation the
loads of the current bus as well as the loads on all the redundant buses that are connected to the
current bus by coupler and riser circuits.

(Check Box)
Account for converting equipment power losses When running bus load calculations,
allows you to instruct the software to calculate the total electrical consumption taking into account
converting equipment power losses. The software adds these power losses to the upstream
feeding bus and takes them into accounts as continuous loads. The same losses are also taken
into account in the All Feeder Load Summary report.

SmartPlant Electrical User's Guide

615

Windows and Dialog Boxes

Delete Loads Tab (Preferences Dialog Box)


Allows you to customize the Delete Loads default settings as set in Options Manager. You use
these settings to select which related (sub) items of a main item are deleted when deleting a main
item from the Electrical Index.

Delete associated items


Feeding power cables Allows you to delete feeding power cables.
Control, grounding, and instrumentation cables Allows you to delete associated control,
grounding, and instrumentation cables.
Control station and instruments Allows you to delete the associated control stations and
instruments.
Feeder circuits and cells Allows you to delete the associated feeding circuits and cells.
Schematic documents Allows you to delete the associated schematic documents.
I/O signals Allows you to delete the associated I/O signals.

Select Filter Dialog Box


Allows you to select an available filter, or add a new filter that is associated with your custom
folder.
Select an available filter by opening a folder in the tree view, selecting the required filter, and
clicking OK.
New Allows you to add a new filter to the selected filter folder.
Properties Opens the Properties dialog box of the selected filter.
For more information about filters, see Using Filters in the Filter Manager User's Guide, under
Using Filters.

Save as PDF Dialog Box


Converts the active drawing to a PDF document.
Sheets - Displays options for specifying which sheets will be converted to PDF. With multi-sheet
documents, you can specify that all sheets are converted or you can specify that only certain
sheets are converted.
Create bookmarks - Creates a bookmark for each sheet added to the PDF file.
Resolution - Modifies the dots per inch, or "dpi". The greater the dpi, the better the clarity.
Increasing the resolution setting increases the file size and can slightly increase the time required
to process some files.
Color - Creates a PDF using the colors available in the document. You can only create a color
PDF from a color drawing sheet.
Grayscale - Creates a PDF using a 256-color grayscale.
Pure black and white - Creates a PDF that has no color or grayscale. Anything that is not pure
white is drawn as black.

616

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


JPEG compression - Compresses images embedded in your document according to the
compression level you define. If your drawing contains a lot of images, compression settings are
very important for achieving good image quality at a manageable file size. Use the pull-down
menu to set the compression level. Compression levels in the High quality range do not
noticeably affect image quality, and produce larger file sizes than settings in the Low quality
range. However, using a mid-range compression level usually strikes the best balance in
creating a compact file while still maintaining enough information to product high-quality images.

Switch Plant Operational Mode Dialog Box


This dialog box enables you, in one single operation, to switch all the plant loads, instruments and
cabinets to a plant operational case (mode) that you select.
For this operation to work, you need to add new properties in user-defined fields for the alternate
case (mode) load data, create appropriate rules in Rule Manager, and define a filter in Filter
Manager. Once you make all these definitions, you can select a specific operational mode that will
trigger the copying mechanism in SmartPlant Electrical, thus switching to the appropriate
scenario. After switching to another operational mode, the software makes a global update of the
relevant values that affect all the direct electrical calculations that use these values. You can see
these values in the Properties window or the Common Properties dialog box for specific
electrical items.
Plant operational mode Allows you to select a scenario for electrical load consumption in your
plant.

Toolbars Dialog Box


Sets options for displaying, hiding, or changing toolbars. The settings on this dialog box are
remembered for the current user.
Toolbars Lists the available toolbars. You can select the box next to the toolbar you want to
display, hide, or change.
Toolbar Name Displays the name of the toolbar that you have selected.
New Accesses the New Toolbar dialog box in which you can specify a name for the new
toolbar.
Customize Adds buttons to or removes buttons from built-in toolbars with the Customize
dialog box.
Reset Resets the selected toolbar to the original icons.
Color Buttons Adds color to the toolbar buttons. If this option is cleared, toolbar buttons are
black and white.
Large Buttons Enlarges toolbar buttons so that they are easier to see.
Show ToolTips Displays on-screen descriptions of a toolbar button when the pointer pauses
over it.
Classic Icons Displays the toolbar icons using the classic icons. If this option is not selected,
toolbars use the high-color icons.
OK Saves changes and dismisses the dialog.
Cancel Ignores any changes and dismisses the dialog.
Help Displays the Help topic for this dialog.

SmartPlant Electrical User's Guide

617

Windows and Dialog Boxes

Toolbars Tab (Customize Dialog Box)


Allows you to customize existing toolbars by adding or removing commands and macros. You can
also create your own toolbars.
Categories Sets the category from which you want to select a command or macro to add to the
toolbar. When you select the category, a list of toolbar buttons specific to the selected category is
displayed in the Buttons box. When you select Custom Commands in the Categories box, the
Buttons box becomes the Custom Commands box and displays a list of available macros. Also,
a Browse button displays that you can use to open the Select Macro Directory dialog box.
Buttons/Custom Commands Specifies which button or macro from the active category you
want to add to a toolbar. If you select a macro, you can also click Browse and change the active
directory. When you change the active directory, the macro list in the Commands/Custom
Commands box displays a list of macros in the specified location.
Description Describes the selected button displayed in the Buttons/Custom Commands
box. Descriptions are not available for macros.
Browse Opens the Select Macro Directory dialog box where you can navigate to the directory
containing the macro you want to add to a toolbar. Browse appears only when you click Custom
Commands in the Categories box.

Update Select Lists Dialog Box


This dialog box allows you to add or edit items on SmartPlant Electrical select lists.
Sort - Opens the Sort dialog box. You can sort select entries based on entries in one or more
column.
Move Up Moves the chosen select entry row up one position.
Move Down Moves the chosen select entry row down one position.
Selected list Allows you to select a select list for updating. You can define new select lists in
the Data Dictionary Manager.
Dependent list Indicates that the value in the selected list depends on a particular selected
value in another list. For example, if you choose Model from the selected list, the dependent list
value is Manufacturer. If a list has no dependent list related to it, the value None appears.
Disable Select to hide the select list entry in the user interface. Clear to make the entry
available to users.
Value The name of the select list entry in the column. You can add select list entries by typing
in the Value column of the last row of the selected list. All entries in a particular select list must
have unique values, and you cannot delete entries in select lists.
Short Value A shortened name for the select list entry, if necessary, in the column. The short
value is the one that appears in drop-down lists in the user interface.
Dependent Value Provides a way to link related select lists, if a dependent list is available. For
example, Electrical Equipment Type is dependent on Electrical Equipment Subclass, which is
in turn dependent on Electrical Equipment Class. So the range of values that you see in the
Properties window is limited to values defined for a dependent list, if one is specified for the given
property. For instance, motors belong to the Electrical Equipment Subclass: Motor and to
Electrical Equipment Class: Electrical Equipment. The available values in the Electrical
Equipment Type select list, such as Squirrel Cage, apply only to motors, and do not appear in
lists for other electrical equipment subclasses.

618

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Sort Dialog Box


Allows you to sort select list entries by multiple combinations of Value, Short Value, and
Dependent Value, and then by ascending or descending order within those criteria. This dialog
box opens when you click Sort
on the toolbar of the Update Select Lists dialog box.

Sort Items by Specifies the value and the order that you want to display items in the drawing
software.
Ascending Sorts the selected items in order from the beginning of the alphabet or the lowest
number, depending on the type of entries in the select list.
Descending Sorts items starting from the end of the alphabet or the highest number,
depending on the type of entries in the select list.
Then by Sorts items by an additional value. For example, if you want to sort a select list by its
dependent values, you could sort entries with the same dependent value by their Short Value or
Value.
Clear All Resets all the sorting criteria to none, removing any changes that you made.

SmartPlant Electrical User's Guide

619

Windows and Dialog Boxes

Associations
Associated Drawings Dialog Box
Allows you to view all drawings that are associated with a specific item in the Electrical Index,
filter them by drawing type, and then select and open a drawing.
Filter by drawing type
Filters the drawings by their types. The types are:
All drawings
Schematics
Wiring diagrams
Cable block diagrams (CBD)
Single line diagrams (SLD)
PDB layouts
Associated Drawings
Document Displays the name of the document.
Description Displays a description of the document. (Only available if a description was
entered in the common properties of the selected item).
Drawing Type Displays the drawing type.
Open Drawing Opens the selected drawing.

Cables
Apply Reference Data to Project Cables Dialog Box
Enables you to update data in project cables in batch mode where the reference data for those
cables has changed.
Data window Displays project cables for which data has changed in the reference cables
associated with those project cables, with details of the cable category, cable tag, cable formation,
and the reference cable. Beside each cable name is a check box that allows you to select the
cable for applying the new reference data. For a parallel cable assembly, the software displays
only the first cable of the assembly; however it applies the reference data to all the cables in the
assembly.
Select all Allows you to select all the cables in the list for applying updated reference data.
Apply Applies the new reference data for the selected cables.
Close Closes the dialog box.
Compare Opens the Compare Project and Reference Cable Data dialog box (on page 642),
from which you can compare for the selected project cable the properties that have different
values in the project and reference cables.

620

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Assign Drums to Cables Wizard


Allows you to assign cables to cable drums in batch mode. The software allows you to specify
automatic creation of additional drums as needed or deletion of empty drums. While assigning the
selected cables to cable drums, the software will optimize this assignment so that you can utilize
the drum capacity to the optimum.
For detailed information about the logic used by SmartPlant Electrical to optimize cable drum
assignment, see Optimization of Cable Drum Assignment.

Drum and Cable Options (Assign Drums to Cables Wizard)


Choose options on this page to specify initially which cables you want to assign to drums and how
you want the software to deal with drum creation and deletion. You must specify one or all of the
reference cables and at least one pulling area to be able to proceed to the next step.
Include assigned cables Select this check box if you want to revamp your entire drum - cable
assignments. When you select this option, the software dissociates any cables that are already
assigned to drums, and then assigns all the cables. Clear the check box to assign only those
cables that are not already assigned to drums.
The wizard does not include any cable drums that allow multiple pulling areas.
Create new drums Select this check box to create new drums automatically for each cable
type if the drum - cable assignment results in all existing drums being used. The software creates
new drums using the defined naming conventions. If you clear this option, the software assigns
the cables to existing drums only and leaves the remaining cables unassigned until you create
new drums manually.
Delete empty drums Select this check box so that if reassignment of cables results in empty
drums, the software will delete those drums.
Reference cable Click the ellipsis button
to select a reference cable used to specify the
types of cables that you want to assign to drums automatically, or select the Select all reference
cables check box to specify all the cables of all types in the project.
Pulling area Select at least one pulling area to assign cables in all the pulling areas.
Moves the highlighted pulling area to the Selected pane.
Moves all the pulling area from to the Selected pane.
Use the buttons that show the opposite direction to move the selected pulling areas back to the All
pane.

SmartPlant Electrical User's Guide

621

Windows and Dialog Boxes

Select Cables (Assign Drums to Cables Wizard)


The displayed cables are those that meet the criteria that you selected on the Drum and Cable
Options wizard page. When you select a group of cables and click Next, the software orders the
cables by type (specified by the combination of cable category, cable specification, and cable
formation), cable length, and by pulling area. Then for each cable type per pulling area,
beginning with the longest cable, the software assigns the cables to the drums, beginning with the
drum that has the highest available capacity. The software continues to assign cables to the
drum provided the total cable length on the drum does not exceed the maximum drum capacity. If
assigning a particular cable to a drum would result a total cable length that is greater than the
maximum drum capacity, the software assigns that cable to the next available drum.

You can specify the order of the cables that have not been assigned yet and organize these
cables either in a descending or alternate order. You set the sorting method on the General
page in Options Manager. If you select the Descending method, the software sorts the cables
starting with the longest cable and then goes down to the shortest one. If you select the
Alternate method, the software starts with the longest cable, then with the shortest, then with
the second longest and then back to the shortest again, and so on.
If you need to add or modify data values for a particular cable, you can do so by selecting the
desired row and then clicking Common Properties. You can then edit the cable data as
needed.
You can define and customize pulling areas in the Data Dictionary Manager.
Select Select the check box beside each cable that you want to include in the automatic drum
assignment. You can only select a cable for assignment to a drum if a cable length and pulling
area are defined.
Cable Tag The identifying tag of the project cable.
Cable Category Displays the category that defines the purpose for which the cable is used:
Power, Instrumentation, Control, or Grounding.
Cable Specification Displays the family of reference cables to which the reference cable
associated with the project cable belongs.
Cable Formation Displays the cable formation (number and size of conductors) for the
reference cable.
Actual Length Displays the actual length of the cable, as calculated by the software.
Pulling Area Displays the pulling area assigned to the cable.
Select all Selects this check box to select all the available cables for inclusion in automatic
drum assignment, provided that the cable length and pulling area are defined. Clear to clear the
selection for all the cables.
Common Properties Opens the Cable Common Properties dialog box for the selected cable
to allow you to update the cable properties.

Drum - Cable Assignment Summary (Assign Drums to Cables


Wizard)
This page provides you with a summary of the drum - cable assignment for the cables you
selected on the Select Cables wizard page. The summary includes the actual length of cable
assigned to each drum, the cable drum to which each cable was assigned, and the total length of
cable assigned to the drum. If the software created a new drum, the row appears in bold
type. Bold gray text indicates drum - cable assignments that failed, and the reason for the failure
appears in the Comments column.

622

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Batch Cable Side and Gland Associations Dialog Box


Allows you to associate one or both sides of a group of non- power cables with a specific item such
as a cabinet. You can also assign glands of the same type to a group of cables belonging to any
category.

From
Describes information relating to the connection point for one side of the cable.
Tag Indicates the name of the item associated with this cable side. If you associate the From
cable side with a circuit that belongs to a PDB, the software displays the path of the circuit tag:
PDB/ bus/(cell)/ circuit.
Description Displays the description that is taken from the description of the tag associated
with the From side of the cable.
Dissociate existing connection Dissociates an item that already has an association with this
cable side.
Find Opens the Find dialog box, where you can select an appropriate item to associate.
Clear Clears the selection that appears in the Tag and Description boxes.
Gland Displays a gland associated with this cable side, if appropriate.
Dissociate gland Dissociates a gland that already has an association with this cable side.
Find Opens the Find dialog box, where you can select an appropriate cable gland that you
want to associate.
Clear Clears the selection that appears in the Gland box.

To
Describes information relating to the connection point for the opposite side of the cable to the
From side.
Tag Indicates the name of the item associated with this cable side. If the item that you
associate is connected to a PDB/Cell/Circuit, the software displays the association on the From
side.
Description Displays the description that is taken from the description of the tag associated
with the To side of the cable.
Dissociate existing connection Dissociates an item that already has an association with this
cable side.
Find Opens the Find dialog box, where you can select an appropriate item to associate.
Clear Clears the selection that appears in the Tag and Description boxes.
Gland Displays a gland associated with this cable side, if appropriate.
Dissociate gland Dissociates a gland that already has an association with this cable side.
Find Opens the Find dialog box, where you can select an appropriate cable gland that you
want to associate.
Clear Clears the selection that appears in the Gland box.
Cable Tag Displays the name of the cable. Select the check box beside the cable tag to select
the cable for associating with specified items and glands.
Description Displays the description for the cable, if defined.
Cable Category Displays the cable category: Control, Instrumentation, or Grounding.
Cable Specification Displays the cable specification, if defined.

SmartPlant Electrical User's Guide

623

Windows and Dialog Boxes


From Displays the item currently associated on the From cable side, if defined.
To Displays the item currently associated on the To cable side, if defined.
Speed up association Speeds up the association process.
If the software encounters a problem with one of the cables, the software cancels
the entire association process.

Batch Size Cables Window


Enables you to size cables in batch mode.
Data window Displays the cables that you selected in the Electrical Index, with details of the
cable tag, cable formation, input sizing data, and where applicable, sizing results. Beside each
cable name is a Select check box that allows you to select the cable for sizing.
Select all Allows you to select all the cables in the list for sizing.
OK Performs the sizing for the selected cables and close the dialog box.
Apply Sizing Performs the sizing for the selected cables.
Excel Report Displays the data in this dialog box in a Microsoft Excel file. This is useful if you
want to format the layout or print out the data.

Cable Common Properties Dialog Box


Enables you to set options for defining general cable properties, design details, connections, earth
loop impedance, and cable sizing data.
General Tab (see "General Tab (Cable Common Properties Dialog Box)" on page 625)
Design Data Tab (see "Design Data Tab (Cable Common Properties Dialog Box)" on page 628)
Connections Tab (see "Connections Tab (Cable Common Properties Dialog Box)" on page 632)
Sizing Data Tab (see "Sizing Data Tab (Cable Common Properties Dialog Box)" on page 633)
Earth Loop Impedance Tab (see "Earth Loop Impedance Tab (Cable Common Properties Dialog
Box)" on page 637)
Procurement Tab (see "Procurement Tab (Cable Common Properties Dialog Box)" on page 638)

624

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

General Tab (Cable Common Properties Dialog Box)


Sets options for general properties that identify and characterize the cable. An asterisk beside a
property name indicates required data.
In your project, you must create new cables based on existing reference cables.
Sizing required For power cables only, when creating a power cable, the software selects this
check box by default. Also, the software selects this check box if you change any cable property
that affects cable sizing. After clicking the Apply Sizing button, the software clears this check
box. For the list of cable and load properties that cause the automatic selection of this check box,
see Automatic Switch-On of the Sizing Required Flag (on page 153).
Cable tag Identifies the cable. The cable tag appears beside the cable in the Electrical
Index. You must enter a value that matches the naming convention for the cable. You define
naming conventions in the Options Manager.
Description Allows you to type a description of the cable, for information only. Note that for a
parallel cable assembly, you can edit the description of each cable independently.
Cable category Defines the purpose for which the cable is used. The cable category can be
power, control, grounding, or instrumentation. The software automatically assigns the cable
category according to the folder in which you create the cable, and you cannot change the value.
Cable specification Indicates the family of cables to which the reference cable belongs. You
must select a value for this property. When sizing a cable, the software searches only for those
reference cables that belong to the selected cable specification. You can define and customize
cable specifications in the Data Dictionary Manager.
Reference cable Defines the reference cable from which you create the new project cable in
the Electrical Index. The available reference items depend on the cable specification and
whether the Availability cable property is set to True. When you select a reference item, the
software completes all the properties of the cable automatically, and you cannot edit the
values. For a new power cable, the default value is Non- sized power cable, meaning that you
can enter values for the sizing data. You must select a value for the Reference cable property.
Cable usage If required, select a value for this property to further categorize the cable, for
example, for control voltage definitions, level definitions, and so forth. You can define and
customize cable usages in the Data Dictionary Manager.
Armor type Specifies the type of armor used to protect the cable from its environment. For
example, types of armor include non-armored, steel, or lead. This read-only value comes from
the reference cable used as the basis for this cable.
Outer jacket insulation Specifies the material used for the cable jacket. For example,
insulation materials include polyvinyl chloride (PVC) and polyethylene. This read-only value
comes from the reference cable used as the basis for this cable.
Notes Allows you to type user notes, for example if you want to provide additional information
regarding special features of the cable.
Insulation voltage rating Shows the voltage that corresponds to the manufacturer voltage
rating for the cable. This read-only value comes from the reference cable used as the basis for
this cable.
Insulation temperature rating Shows the temperature that corresponds to the manufacturer
rating of the maximum operating temperature for the cable. This read-only value comes from the
reference cable used as the basis for this cable.
Basic ampacity in air Shows the ampere capacity of the cable in air under the basic conditions
that the manufacturer specifies. The software uses this property in the sizing algorithm when you
select In Air as the value for the Cable routing property on the Sizing Data tab. This read-only
value comes from the reference cable used as the basis for this cable.

SmartPlant Electrical User's Guide

625

Windows and Dialog Boxes


Basic ampacity in ground Shows the ampere capacity of the cable in the ground under the
basic conditions that the manufacturer specifies. The software uses this property in the sizing
algorithm when you select Under Ground as the value for the Cable routing property on the
Sizing Data tab. This read-only value comes from the reference cable used as the basis for this
cable.
Custom basic ampacity Shows the custom ampere capacity of the cable under basic
conditions when the sizing of a cable was done using a custom cable routing method which is not
InAir or UnderGround. The software calculates this property based on a corresponding lookup
table which you specify in the Options Manager General Settings window. The software uses the
custom basic ampacity value to size the current cable only after selecting a custom cable routing
method from the Routing list on the Sizing Data tab of this dialog box. For more details, see
Define Custom Basic Ampacity for Cable Sizing (on page 148).
Reactance per unit length Shows the value of reactance per unit length that matches the
manufacturer specification. Reactance per unit length applies only to cables that carry
alternating current (AC). The software uses this property in the sizing algorithm. This read-only
value comes from the reference cable used as the basis for this cable.
Resistance per unit length Shows the value of resistance per unit length that matches the
manufacturer specification. The software uses this property in the sizing algorithm. This
read-only value comes from the reference cable used as the basis for this cable.

Construction
Describes the physical characteristics related to the construction of the cable. All the properties
in this section except for the Conductor arrangement and Color pattern properties are
read-only. The available values depend on the conductor arrangement that you select.
Conductor arrangement Defines the number and arrangement of the conductors in the cable
(not applicable for instrumentation cables). Your selection filters the list of available reference
cables to display only those cables that match the cable formation that you have selected. When
sizing a power cable, the software searches only for those reference cables that have the selected
conductor arrangement. The following standard options are available:
Single core cable Creates a current-carrying cable with a single core. For this option,
you can specify an arrangement of any number of single-core conductors, for example, 3
single-core cables, but you cannot specify any additional conductors.
2-core cable Creates a cable with two current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
2+1-core cable Creates a cable with two current-carrying conductors and one
additional conductor. You cannot modify the cable construction for this option.
3-core cable Creates a cable with three current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
3+1-core cable Creates a cable with three current-carrying conductors and one
additional conductor. You cannot modify the cable construction for this option.
3+2-core cable Creates a cable with three current-carrying conductors and two
additional conductors. You cannot modify the cable construction for this option.
Multicore cable Creates a cable with multiple conductors. For this option, you can
specify any number of conductors and additional conductors.
You can change the names of the standard conductor arrangement items in the Data
Dictionary Manager. However, the software performs calculations according to the position
in the list of the item that you select. For example, a 2-core cable is always the second item in
the list.

626

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Set type For instrumentation cables only, allows you to select a standard value that represents
the arrangement of the wires in the set, such as Wire, Pair, Pair w/Shield, Triad, Triad w/Shield,
and so forth. You can select values of this property for a new cable only; you cannot select a
different value for an existing or duplicated cable.
The value Other is available for future use. If you do not want this value to appear in
the list, make it invisible in the Data Dictionary Manager.
Cable formation Displays computed information based on the total number and the size of the
conductors or cable sets specified. The size appears as a question mark when the reference
cable type is Non-sized power cable or when you have not sized a power cable.
Current-carrying conductors Specifies the number of conductors within the cable used for
carrying the current, excluding the neutral, the ground, or additional conductors (not applicable for
instrumentation cables). If you selected Single-core or Multicore as the conductor
arrangement, this option allows you to specify the number of conductors that carry the electric
current.
Number of sets For instrumentation cables only, allows you to type the number of cable sets
that the cable contains. Click the ellipsis button
to open the Cable Set Properties dialog box
(on page 641) where you can modify the set definitions if required.
Size Displays the standard size for the current-carrying conductors or cable sets.
Material Specifies the conductor material used for the current-carrying conductors or cable
sets. This read-only value comes from the reference cable used as the basis for this cable. For
power cables, the software uses this property in conjunction with the Conductor Material
Coefficients lookup table for performing short circuit cable sizing.
Insulation Specifies the material used for insulating the current-carrying conductors or cable
sets. For example, insulation materials include polyvinyl chloride (PVC) and polyethylene. This
read-only value comes from the reference cable used as the basis for this cable. For power
cables, the software uses this property in conjunction with the Conductor Insulation
Temperatures lookup table for performing short circuit cable sizing.
Additional conductors Depending on the selected conductor arrangement, this property
specifies the number of additional non-current-carrying conductors, such as ground wires (not
applicable for instrumentation cables).
Overall shield For instrumentation cables only, select to specify an overall shield for the
cable. When you select this option, you need to specify the size and material of the overall shield.
Size Displays the standard size for the additional conductors or overall shield.
Material For instrumentation cables only, allows you to select the material used for an overall
shield. You can define and customize the available materials in the Data Dictionary Manager.
Communication wire For instrumentation cables only, select to specify a communication wire
for the cable.
Color pattern Select a color pattern for the cable from one of the patterns available. Click the
ellipsis button
to define or modify a color pattern.
Use for neutral grounding For grounding cables only, select this option to make the cable
available for selection as a grounding cable on the Transformer Connections and Tapping
dialog box.

SmartPlant Electrical User's Guide

627

Windows and Dialog Boxes


Parallel cables
Describes the number of cables in parallel and the list of cable names. The software calculates
these values based on the result of a cable sizing operation or you can specify the number of
parallel cables manually in order to create a parallel cable assembly.
When defining naming conventions for parallel cables, you can determine where
in the cable tag name you want to include the parallel cable suffix. In Options Manager, on the
Define Naming Conventions dialog box (Options > Naming Conventions > Define),
define the parallel cable suffix in the Segment definitions section. You can move the parallel
cable suffix property up or down the list to set the position of this property in the segment
definition. If you do not select this check box, the suffix for the parallel cables will appear at the
end of the cable tag name.
Total number Specifies the number of parallel cables where the current cable is part of a cable
assembly that shares the load current and constitutes an inseparable group. When you perform
and apply cable sizing where the recommended number of parallel cables shown on the Sizing
Data tab exceeds the value in this box, the software copies the calculated value to this box after
you click Apply. You can also select the number of parallel cables manually without performing
sizing. To specify a single cable, select the blank value. In the Options Manager, you can
specify the minimum conductor size and the maximum number of parallel cables allowed.
List Allows you to select any cable from the list to view its common properties. The name of the
cable in the Cable tag box changes accordingly. If you change a property of a parallel cable, this
change affects all the parallel cables in the list. The only property that does not affect the other
parallel cables is Description.
When generating parallel cables, either through cable sizing or when you increase the
total number of parallel cables, the software creates the additional cables based on the
original cable name and adds a suffix. In Options Manager, you can specify whether to use a
numeric or alphanumeric suffix by default; you can overwrite the default suffix for each parallel
cable by typing a value for the Parallel Cable Suffix property in the Properties
window. Note that if you rename a parallel cable in an assembly, the software does not
update the Parallel Cable Suffix property for that cable. These cables behave as individual
cables, so that if you delete one of the cables, the software leaves the other cables
intact. However, if you change a parameter for one of the cables, the software updates the
same parameter for all the cables. You can

Command Buttons
Compare to Reference Click to open the Compare Project and Reference Cable Data dialog
box (on page 643), from which you can compare reference cable properties that have changed
since the creation of the project cable. From this dialog box, you can also copy the updated
reference data to the project cable if required.

Design Data Tab (Cable Common Properties Dialog Box)


Provides information about the cable drum assignment, routing, length, and so forth. An asterisk
beside a property name indicates required data.

Drum assignment
Allows you to assign the current cable to a cable drum and lock the drum to the current cable if
needed.

628

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Drum Displays the name of the cable drum to which you assigned the current cable. The drum
name appears after you select it in the Find dialog box. Note that this box is available only if the
length of the current cable does not exceed the maximum cable drum capacity.
Lock to drum Locks the current cable to the cable drum specified under Drum. Note that
locking a cable to a drum makes it impossible to dissociate this cable from the assigned drum or
change the assignment to another cable drum. You can unlock the drum from the current cable by
clearing the Lock to drum check box here or on the Cable Drum Common Properties dialog
box.
When using the Assign Drums to Cables wizard, the software optimizes the
assignment of cables to drums. The optimization mechanism disregards all the cables that
either have been locked to drums or already have been installed. Installed and locked cables
are, therefore, fixed on those drums. When calculating the Total cable length left on drum
value, the optimization mechanism subtracts the length of the locked and installed cables
from the maximum drum capacity. For details about the optimization process, see
Optimization of Cable Drum Assignment (on page 178).
Find Opens the Find dialog box, where you can select a cable drum to which you assign the
current cable. Note that the software finds only those cable drums that have been associated with
the same reference cable and pulling area as the current cable.
Unassign Cancels the assignment of the current cable to the cable drum displayed under
Drum. Note that the software does not allow this action if the current cable is locked to the
assigned cable drum.
Number of splices Displays the number of cable splices that the software created when you
assigned the current cable to a drum. Note that this box is available only if the length of the
current cable exceeds the maximum cable drum capacity.
View When the software shows the number of cable splices, allows you to open the Cable
Cuts dialog box where you can see the cable cuts and their lengths according the assigned
drums.
Pulling area Allows you to select a pulling area to use when routing the cable from the selected
drum. You can define and customize pulling areas in the Data Dictionary Manager.

Cable routing
In this group box, you build the routing path for the cable that you are editing.
Select predefined route When you click Find, allows you to select a predefined route to use
as a basis for the cable routing definition.
Copy route from cable When you click Find, allows you to select routing from another cable to
use as a basis for the cable routing definition.
Segregation level You must select a segregation level for the cable if you want to perform
routing. The segregation level of the cable must match the segregation level of all the cableway
segments to which you assign the cable. Note that once you have added at least one segment to
the routing, you cannot change the segregation level; to do so, you must first remove all the
segments.
Find Opens the Find dialog box, from which you can select as predefined route or a cable with
routing for copying, according to the option you have selected. Note that only routes or cables
that belong to the current segregation level are available for selection.
Save as new route Allows you to save the current routing definition as a new predefined route.

Route details
Displays the cableways and segments that make up the routing. Note that only those segments
that belong to the current segregation level are available for selection.

SmartPlant Electrical User's Guide

629

Windows and Dialog Boxes


Sequence Indicates the sequence of the segment in the routing path.
Cableway Select the cableway from which you want to select a segment.
Segment Select the segment through which you want to route the cables. You can use each
segment only once in a route.
Length Displays the segment length for the selected segment. You define this value in the
Properties window.
Segment fill Displays the percentage of the segment filled by cables.
Add Adds an empty row below the currently selected row.
Insert Adds an empty row above the currently selected row.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Remove Removes the currently selected segment from the route.

Design data
Provides information about the physical characteristics of the cable.
Note that for parallel cables, when you change estimated cable length or design cable length, the
software automatically changes the values for all of the other parallel cables.
Changing a value that affects the Actual design/installed length of the current
cable and if this Actual design/installed length value has already been used to size the cable,
the software automatically recalculates the voltage drop. If the new Actual design/installed
length exceeds the sizing parameters of the current cable, you will need to resize the cable by
clicking the Perform Sizing button on the Sizing Data tab. The software displays an appropriate
message to this effect in the Calculation information box on the Sizing Data tab and turns on
the Sizing required flag on the General tab of the Cable Common Properties dialog box.
Use external routing length Instructs the software to overwrite the Actual design/installed
length value with the existing External routing length value. If you select this check box, and
the External routing length property does not have a value, the software uses a value of zero in
calculations. If you clear this check box, the software uses the value of one of the following
properties: Estimated length, Design length, or Routing length.
Estimated length Allows you to enter the estimated length of cable before installation with
appropriate units of measure. In sizing calculations, the software uses this value if you do not
specify a design length. You can specify the default project units of measure in the Data
Dictionary Manager.
Design length Allows you to enter a more accurate length for the cable after installation with
appropriate units of measure. In sizing calculations, this value overrides the estimated
length. You can specify the default project units of measure in the Data Dictionary Manager.
Routing length If you added routing information, displays the total length of the segments that
you defined.
External routing length If you retrieved routing information from SmartPlant 3D, the software
can use the routing length obtained with the retrieved data, provided that you select the Use
external routing length check box.
External routing path Displays the external routing path taken from SmartPlant 3D, provided
that you select the Use external routing length check box. To view the full path click the ellipsis
button
.
Tail 1 Allows you to type a value for the spare tail length at one end the cable, if you require.

630

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Length A calculated field that displays the design length, or if not available, the estimated
length.
Tail 2 Allows you to type a value for the spare tail length at the other end the cable, if you
require.
Spare length Allows you to type a value for additional spare cable length, if you require.
Actual design/installed length The actual length of the cable, calculated from the sum of tail
length 1, the main length of the cable (routing length, design length or estimated length), tail length
2, and the spare length. The software uses this value to calculate cable sizing and optimize cable
drums.
The software overwrites the calculated Actual design/installed length value in the
following cases:
After selecting the Use external routing length check box, the Actual design/installed
length value is overwritten with the existing External routing length value.
After selecting the Cable installed check box, the Actual design/installed length value
is overwritten with the Installed length value.
When replacing the Actual design/installed length value, the Installed length property
overrides the External routing length property.

Installed data
Allows you to enter data so that the software can take into account the actual installed data of the
current cable. The software calculates the installed length based on the values that you enter for
Marked length side 1 and Marked length side 2 fields.
Marked length side 1 Allows you to type a value for the marked length on side 1 of the
cable. This is a marking that the vendor usually marks at standard fixed metered intervals along
the entire length of the cable.
Marked length side 2 Allows you to type a value for the marked length on side 2 of the
cable. This is a marking that the vendor usually marks at standard fixed metered intervals along
the entire length of the cable.
Installed length A calculated field that displays the actual installed length of the cable. The
software calculates this value if you enter both Marked length side 1 and Marked length
side 2 values. The result is the absolute delta between the Marked length side 1 and
Marked length side 2 values. If you do not enter both Marked length side 1 and
Marked length side 2 values, you can type in the installed value yourself.
Cable installed Allows you to define the cable as installed in the field. Once you select this
check box, the software overwrites the value under Actual design/installed length with the
Installed length value. The software uses the Actual design/installed length value to calculate
cable sizing and optimize cable drums.

Command Button
Compare to Reference Opens the Compare Project and Reference Cable Data dialog box (on
page 643), from which you can compare reference cable properties that have changed since the
creation of the project cable. From this dialog box, you can also copy the updated reference data
to the project cable if required.

SmartPlant Electrical User's Guide

631

Windows and Dialog Boxes

Connections Tab (Cable Common Properties Dialog Box)


From
Describes information relating to the connection point for one side of the cable. For a power
cable, this property indicates the cable side that is closer to the power source.
The software does not allow you to make parallel connections or change existing
parallel connections of cables on the Cable Common Properties dialog box. Parallel cable
connections or changes of parallel associations can be carried out only in cable block diagrams.
Tag Indicates the name of the item associated with this cable side. If you associate the From
cable side with a circuit that belongs to a PDB, the software displays the path of the circuit tag:
PDB/ bus/(cell)/ circuit.
Description Displays the description that is taken from the description of the tag associated
with the From side of the cable and is read-only.
Find Opens the Find dialog box, where you can select an appropriate item to associate. (Not
available if one of the ends of the current cable is connected in parallel.)
Dissociate Dissociates an item that already has an association with this cable side.

If you make electrical associations in the Electrical Engineer or on the Feeder Data tab of the
Electrical Motor Common Properties dialog box, the software populates the Tag property
on the From cable side with the appropriate data.
If you associate a power cable with a load that you previously associated with a circuit, the
software inserts the cable between the circuit and the load and populates the Tag property
with the circuit data.
Once you have made an association for a power cable, all further changes, including
dissociation, must be made in the Electrical Engineer.
Gland Displays a gland associated with this cable side, if appropriate.
Find Opens the Find dialog box, where you can select an appropriate cable gland to associate.
Dissociate Dissociates a gland that already has an association with this cable side.

To
Describes information relating to the connection point for the opposite side of the cable to the
From side. For a power cable, this property indicates the cable side that is closer to a consumer.
The software does not allow you to make parallel connections or change existing
parallel connections of cables on the Cable Common Properties dialog box. Parallel cable
connections or changes of parallel associations can be carried out only in cable block diagrams.
Tag Indicates the name of the item associated with this cable side. For a power cable, if you
associate the To cable side with a load, the software uses data from the load to populate some of
the properties on the Sizing Data tab; if the load is connected to a PDB/Cell/Circuit, the software
displays the association on the From side.
Description Displays the description that is taken from the description of the tag associated
with the To side of the cable and is read-only.
Find Opens the Find dialog box, where you can select an appropriate item to associate. (Not
available if one of the ends of the current cable is connected in parallel.)

632

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Dissociate Dissociates an item that already has an association with this cable side.

If you associate a power cable with a motor by applying a profile, the software populates the
To property with the motor tag.
Once you have made an association for a power cable, all further changes, including
dissociation, must be made in the Electrical Engineer.
Gland Displays a gland associated with this cable side, if appropriate.
Find Opens the Find dialog box, where you can select an appropriate cable gland to associate.
Dissociate Dissociates a gland that already has an association with this cable side.

Sizing Data Tab (Cable Common Properties Dialog Box)


Provides information about the electrical load for a power cable. The software uses this
information as input values for cable sizing. When the cable has a connected load, the software
copies the electrical parameters of the load to the cable. You can change the values of these
parameters used for cable sizing if required. An asterisk beside a property name indicates
required data for sizing.
Supply Select the type of supply: alternating current (AC) or direct current (DC). If the cable is
connected to a load for which you select the Consumer check box on the General tab of the
appropriate load Common Properties dialog box, the software copies the value from the load to
this box.
The software performs sizing using different voltage drop formulas for AC and DC supplies.
Rated voltage Select the appropriate operating voltage for the cable. If the cable is connected
to a load for which you select the Consumer check box, the software uses the value from the load.
The software automatically recalculates the voltage drop after you change this value for a cable
that has already been sized. If the value you enter exceeds the sizing parameters of the current
cable, you will need to resize the cable by clicking the Perform Sizing button on this tab. The
software displays an appropriate message to this effect in the Calculation information box on
this tab and turns on the Sizing required flag on the General tab of the Cable Common
Properties dialog box.
Number of phases Select the number of phases in the power supply to the load: 1, 2, or 3. If
the cable is connected to a load for which you select the Consumer check box, the software uses
the value from the load. This property applies for an AC supply only.

The software performs sizing for 1- and 3-phase supplies only, using a different voltage drop
formula for each option.
The software automatically recalculates the voltage drop after you change this value for a
cable that has already been sized. If the value you enter exceeds the sizing parameters of
the current cable, you will need to resize the cable by clicking the Perform Sizing button on
this tab. The software displays an appropriate message to this effect in the Calculation
information box on this tab and turns on the Sizing required flag on the General tab of the
Cable Common Properties dialog box.

SmartPlant Electrical User's Guide

633

Windows and Dialog Boxes


Full load current (FLA) Enter the electrical current, in mA, A, or kA, that the cable must supply
without causing damage to the insulation. The software uses the value of the full load current to
perform sizing involving the thermal calculation. If the cable is connected to a load for which you
select the Consumer check box, the software copies the value from the load to this box. The
software automatically recalculates the voltage drop after you change this value for a cable that
has already been sized. If the value you enter exceeds the sizing parameters of the current
cable, you will need to resize the cable by clicking the Perform Sizing button on this tab. The
software displays an appropriate message to this effect in the Calculation information box on
this tab and turns on the Sizing required flag on the General tab of the Cable Common
Properties dialog box.
Starting current If a motor is connected to the cable, the software enters the value of the
locked rotor current (LRC). For a motor, the starting current value can typically be 400 - 600%
larger than the full load current, and is therefore important when evaluating the current
requirements used to perform sizing. Note that this option is available for all power cables
whether they are connected to motors or not. The software automatically recalculates the
voltage drop after you change this value for a cable that has already been sized. If the value you
enter exceeds the sizing parameters of the current cable, you will need to resize the cable by
clicking the Perform Sizing button on this tab. The software displays an appropriate message to
this effect in the Calculation information box on this tab and turns on the Sizing required flag on
the General tab of the Cable Common Properties dialog box.
Use code factor You can specify whether to use an FLA multiplier factor for thermal ampacity
calculations. The code factor affects the units of various quantities such as the cable size and the
sizing calculation. The standard options defined in the Data Dictionary Manager are:
Yes The software multiplies the full load current by a factor set by the user in the Code
Factor field. If yes is selected and no value entered in the Code Factor field then the
software uses a factor of 1.
No The software does not multiply the full load current.
The selection for this option also determines the available values of conductor size, frequency,
and rated voltage.
Code Factor Allows you to type the value for the FLA multiplier. The code factor value is used
to multiply the FLA which is used to calculate the required thermal ampacity, if no value is entered
then the software uses a factor of 1. This field is only available when Use Code Factor is set to
Yes.
Power factor at full load Allows you to enter the power factor of the equipment that the cable
feeds under normal full load running conditions. The power factor is the ratio of active power to
apparent power, and can have a value between 0 and 1. If the cable is connected to a load for
which you select the Consumer check box, the software uses the value from the load. The
software automatically recalculates the voltage drop after you change this value for a cable that
has already been sized. If the value you enter exceeds the sizing parameters of the current
cable, you will need to resize the cable by clicking the Perform Sizing button on this tab. The
software displays an appropriate message to this effect in the Calculation information box on
this tab and turns on the Sizing required flag on the General tab of the Cable Common
Properties dialog box.
Power factor at starting Allows you to enter the power factor of the equipment that the cable
feeds under starting conditions. If the cable is connected to a motor for which you select the
Consumer check box, the software uses the value from the motor. This property is not available
for loads other than motors. The software automatically recalculates the voltage drop after you
change this value for a cable that has already been sized. If the value you enter exceeds the
sizing parameters of the current cable, you will need to resize the cable by clicking the Perform
Sizing button on this tab. The software displays an appropriate message to this effect in the

634

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Calculation information box on this tab and turns on the Sizing required flag on the General
tab of the Cable Common Properties dialog box.
Routing Allows you to select an appropriate routing type for the current cable: InAir,
UnderGround, or some other custom routing type that you define. The option that you select
affects whether the software uses the ampacity value in air, in the ground, or custom basic
ampacity when sizing a cable.
Auto-restart Select this option to indicate whether a motor connected to the cable restarts
automatically or manually after a power outage. This property is not available for loads other than
motors.

Derating factors
The basic ampacity of the cable applies to standard conditions that the manufacturer
specifies. Under actual operating conditions, such as a higher environmental temperature, or a
location where several cables are routed close to one another, the ampacity changes. The
derating and utilization factors take into account the operating conditions of the cable.
Derating factor Allows you to enter a value for the derating factor, which the software uses to
calculate the cable derated ampacity under actual operating conditions. The software multiplies
the basic ampacity by the derating factor to obtain the derated ampacity. A value of less than 1
means that the derated ampacity is lower than the basic ampacity, and this will result in a
requirement for a larger size cable.
Utilization factor Enter a value between 0 and 1 to represent an additional factor that derates
the cable ampacity. If you do not need to use this property, set the value to 1. The software
multiplies the basic ampacity by this factor to obtain the derated ampacity.
Ambient temp. factor Enter a value between 0 and 2 to represent a temperature factor that
affects the derated cable ampacity. For the software to apply this factor to the calculation, in the
Options Manager, you must first set the value of the Apply Temperature Correction Factor to
Cable Sizing property to Yes; setting the value of the property to No is the equivalent of using a
value of 1 for the temperature factor.
If you change any of the derating factors for a sized cable, the software automatically
selects the Sizing required check box on the General tab.

Voltage drop (%)


The cable needs to supply electrical current at a voltage that is no more than a few percentage
points below the rated voltage. The voltage drop is expressed as a percentage of the rated
voltage. The software compares the allowable and calculated voltage drop at running and
starting, and uses the result to specify the smallest cable that meets the maximum voltage drop
requirements.
Allowable at full load Enter your maximum percentage voltage drop allowed when the
connected load is running under normal full load conditions.

The allowable voltage drop must have a value greater than zero. To ignore the voltage drop
in the sizing calculation, type a value of 100.
The software automatically recalculates the voltage drop after you change this value for a
cable that has already been sized. If the value you enter exceeds the sizing parameters of
the current cable, you will need to resize the cable by clicking the Perform Sizing button on
this tab. The software displays an appropriate message to this effect in the Calculation
information box on this tab and turns on the Sizing required flag on the General tab of the
Cable Common Properties dialog box.

SmartPlant Electrical User's Guide

635

Windows and Dialog Boxes


Calculated Displays a calculated value of the percentage voltage drop when the load is
running under normal operating conditions, using the estimated or design length of the cable.
Allowable at starting Enter your maximum percentage voltage drop allowed when starting the
equipment. This property is not available for loads other than motors.

The allowable voltage drop must have a value greater than zero. To ignore the voltage drop
in the sizing calculation, type a value of 100.
The software automatically recalculates the voltage drop after you change this value for a
cable that has already been sized. If the value you enter exceeds the sizing parameters of
the current cable, you will need to resize the cable by clicking the Perform Sizing button on
this tab. The software displays an appropriate message to this effect in the Calculation
information box on this tab and turns on the Sizing required flag on the General tab of the
Cable Common Properties dialog box.
Calculated Displays a calculated value of the percentage voltage drop when starting the load,
using the estimated or design length of the cable. This property applies to motors only.

Short circuit
If you want to include short circuit calculations in the cable sizing, you enter values for the
properties in this section. The software uses this data along with the coefficients that are found in
the Conductor Material Coefficients and Conductor Insulation Temperatures lookup tables
to calculate the minimum required conductor cross-section area. Suitable values must be
available in these tables for the software to be able to perform the calculation.
Use short circuit cable sizing Select to enable and activate the short circuit properties and
algorithm when you want the cable sizing to include short circuit calculations.
Duration Allows you to type the maximum time for which the cable is expected to withstand a
fault short circuit current until a protection device interrupts the current flow in the circuit.
Fault current Allows you to type the maximum short circuit fault current that can flow through
the cable, and for which the cable needs to be sized.
Required area (cmils) Displays the calculated minimum conductor cross-section area
required for the cable to meet the short circuit criteria that you specify.

Protection setting
Allows you to specify cable sizing based on the rated current for a protection device such as a fuse
or circuit breaker, rather than using the load current.
Include protection device Select to specify the rated current of the protection device for use in
sizing calculations. Clear to use the load current value.
Protection settings Allows you to type the rated current of the protection device for use in
sizing the cable. The software automatically recalculates the voltage drop after you change this
value for a cable that has already been sized. If the value you enter exceeds the sizing
parameters of the current cable, you will need to resize the cable by clicking the Perform Sizing
button on this tab. The software displays an appropriate message to this effect in the Calculation
information box on this tab and turns on the Sizing required flag on the General tab of the
Cable Common Properties dialog box.

Sizing results
Shows the outcome of the calculations based on the load data that you supply for the cable. All
the information is read- only.
If the cable is connected to a load for which you select the Consumer check box, the
software uses the electrical values of the load to size the cable.

636

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Recommended cross section Displays the recommended cross section of the
current-carrying conductors for the load requirement.
Derated cable ampacity Displays the calculated cable ampacity under actual operating
conditions. The software calculates the derated ampacity by multiplying the basic ampacity by
the derating factor and the utilization factor.
Number of parallel cables Indicates the recommended number of parallel cables required
when no single reference cable meets the minimum cable sizing requirements. The software
creates parallel cables as a result of the sizing. The cables are handled as an inseparable group,
and any action that you perform on one of the cables causes all the cables in that group to follow
that operation.
Maximum cable length Indicates the maximum allowed length of cable of the recommended
cross-section that meets the current sizing requirements.
Calculation information Displays messages related to verification of the sizing calculation
such as missing data or indicating a cable-load association. Also displays a message if the
current cable needs to be resized.
The software displays the message Not found when no suitable reference cable matches
the sizing results under the following conditions: when no reference cable exists corresponding to
the cable specification or arrangement, when there are missing values for ampacity, resistance, or
reactance, or when the number of parallel cables exceeds the limit specified in Options Manager
by the Maximum Number of Parallel Cables property.
System notes Displays messages related to performed actions such as connecting a load,
sizing, and so forth.
Refresh Load Data Updates any information derived from a load connected to the cable. This
button is available when the load data changes since the previous time of sizing of the cable or
when you perform cable sizing for the first time.
Perform Sizing Performs the sizing calculation using the input data and recommends the most
suitable reference cable based on your selected cable specification and formation.
Apply Sizing Copies data to the cable from the reference cable the software recommends as a
result of the cable sizing.

Earth Loop Impedance Tab (Cable Common Properties Dialog


Box)
This tab appears for project power cables only. You can specify parameters for cable grounding
using the cable armor or using a separate grounding cable, as well as external impedance, and
the software can calculate the total earth loop impedance for the cable.
Earth loop impedance calculation required Select this option when you want to calculate the
earth loop impedance for this particular line. After you click Calculate, the software clears this
check box.

Cable impedance path


Allows you to specify the grounding path used for the cable using the cable armor or via a
separate grounding cable, if available.
Use cable armor When you select this option, the software uses the cable armor as the return
path for grounding with the values that you specify for the armor resistance and reactance to
calculate the earth loop impedance.
Armor impedance per unit length Displays the overall armor impedance per unit length,
which the software calculates from the Armor Reactance and Armor Resistivity properties as
specified in the Properties window.

SmartPlant Electrical User's Guide

637

Windows and Dialog Boxes


Actual cable length The value of the Actual length property that the software calculates on
the Design Data tab.
Total armor impedance The total cable armor impedance, calculated as the product of the
armor impedance per unit length and the actual cable length.
Use separate grounding cable When you select this option, the software uses a grounding
cable that is associated with the load as the return path for grounding with the values that you
specify for the grounding cable resistance and reactance to calculate the earth loop
impedance. Note that this option is only available if a grounding cable is already associated with
the load on the To side of the power cable.
Tag The item tag of the grounding cable associated with the load on the To side of the power
cable.
Cable formation Displays the cable formation of the grounding cable as specified in the cable
common properties.
Cable impedance per unit length Displays the overall grounding impedance per unit length,
comprised of the Reactance per unit length and Resistivity per unit length properties which
are specified for the grounding cable.
Actual cable length The value of the Actual length property for the grounding cable.
Total grounding cable impedance The grounding cable impedance, calculated as the
product of the cable impedance per unit length and the actual cable length.
External loop impedance Allows you to type a value for any additional impedance associated
with the power source.
Total earth loop impedance The total impedance, calculated as the sum of the grounding
path impedance, external loop impedance, and impedance of the cable carrying the current.
Calculate Click to update the calculation of the total earth loop impedance.
System notes Displays messages related to earth loop impedance calculations.

Procurement Tab (Cable Common Properties Dialog Box)


Enables you to enter information related to ordering a specific cable for your inventory.
Manufacturer Allows you to select a manufacturer. You can define and customize
manufacturers in the Data Dictionary Manager.
Model Allows you to select a cable model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Stores part number Allows you to enter a reference number for the cable in your
inventory. This read-only value comes from the reference cable used as the basis for this cable.

638

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Cable Drum Common Properties Dialog Box


Allows you to define and edit basic cable drum properties, and to assign project cables to the
current cable drum. An asterisk beside a property name indicates required data.
Drum tag Identifies the cable drum. The drum tag appears beside the cable drum in the
Electrical Index.
Procurement status Allows you to set a procurement status for the current cable. The
following statuses are available:
In bids Puts no restrictions on the current drum or the cable that is assigned to this
drum.
Ordered Instructs the software to do the following:
You cannot delete the current drum.
You can no longer change the Total cable length to order/delivered value. This
value becomes unavailable for editing.
It is possible to reassign this drum to another cable or add another cable to this drum
as long as the Total cable length to order has not been exceeded.
Delivered Defines the drum as delivered to the construction site. Prevents you from
editing the Total cable length to order/delivered value.
Spare drum Allows you to define the current drum as spare. Defining a cable drum as spare
entails the following:
The cable drum becomes reserved and the software does not assign it to any cable.
You cannot delete a spare cable drum.
You cannot modify the Total cable length to order value.
You cannot define a drum as spare if it is assigned to a cable. You have to cancel all the
cable assignment by clicking Remove in the Assigned cables group box.
Description Allows you to type a description of the cable drum, for information only.
Reference cable Displays the reference cable that you selected for the current cable
drum. You must select a reference cable for the drum. To set a reference cable or to select a
different one, click
to open the Select Reference Cable dialog box (on page 650). Note that
you can only select a different reference cable if the drum has no assigned cables.
You can change the drum capacity of a drum even if the drum is assigned to a cable.
This way you can implement new drum capacities supplied by vendors. You can edit the
properties of the associated reference cable and add or change the drum capacity values
for that reference cable. Once you have added new Minimum and Maximum values or
changed the existing Minimum and Maximum values of the associated reference cable,
Click
to open the Select Reference Cable dialog box and then click Select to set a
different drum capacity for a drum regardless of whether the drum has or has not been
assigned to a cable.
Pulling area Allows you to select a single cable pulling area to which you assign the
drum. Once you define an appropriate reference cable and select a pulling area, after clicking Add
in the Assigned cables data window below, the software can find only those cables that are
associated with the currently selected pulling area. If you want to assign cables that belong to
multiple pulling areas, select the Allow multiple pulling areas check box, which makes the
Pulling area list unavailable. Also note that you can only select another pulling area if the drum
has no assigned cables. You can define and customize pulling areas in the Data Dictionary
Manager.

SmartPlant Electrical User's Guide

639

Windows and Dialog Boxes


Minimum cable length to order Displays the minimum length of cable when ordering from the
supplier. The software enters this value automatically after you select an appropriate reference
cable. This value is taken from the Design Data tab of the Reference Cable Common
Properties dialog box.
Maximum drum capacity Displays the maximum total cable length that this drum can hold,
including any spare cable. The software enters this value automatically after you select an
appropriate reference cable. This value is taken from the Design Data tab of the Reference
Cable Common Properties dialog box. The software validates the total cable length on the drum
against this value.
Total cable length to order/delivered Allows you to specify the length of cable to order from a
supplier for future assignment. This value must lie between the minimum cable length to order and
the maximum drum capacity and cannot be less than the total cable length on the drum. Note
that this value becomes unavailable for editing after changing the procurement status to Ordered.
Once the procurement status is set to Ordered, the software takes into account the Total cable
length to order/delivered value in all relevant calculations.
Total actual length assigned (planned) Displays the sum of the actual planned length values
of all the assigned cables.
Spare percentage on drum Allows you to specify a spare percentage for the current drum.
This value is used by the software to calculate a spare cable length factor, for example, to make
allowance for cutting errors. For example, if you want a drum spare factor of 5%, type 5. For
calculation details, see Rules Governing Cable Drum Calculations (on page 181).
Scrap cable length Displays the scrap cable length value that is used by the software to
calculate the Total cable length on drum value. You can define the cable scrap length only for
reference cables. This value will be used by the software only for drum calculation purposes and
will not be added to the actual cable length of the project cables.
Total cable length on drum (planned) Displays the total planned length of the assigned
cables on the current drum. The software calculates this value by adding up the Total actual
length assigned (planned), Spare percentage on drum, and Scrap cable length values of the
current drum. You can assign more cables to this drum so long as this value does not exceed the
value of the Maximum drum capacity property.
Total cable length left on drum Displays the remaining total length of the cables on the
current drum after the cables have been installed. The software calculates this value by
subtracting the total length of the installed cables from the Total cable length to order/delivered
value.

Assigned cables
Displays the cables assigned to the current cable drum. Note that you can only assign cables
after you have selected a reference cable and a pulling area.
Locked Allows you to lock a cable to the current drum. Note that locking a cable to a drum
makes it impossible to unassign this cable from the assigned drum or change the assignment to
another cable drum. You can unlock the drum from the current cable by clearing the Locked
check box here or clear the Lock to drum check box on the Design Tab of the Cable Common
Properties dialog box.
When using the Assign Drums to Cables wizard, the software optimizes the
assignment of cables to drums. The optimization mechanism disregards all the cables that
either have been locked to drums or already have been installed. Installed and locked cables
are, therefore, fixed on those drums. When calculating the Total cable length left on drum
value, the optimization mechanism subtracts the length of the locked and installed cables
from the maximum drum capacity. For details about the optimization process, see
Optimization of Cable Drum Assignment (on page 178).

640

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Tag name Identifies the cable. The tag name appears beside the cable in the Electrical
Index.
Installation Status Displays whether the cable is installed in the field or not. If the cable is
installed, the software takes its Actual Length value to calculate the Total cable length left on
drum value.
Formation Describes cable structure in terms of the number of conductors, and where
appropriate, additional conductors with their sizes. For example, 3 x 2.5 mm2 + 2 x 1.0
n
2
mm2 described a cable with three 2.5 mm2 main co ductors and two 2.5 mm additional
conductors.
Actual Length A derived value for cable length. If in the Cable Common Properties dialog
box a cable has a value for Estimated length, but no value for Design length, then the estimated
length is the value for Actual Length. If there is a value for Design length, then this is also the
value for Actual Length.
Add Opens the Find dialog box, where you search for available cables to assign to the current
cable drum. The available cables are those that belong to the same reference cable and pulling
areas that you specify for the cable drum. This option is available only after you enter the required
data and only if the current drum is not defined as spare.
Remove Removes the selected cable from the current cable drum. This option is available only
when cables are associated with the cable drum.
Allow multiple pulling areas When assigning cables to the current drum, select to instruct the
software to look for all available cables that belong to the selected reference cable. If you do not
select this check box, you need to select an appropriate pulling area from the Pulling area list.
Once you define an appropriate reference cable and allow multiple pulling areas, after clicking
Add in the Assigned cables data window below, the software finds all the cables that belong to
the current reference cable and not just those cables that are assigned to one specific pulling
area.

Cable Set Properties Dialog Box


Provides information about cable sets that you define for an instrumentation cable.
Sequence Indicates the sequence of the set in the cable. Note
that you cannot change the values in this column.
Set Type The set type represents the arrangement of the wires in the set, such as Wire, Pair,
Pair w/Shield, Triad, Triad w/Shield, and so forth. The default value for this property comes
from the set type selected for the cable. You can edit the values of this property so long as you
have not assigned a reference cable to a project cable. If the set type is unknown, for example if
you change the number of sets in the Cable Common Properties dialog box, the value Other
appears.
Item Tag Displays the item tag for each set. You can change these values if desired.

Cable Sizing Matrix Dialog Box


Enables you to review all the acceptable reference cables and parallel combinations defined in the
Reference Data Explorer that can be used for the specified load and electrical parameters, and to
select from the list a single cable or an assembly of parallel cables. Only those cables that meet
or exceed all the sizing criteria appear in the list.
Comment Indicates whether the suggested cable in the list exactly meets the sizing data
criteria or exceeds the needed size as shown by the values: Recommended or Oversized.
Conductor Size Shows the conductor cross-section area for each cable that meets the sizing
criteria.

SmartPlant Electrical User's Guide

641

Windows and Dialog Boxes


Number of Cables Indicates the number of parallel cables for all appropriate recommended or
oversized cables that meet the sizing criteria, up to a maximum determined by the values of the
minimum cross-section area and maximum number of parallel cables as specified in the Options
Manager.
Reference Cable Item Tag Indicates the name of the associated reference cable.
Description Displays the reference cable description.
Basic Ampacity in Air Indicates the basic ampacity in air value.
Basic Ampacity in Ground Indicates the basic ampacity in ground value.
Maximum Cable Length Indicates the maximum allowed length of cable of the recommended
cross-section that meets the voltage drop requirements.
Required Area (cmils) This column appears only if you select the Use short circuit cable
sizing check box and enter short circuit sizing data. It indicates the minimum required conductor
cross-section area in cmils needed to meet the short circuit criteria that you specify.
Export To Excel Creates an Excel spreadsheet that contains the data in the current matrix.

Cable Cuts Dialog Box


Displays the cable cuts and their lengths according the assigned drums. The number of splices is
always one less than the number of cable cuts.
Sequence Displays the cable cut sequence.
Drum Tag Displays the name of the associated drum for each cable cut.
Length Displays the length of the cable cuts for each drum.

Compare Project and Reference Cable Data Dialog Box


Enables you to compare project and reference cable data where the reference cable data has
been changed.
Property Displays the cable property that has changed. The software compares changes in
the values of any of the following properties:
BasicAmpacityInGround
BasicAmpacityInAir
BasicInsulationTemperatureRating
InsulationThickness
InsulationColor
InsulationMaterial
InsulationTradeName
InsulationType
ArmorReactance
ArmorResistivity
BendingRadius
OutsideDiameter
InnerSheathDiameter
InsulationVoltageRating
InsulationTempRating
Resistivity
Reactance

642

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


InnerInsulationTempRating
ArmorType
JacketColor
JacketInsulationMaterial
JacketInsulationTempRating
StorePartNumber
TemperatureClass
WeightPerLength
IngressionProtection
PullTension
Project Cable Value Displays the current value of the property in the selected project cable.
Reference Cable Value Displays the new value of the property in the associated reference
cable.
OK Selects the project cable for copying data in the Apply Reference Data to Project Cables
dialog box.
Cancel Closes the dialog box without selecting the cable.

Compare Project and Reference Cable Data Dialog Box


Enables you to compare project and reference cable data where the reference cable data has
been changed. You can copy the updated reference data to the project cable if you require.
Property Displays the cable property that has changed. The software compares changes in
the values of any of the following properties:
BasicAmpacityInGround
BasicAmpacityInAir
BasicInsulationTemperatureRating
InsulationThickness
InsulationColor
InsulationMaterial
InsulationTradeName
InsulationType
ArmorReactance
ArmorResistivity
BendingRadius
OutsideDiameter
InnerSheathDiameter
InsulationVoltageRating
InsulationTempRating
Resistivity
Reactance
InnerInsulationTempRating
ArmorType
JacketColor
JacketInsulationMaterial

SmartPlant Electrical User's Guide

643

Windows and Dialog Boxes


JacketInsulationTempRating
StorePartNumber
TemperatureClass
WeightPerLength
IngressionProtection
PullTension
Project Cable Value Displays the current value of the property in the selected project cable.
Reference Cable Value Displays the new value of the property in the associated reference
cable.
Copy Data Copies the changed data from the reference cable to the project cable. For a
parallel cable assembly, the software applies the reference data to all the cables in the assembly.
Cancel Closes the dialog box without copying the data.

Define Color Pattern Dialog Box


Enables you to define the colors of each conductor in a cable, and whether the cable consists of a
single set of conductors or repeating sets where the cables are identified by the same colors.
Color pattern tag - Select an existing color pattern tag or type a new tag name after clicking New.
New Click to define a new color pattern.
Delete Click to delete the color pattern that appears in the Color pattern tag box.
Pattern type Click the desired option:
Individual colors Assign a single color to each conductor. If the number of conductors in
the Cable Common Properties dialog box is greater than the number of colors you define in
this dialog box, the software does not assign colors to the extra conductors.
Repeating colors Assign color to the conductors according to the sequence of each
conductor. If the number of conductors in the Cable Common Properties dialog box is
greater than the number of colors that you define in this dialog box, the software assigns the
colors repeatedly in sequence to all the conductors. This way, you can define colors to apply
to multiple sets of conductors.

Wire definitions
Sequence Indicates the sequence of the conductor in the cable or set.
Color Select a color for each conductor.
Sequence Indicates the sequence of the conductor in the cable or set.
Color Select a color for each conductor.
Add Adds an empty row below the currently selected row.
Insert Adds an empty row above the currently selected row.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order of the conductors in the cable or set.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order of the conductors in the cable or set.
Remove Removes the currently selected conductor.

644

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Insert Power Cable Dialog Box


This dialog box allows you to insert a power cable between items of equipment in the Electrical
Engineer. You can either select an existing power cable from the reference cable library or
select appropriate cable specification properties.

Cable definition
Select from cable library Choose this option to select an existing reference power cable.
Reference cable Display the power cable you selected on the Select Reference Cable dialog
box.
Opens the Select Reference Cable dialog box, which contains reference power cables.
Specify construction Select this option to define a new power cable based on a specified
conductor arrangement. This option is available only when you define a reference power cable
for an item profile and a reference circuit.
Conductor arrangement Defines the number and arrangement of the conductors in the power
cable. The following standard options are available:
Conductors Specifies the number of conductors within the power cable used for carrying the
current, excluding the neutral, the ground, or additional conductors. If you selected Single-core
or Multicore as the conductor arrangement, this option allows you to specify the number of
conductors or cores in the cable that carry the electric current.
Additional conductors If you selected Multicore as the conductor arrangement, this property
specifies the number of additional non-current-carrying conductors, such as ground wires.
OK Inserts the specified power cable between items of equipment under the equipment item
you selected in the Electrical Engineer.

Reference Gland Common Properties Dialog Box


Enables you to set options for defining cable glands. When you define project cables, you can
add glands to one or both cable ends. The software is able to calculate a gland take-off and
generate the results in a report.
General Tab (see "General Tab (Reference Gland Common Properties Dialog Box)" on page 645)
Details Tab (see "Details Tab (Reference Gland Common Properties Dialog Box)" on page 646)
Procurement Tab (see "Procurement Tab (Reference Gland Common Properties Dialog Box)" on
page 646)

General Tab (Reference Gland Common Properties Dialog Box)


Sets options for general properties that identify and characterize the gland. An asterisk beside a
property name indicates required data.
Gland tag Identifies the gland. The reference gland tag is the name that appears beside the
gland in the Reference Data Explorer.
Description Allows you to type a description of the gland, for information only.
Gland type Allows you to select a gland type from the list. You can define and customize
gland types in the Data Dictionary Manager.
Gland size Allows you to select a standard code used to represent the gland size.
Gland material Allows you to select the material used for the body of the gland.

SmartPlant Electrical User's Guide

645

Windows and Dialog Boxes


Plating Allows you to select a material used for gland plating, if appropriate. You can define
and customize plating materials in the Data Dictionary Manager.
Explosion protection Allows you to select the type of explosion protection required for the
gland, if appropriate.
Ingression protection Allows you to select the type of ingression protection required for the
gland, if appropriate.
Design standard Allows you to select a design standard from the list. You can define and
customize design standards in the Data Dictionary Manager.
Certification Allows you to select a certification standard from the list. You can define and
customize certification standards in the Data Dictionary Manager.

Details Tab (Reference Gland Common Properties Dialog Box)


Provides information about the structure and dimensions of the gland, and of accessories
associated with the gland. An asterisk beside a property name indicates required data.

Thread
Thread type Allows you to select the thread type used for the gland.
Thread size Allows you to select a standard code used to represent the thread size.

Gland seal range


Outer sheath maximum diameter Allows you to type a value for the maximum diameter of the
outer gland sheath, including units.
Outer sheath minimum diameter Allows you to type a value for the minimum diameter (after
compression) of the outer gland sheath, including units.
Inner sheath maximum diameter Allows you to type a value for the maximum diameter of the
inner gland sheath, including units.
Inner sheath minimum diameter Allows you to type a value for the minimum diameter (after
compression) of the inner gland sheath, including units.

Components and accessories


Locknut Allows you to select the material of the gland locknut, if appropriate.
IP washer Allows you to select the material of the gland IP washer, if appropriate.
Shroud Allows you to select the material of the gland shroud, if appropriate.
Earth tag If the gland includes an earth tag, allows you to select the material from the list.
Seal If the gland includes a seal, allows you to select the material from the list.
Serrated lock If the gland includes a serrated lock, allows you to select the material from the
list.
Armor clamps Allows you to select this check box if the gland is suitable for armored cable.

Procurement Tab (Reference Gland Common Properties Dialog


Box)
Allows you to enter information related to ordering glands for your inventory.
Manufacturer Allows you to select a manufacturer. You can define and customize
manufacturers in the Data Dictionary Manager.

646

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Manufacturer part number Allows you to enter a part number specified by the manufacturer of
the gland type.
Stores part number Allows you to enter a reference number for the gland type in your
inventory.

Reference Cable Library Dialog Box


Enables you to select a reference cable defined in the Reference Data Explorer for connecting to
a control station.
Reference Cable Shows the list of reference cables that belong to the cable specification that
you select on the Select Reference Cable dialog box.
Formation Describes the structure of the cable in terms of the number of conductors, and
where appropriate, additional conductors with their sizes. For example, 3 x 2.5 mm2 + 2 x 1.0
2
2
mm2 - that is, three 2.5 mm main conductors and two 2.5 mm additional conductors.
Cable Specification Indicates the family of cables to which the reference cable belongs
corresponding to the cable specification that you select before opening this dialog box. You can
define and customize cable specifications in the Data Dictionary Manager
Armor Type Indicates the type of armor used to protect the cable from its environment. For
example, types of armor include non-armored, steel, or lead.
Insulation Indicates the material used for the cable jacket. For example, insulation materials
include PVC and polyethylene.
Temperature Indicates the manufacturer rating of the maximum operating temperature for the
cable.
Voltage Rating Indicates the standard voltage rating that applies to the cable.

Replace Cables Dialog Box


Replaces the characteristics of a group of project cables using specified properties from a
common reference cable. Note that the software does not allow you to replace cables in batch
mode if the cables that you want to replace have already been terminated. You can replace a
cable manually in the Common Properties dialog box if the reference cable has the same
conductor arrangement as the cable you want to replace.

Filter criteria
Allows you to select a set of criteria to filter the available reference cables from which you select to
replace the existing reference cables.
Cable category Displays the category that defines the purpose for which the cable is used,
that is, power, control, grounding, or instrumentation. The category depends on the folder from
which you selected the cables and is read-only.
The software replaces cables of the same category. For example, you can only replace a
power cable with another power cable.
Cable specification Allows you to select a specification that defines a family of cables, each
consisting of a specific group of reference cables.
Conductor arrangement Allows you to select an option that defines the number and
arrangement of the conductors required. Only those reference cables that correspond to a
selected conductor arrangement appear. The following standard options are available:
Single core cable Selects current-carrying cables with a single core.
2-core cable Selects cables with two current-carrying conductors and no additional
conductors.

SmartPlant Electrical User's Guide

647

Windows and Dialog Boxes


2+1-core cable Selects cables with two current-carrying conductors and one additional
conductor.
3-core cable Selects cables with three current-carrying conductors and no additional
conductors.
3+1-core cable Selects cables with three current-carrying conductors and one additional
conductor.
3+2-core cable Selects cables with three current-carrying conductors and two additional
conductors.
Multicore cable Selects cables with multiple conductors.
Size Allows you to select a predetermined cable size. Only those reference cables that
correspond to a selected cable size appear.

Replacement cable
Shows the reference cable and its cable formation. This cable is used to replace the selected
cables.
Reference cable Select the reference cable that you want to use for replacing the selected
cables.
Cable formation Displays the cable formation (number and size of conductors) for the
selected reference cable. This property is read-only.
Data window Displays the cables that you selected in the Electrical Index, with details of the
cable tag, the cable formation, conductor material, and conductor arrangement. Beside each
cable name is a check box that allows you to select the cable for replacing.
Select all Allows you to select all the cables in the list for replacing.

648

The software replaces cables of the same category. For example, you can only replace a
power cable with another power cable.
You cannot replace a cable that has been locked to a cable drum.
The software replaces only the values of the following properties with values from the
reference cable that you select:
Cable Category
Cable Specification
Basic Ampacity in Air
Basic Ampacity in Ground
Reactance
Resistivity
Actual Conductor Size
Additional Conductor Size
Air Ampacity Temperature
Armor Type
Bending Radius
Conductor Arrangement
Conductor Material
Conductor Size
Inner Insulation Temperature
Insulation Color

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Insulation Material
Insulation Temperature rating
Insulation Thickness
Insulation Voltage Rating
Jacket Color
Jacket Insulation Material
Jacket Insulation Temperature
of Additional Conductors
of Conductors
of Conductors in Group
of Sets
Outside Diameter
Overall Shield
Pull Tension
Weight per Length
Cable Formation
Electrical Equipment Class
Electrical Equipment Sub Class
Electrical Equipment Type
Stores Part Number
The software clears the values of the following properties:
Calc Starting Voltage Drop
Calc Voltage Drop Percent
The software retains the values of all other properties of the selected cables.
When the selected cables for replacing include parallel cables, only one tag per parallel cable
assembly appears in the display; however the software performs the operation for all the
parallel cables in each assembly. If descriptions exist for the individual parallel cables, the
software retains those descriptions.
If you want to replace a group of parallel cables generated by the sizing procedure with cables
having a different formation, for the Reference cable property, you must select Non-sized
power cable. Otherwise, you can only replace parallel cables with another group of cables
that have the same formation. For example, you can only replace three parallel cables of 300
m2
2
mm2 (3*300 m ) with another configuration of 3 parallel cables, such as 3*90 mm , 3*(3*25
2
2
mm +1*10 mm ), and so forth.

SmartPlant Electrical User's Guide

649

Windows and Dialog Boxes

Select Reference Cable Dialog Box


You use this dialog box when performing one of the following operations:
Setting a reference cable for the cable drum that you are defining on the Cable Drum
Properties dialog box (see "Cable Drum Common Properties Dialog Box" on page 639)
Selecting a power cable for inserting between two items of equipment in the Electrical
Engineer.
Selecting a reference cable for a single-core cable assembly.

Filter criteria
Filters the Reference cable list, from which you select a reference cable. Each field for which
you select a value further filters the list.
Cable category Allows you to select a category that defines the purpose for which the cable is
used: Power, Instrumentation, Control, or Grounding. This is a required field for this dialog
box.
When defining a neutral or grounding cable for a single-core cable assembly, you can
select a power or grounding cable from the Cable category list. Power cables used as grounding
or neutral cables are automatically connected as phase cables and they appear in the Electrical
Engineer. In cable block diagrams and SLDs, the software displays them as phase power cables
belonging to single-core cable assemblies.
Cable specification Allows you to select a filter criterion that defines a family of cables, each
consisting of a specific group of reference cables.
Conductor arrangement Allows you to select a filter criterion that defines conductor number
and arrangement.
Size Allows you to select a cable size as a filter criterion.

Select cable
Reference cable Allows you to select a reference cable for the cable drum that you are
defining on the Cable Drum Common Properties dialog box. This is a required field for this
dialog box.
Cable formation Displays the cable formation (number and size of conductors) for the
selected reference cable.

Drum sizes
These options allow you to select an appropriate set of cable lengths for cable assignment to
drums.
Minimum cable length to order Displays the minimum length of cable when ordering from the
supplier. The software enters this value automatically after you select an appropriate set of cable
lengths on the Drum Sizes dialog box.
Maximum drum capacity Displays the maximum total cable length that the drum can hold,
including any spare cable. The software enters this value automatically after you select an
appropriate set of cable lengths on the Drum Sizes dialog box.

650

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Select Opens the Drum Sizes dialog box where you can select an appropriate set of cable
lengths to optimize the drum associated with the current reference cable.
You can change the drum capacity of a drum even if the drum is assigned to a cable.
This way you can implement new drum capacities supplied by vendors. You can edit the
properties of the associated reference cable and add or change the drum capacity values
for that reference cable. Once you have added new Minimum and Maximum values or
changed the existing Minimum and Maximum values of the associated reference cable,
click the Select button to set a different drum capacity for a drum regardless of whether
the drum has or has not been assigned to a cable.

Drum Sizes Dialog Box


This dialog box enables you to select an appropriate set of cable lengths for drum assignment.
The values that you see here are the ones that have been entered on the Design Data tab of the
Reference Cable Common Properties dialog box. To add or modify these values, open the
Reference Cable Common Properties dialog box of the reference cable associated with the
current drum and click the Design Data tab.
Select an appropriate row and click OK. After clicking OK, the software automatically enters the
selected values in the appropriate fields on the Select Reference Cable dialog box.
Minimum Displays the Minimum cable length to order value, which is the minimum length of
cable when ordering from the supplier.
Maximum Displays the Maximum drum capacity value, which is the maximum total cable
length that the drum can hold, including any spare cable.

Synchronize Gland Associations Dialog Box


You use this dialog box to synchronize the glands on plant cables with the glands on the reference
cables. Two synchronization options are available:
Synchronize the glands on selected plant cables with the glands on the reference cables
associated with each of the selected plant cables. For details, see Synchronize Cable Glands
with Reference Cables in Batch Mode (on page 144).
Synchronize the glands on a number of plant cables with the glands on a specific reference
cable. For details, see Synchronize Cable Gland Associations with a Specific Reference
Cable (on page 145).

Filter cable criteria


This group box contains options for filtering the plant cables that you want to select for the
synchronization. These cables appear under Cable data below the Filter cable criteria group
box.
If you selected the required cables in the Electrical Index, the filter options are
not available.
Cable category Allows you to select a cable category for filtering the cable data.
Cable specification Allows you to select a cable specification for filtering the cable data.
Conductor arrangement Allows you to select a conductor arrangement for filtering the cable
data.
Conductor size Allows you to select a conductor size for filtering the cable data.

SmartPlant Electrical User's Guide

651

Windows and Dialog Boxes


Reference cable Allows you to select a reference cable whose glands will be used for all the
plant cables that you select for synchronization.
You must select an appropriate reference cable to be able to populate the Cable
data grid.
Cable formation Allows you to select a cable formation for filtering the cable data.

Synchronize
Allows you to select one of the options below to instruct the software to synchronize the glands on
one of the cable sides or both.
Glands on both cable sides Synchronizes the glands on both sides of the selected
cables.
Glands on the "To" cable sides Synchronizes the glands on the "To" side of the selected
cables.
Glands on the "From" cable sides Synchronizes the glands on the "From" side of the
selected cables.
Show Cable Data Populates the Cable data section with all the plant cables that comply with
filter condition that you have set and whose glands are inconsistent with the glands on the
selected reference cable.
This button becomes available only after selecting a reference cable in the Filter
criteria group box and the gland on that reference cable is inconsistent with glands on the
selected plant cables.

Cable data
This data window holds all the cables that comply with the filter criteria that you set in the Filter
cable criteria group box. Selecting the check box beside a cable includes the cable in the
synchronization process.
Select cables Allows you to select multiple cables in the Cable data section. Click the check
box to select All or click the arrow to select one of the following commands:
All Selects all the cables in the data window.
None Clears the selection of all the cables in the data window.
All cables without glands Selects all the cables that do not have any glands.
All cables with different glands Selects all the cables whose glands are different from the
ones on the associated reference cables.

Single-Core Cable Assembly Common Properties Dialog Box


This dialog box displays the common properties of the single-core cable assembly.
Assembly tag Displays the name of the selected single-core cable assembly. Click the
ellipsis button
to open a dialog box where you can edit the name.
Cable arrangement Displays the cable arrangement of the single-core cable assembly.
Phase arrangement Displays the phase arrangement of the single-core cable assembly.
Description Displays the user defined description of the single-core cable assembly. Click
the ellipsis button
to open a dialog box where you can type longer text for the description.
Width Displays the width of the single-core cable assembly (user defined).
Height Displays the height of the single-core cable assembly (user defined).

652

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Area Displays the area occupied by the single-core cable assembly. Automatically calculated
from properties entered in the Width and Height fields.

Current carrying cores


Displays the properties of the power cables used in the single-core cable assembly. The
properties displayed are:
Item Tag
Formation
Phase
Tag Suffix

Neutral cables
Displays the properties of the neutral cables used in the single-core cable assembly. The
properties displayed are:
Item Tag
Formation
Tag Suffix
You can click Add or Delete if you want to add or delete a cable from the current assembly.

Grounding cables
Displays the properties of the grounding cables used in the single-core cable assembly. The
properties displayed are:
Item Tag
Formation
Tag Suffix
You can click Add or Delete if you want to add or delete a cable from the current assembly.

Reference Single-Core Cable Assembly Common Properties


Dialog Box
This dialog box allows you to enter or edit the common properties associated with a reference
single-core cable assembly.
Assembly tag Displays the name of the selected single-core cable assembly. Click the
ellipsis button
to open a dialog box where you can edit the name.
Cable arrangement Allows you to select a cable arrangement for the single-core cable
assembly.
Phase arrangement Allows you to select the phase arrangement of the single-core cable
assembly.
Description Allows you to type a description for the single-core cable assembly. Click the
ellipsis button
to open a dialog box where you can type longer text for the description.
Width Type the width of the single-core cable assembly.
Height Type the height of the single-core cable assembly.
Area Automatically calculates and displays the area occupied by the single-core cable
assembly using the values typed in the Width and Height fields.

SmartPlant Electrical User's Guide

653

Windows and Dialog Boxes


Select predefined Cable Assembly Click this button to open the Find dialog box where you
can search for and select a predefined cable assembly (available only when creating a new
single-core cable assembly in the Electrical Index, not in the Reference Data Explorer).

Current carrying cores


Reference cable Allows you to select a reference cable from the Reference Data Explorer
window. Click the ellipsis button
to open the Select Reference Cable dialog box and select
the required reference cable.
Cable specification number Displays the reference cable Cable Specification Number.
This is automatically inserted when selecting the reference cable and cannot be edited.
Cable formation Displays the reference cable's Cable Formation. This is automatically
inserted when selecting the reference cable and cannot be edited.
Phase label 1 Allows you to select a suffix for the first phase connector.
Phase label 2 Allows you to select a suffix for the second phase connector. The software only
allows the selection of a label that is not being used by a connector within the assembly.
Phase label 3 Allows you to select a suffix for the third phase connector. The software only
allows the selection of a label that is not being used by another connector within the assembly.

Neutral cables
Allows you to select the neutral cable of the single-core cable assembly (only available if a neutral
cable has been included as part of the phase arrangement.
Click Add to open the Select Reference Cable dialog box to add the required cables.
Click Remove to remove cables that are not required.
Item tag Displays the cable name.
Category Displays the cable category.
Specification Displays the cable specifications
Formation Displays the cable formation.

Grounding cables
Allows you to select the grounding cable of the single-core cable assembly (only available if a
grounding cable has been included as part of the phase arrangement.
Click Add to open the Select Reference Cable dialog box to add the required cables.
Click Remove to remove cables that are not required.
Item tag Displays the cable name.
Category Displays the cable category.
Specification Displays the cable specifications
Formation Displays the cable formation.

654

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Cable Block Diagrams


Create New Plant Circuits Dialog Box
This dialog box opens automatically when you select or drag a typical CBD that contains typical
circuits. The dialog box allows you to create new plant circuits according to the typical circuits
listed in the dialog box. Also, you assign each new plant circuit that will be created to an
appropriate PDB, bus, and cell in your plant.
The dialog box lists all the typical circuits that are contained in the current typical CBD. You select
an appropriate PDB, bus, and cell for each new plant circuit that will be created. If you want to
assign a new plant circuit to a free-standing bus, do not select a PDB. Just click
in the Plant
Bus field to find an appropriate free-standing bus.
You can assign your new plant circuits to appropriate cells, create new cells or skip the cell
assignment as needed. To create a new cell, select Create new cell from the Plant Cell list.
Note that if you do not select a bus for a particular typical circuit listed in this dialog
box, the software will not create a plant circuit for that typical circuit.
The dialog options are as follows:
Typical Circuit Displays the name of each typical circuit contained in the current typical CBD.
Typical Circuit Type Displays the type of each typical circuit contained in the current CBD.
(For example, Feeder)
Plant PDB Allows you to select an appropriate plant PDB (by clicking
) to which you want to
assign the new plant circuit.
Plant Bus If you have selected a plant PDB, allows you to select an appropriate plant bus to
which you want to assign the new plant circuit.. If you chose not to select a PDB, click
to select
a free standing bus.
Plant Cell Allows you to select an appropriate cell or create a new one.
OK Closes this dialog box and creates the plant circuits that will also be placed on the new CBD
drawing.
Clear Clears the PDB, bus and cell selection that you have made for the selected typical circuit.

Resolve Symbol Inconsistencies Dialog Box


This dialog box allows you to resolve symbol inconsistencies in plant and typical cable block
diagrams. Symbol inconsistencies can occur if, for some reason. a symbol file has been replaced
or updated. Once you save a CBD, the software retains the symbols in the drawing as they appear
at the time of saving. If, at a later stage, some of the symbol files have been updated, the CBD that
you open will not display the updated symbols until you resolve the inconsistencies. When
updating the symbols, the software validates that the updated symbols are suitable replacements
for the old symbols. For example, the new symbols must have suitable connect points so that
connections can be made. If the new symbols are not suitable, they will not replace the old ones in
the drawing and the software will display an appropriate message to that effect.
Item Tag Allows you to select the item tag that the symbol represents in the CBD. You must
select at least one item tag to enable the Resolve command button. Note that the Item Tag check
box is not available for symbols that cannot be resolved.
Item Type Displays the item type that the symbol represents.
Current Symbol File Name Displays the symbol file name as it is currently used in the
database.

SmartPlant Electrical User's Guide

655

Windows and Dialog Boxes


Displayed Symbol File Name Displays the symbol file name as it appears in the open CBD.
Inconsistency Reason Displays a brief reason for the inconsistency.
Expected Result Informs you if the current symbol can or cannot be replaced. If the symbol
cannot be replaced, click the message text to display a brief explanation why the software cannot
replace the current symbol.
Resolve Replaces the symbols in the CBD with the updated symbols.

If the software does not resolve all of the symbols, a message appears that instructs you to
open the log file where you can see which symbols have not been replaced.
The Resolve command button on the Resolve Symbol Inconsistencies dialog box is
available only after selecting at least one item tag to be resolved.
If a symbol cannot be resolved, the software indicates it under Expected Result. You can
click the Symbol cannot be resolved text to see the reason why the symbol cannot be
resolved.

Cable Routing
Actual Routing Path Dialog Box
The actual routing path for a cable is determined by the value of the Use External Routing
Length property. If set to True, the software displays the external routing path retrieved from
SmartPlant 3D, if it exists. If the value of the Use External Routing Length property is set to
False, this dialog box displays the routing path defined in SmartPlant Electrical, if it exists.

656

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Batch Cable Routing Dialog Box


Enables you to define a cable routing path and assign cables to this routing path in batch mode.
Clear routing from selected cables - Select to delete existing routing from selected cables
without assigning new cable routing, when you click Apply or OK. Clear to enable assignment of
cables to the routing path that you define in the Cable routing group box.

Cable routing
In this group box, you build the routing path to which you then assign cables.
Select predefined route When you click Find, allows you to select a predefined route to use
as a basis for the cable routing definition.
Copy route from cable When you click Find, allows you to select routing from another cable to
use as a basis for the cable routing definition.
Segregation level Displays the segregation level that applies for the cables that you selected
prior to opening this dialog box. The value of the segregation level is read-only.
Find Opens the Find dialog box, from which you can select as predefined route or a cable with
routing for copying, according to the option you have selected. Note that only routes or cables
that belong to the current segregation level are available for selection.
Save as New Route Opens the Route Properties dialog box, from which you can save the
current routing definition as a new predefined route.

Route details
Displays the cableways and segments that make up the routing. Note that only those segments
that belong to the current segregation level are available for selection.
Sequence Indicates the sequence of the segment in the routing path.
Cableway Select the cableway from which you want to select a segment.
Segment Select the segment through which you want to route the cables. You can use each
segment only once in a route.
Length Displays the segment length for the selected segment. You define this value in the
Properties window.
Add Adds a new segment row below the currently selected row.
Insert Adds a new segment row above the currently selected row.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Remove Removes the currently selected segment from the route.
Routing length Displays the total length of the segments that you defined.

Select cables
Displays the cables that you selected in the Electrical Index or Tabular Editor, with details of the
cable tag, cable formation, cable category, armor type, and routing path. Beside each cable
name, in the Select column, is a check box that allows you to select the cable for routing.
Select all Allows you to select all the displayed cables for routing.

SmartPlant Electrical User's Guide

657

Windows and Dialog Boxes

Cableway Common Properties Dialog Box


Enables you to set options for defining properties of cableways, including the segments that make
up the cableway.
Cableway Identifies the cableway. The cableway tag appears beside the cableway in the
Electrical Index. You must enter a value that matches the naming convention for the
cableway. You define naming conventions in the Options Manager.
Description Allows you to type a description of the cableway, for information only.

Segments
This section displays details of the segments that make up the cableway. When you start to
define the segments, the details appear. You can modify the item tag if required; all other
properties are view-only. You can also add segments to a cableway and you can delete and sort
segments that do not have cables assigned to them. Note that if you insert a segment in the
middle of a cableway that already has assigned cables, the software automatically updates the
routing.
Item Tag Allows you to modify the item tag that identifies the cableway segment.
Reference Component The reference cableway component used for the segment.
Category The category to which the segment belongs: Tray, Conduit, or Miscellaneous.
Description Displays the segment description, if applicable.
Add Adds a new segment row below the currently selected row.
Insert Adds a new segment row above the currently selected row.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order of the segments in the cableway.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order of the segments in the cableway.
Remove Removes the currently selected segment from the cableway.
Notes Allows you to type user notes, for example if you want to provide additional information
regarding special features of the cableway.

Cableway Segment Common Properties Dialog Box


Enables you to set options for defining properties of cableway segments used in cable
routing. You can specify any one of three categories of cableway segments: trays, conduits, and
miscellaneous components. Miscellaneous components are used to make various connections
between trays and conduits.
General Tab (see "General Tab (Cableway Segment Common Properties Dialog Box)" on page
659)
Associated Cables Tab (see "Associated Cables Tab (Cableway Segment Common Properties
Dialog Box)" on page 661)

658

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

General Tab (Cableway Segment Common Properties Dialog


Box)
Allows you to define and edit basic properties of a cableway segment used to route cables.
Item tag Allows you to specify a tag that uniquely identifies the cableway segment.
Cableway Displays the cableway with which the segment is associated. This value is
read-only.
Description Allows you to type a description of the cableway segment, for information only.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular segment.
Category Displays the category of the cableway component used as the reference item for the
cableway segment. If no reference cableway component is selected, you can also select a
category: Tray, Conduit, or Miscellaneous, which the software uses to filter the results when you
click Find to look for a reference cableway component to associate.
Segregation level Allows you to specify a segregation level for the segment. All segments
that belong to a particular routing path must have the same segregation level, and all cables that
you route through those segments must have the same segregation level as those segments.

Reference component
Describes the reference cableway component used as the catalog item for the segment. Default
values for some of the segment properties, such as Length, Width, and some fill properties come
from the component.
Find Opens the Find dialog box, where you can select a reference cableway component to
which you assign the current cableway segment.
Dissociate Allows you to clear the association of the selected reference component with the
cableway segment.
Length Allows you to type a value for the length of the segment. You can use the value that
you type to represent a space reservation or an actual length of routing.
Diameter Displays the value of the diameter of the cableway segment. This read-only value
comes from the reference cableway component used as the basis for this segment and applies
only to segments with category Conduit.
Width Displays the value of the width of the cableway segment. This read-only value comes
from the reference cableway component used as the basis for this segment and applies only to
segments with category Tray or Miscellaneous.
Depth Displays the value of the depth of the cableway segment. This read-only value comes
from the reference cableway component used as the basis for this segment and applies only to
segments with category Tray or Miscellaneous.
Notes Allows you to enter text, for example, if you want to provide additional information about
the segment.

Adjacent segments
Displays the names of the segments on either side of the current segment in the cableway. The
positions of the segments are determined by the sequence assigned to them on the Cableway
Common Properties dialog box.
From segment The segment with sequence number preceding that of the current segment. If
no segment precedes the current segment, the software displays End.

SmartPlant Electrical User's Guide

659

Windows and Dialog Boxes


To segment The segment with sequence number following that of the current segment. If no
segment follows the current segment, the software displays End.

Segment fill
The software calculates on the fly the segment fill percentage for the cables. These cables are
routed on the segment as part of the routing, validating the segment fill percent values against the
maximum allowed values that you specify or, as defined by NEC code. The software takes into
account the fill factor that you specify and the maximum weight per unit length allowed on the
tray. If any of the actual values exceed the allowed values, the software rejects them and
displays a warning message. For area or width calculations, the software performs the validation
according to the segment category and whether or not the segment is covered. The dynamic text
that appears indicates the validation method that the software uses. Note that cable fill validation
depends on the values that exist in the Conductor Area cmils lookup table. If the value that you
require is not in this lookup table, add it manually before calculating the segment fill percentage.
Allow overfill Select this check box to ignore validation of values that exceed the allowed area
or weight.
Covered Displays whether the current cableway segment is covered or not. You cannot
change this setting because this parameter is inherited from the associated cableway component
tray in the Reference Data Explorer.
Calculation criteria Select the desired tray fill calculation (shown in percent) by Area or Width
or Auto. Select Auto if you desire the calculation by the Covered flag (default). Note that when
using NEC validation method, the Calculation criteria list is disabled.
Maximum area The maximum available area for the segment. For a covered segment, the
software calculates the area by multiplying the width and depth values together. For a conduit,
the software calculates the area from the diameter. This value is read-only, and comes from the
reference cableway component. Note that When using the NEC Validation method, the Maximum
area, Allowed area, Accumulated area and Accumulated diameter values are calculated in
inches.
Allowed area The actual maximum area of the segment that cables included in the routing are
allowed to occupy. The software calculates this value as the product of the maximum area and
the fill factor. Note that when using the NEC validation method, the Allowed area value is derived
from NEC tables according to the cable type of the cables, located in the tray. Note that when
using NEC validation method, for conduits, the Allowed area value changes according to the
number of cables in the conduit. Note that this pane will be activated only if the calculation is by
Area.
Allowed width The actual maximum width of the segment that cables included in the routing
are allowed to occupy. The software calculates this value as the product of the Maximum width of
the tray, the layers and the Fill factor, Using NEC validation method the software derives the
Allowed width from the NEC tables. Note that this pane will be activated only if the calculation is by
width.
Fill factor Type a value representing the fraction of the maximum area or the maximum width
that you want to allow when adding cables to the segment. You can type any positive value,
including values that are greater than 1; however, for conduits, covered trays or for NEC, the fill
factor value should not exceed 1.
De-rating factor Used for NEC validation, This code factor can have one of three different
values (0.4, 0.5, 0.9), The code multiplies the Allowable width or the Allowable area.
Accumulated area The total area occupied by the cables routed through the current
segment. When appropriate, the software validates this value against the allowed area value.
Note that when using the NEC validation method, the Accumulated area value may be higher
than the Allowed area value.

660

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Number of layers Type an integer indicating the number of layers of cables that you want to
allow when the software performs validation by diameter.
Accumulated diameter The sum of the outer diameters of all the cables routed through the
current segment. When appropriate, the software validates this value against the product of the
segment width, the fill factor, and the number of layers.
% fill calculates the values that indicate the segment fill percentage.
Maximum weight The maximum weight per unit length of cables that the segment is capable
of supporting. This value is read-only, and comes from the reference cableway component.
Allowed weight The actual maximum weight per unit length that cables included in the routing
are allowed to reach. The software calculates this value as the product of the maximum weight
and the weight factor.
Weight factor Type a value representing the fraction of the maximum weight per unit length
that you want to allow when adding cables to the segment. You can type any positive value,
including values that are greater than 1.
Accumulated weight The total weight per unit length of the cables routed through the current
segment.

Associated Cables Tab (Cableway Segment Common Properties


Dialog Box)
Displays a list of the cables associated with the segment. The data on this tab is read-only. You
make the actual associations on the Cable Common Properties dialog box or on the Batch
Route Cables dialog box.
Item Tag Identifies the cable. The cable tag appears beside the cable in the Electrical Index.
Formation Displays information based on the total number and the size of the conductors or
cable sets specified for the particular cable.
Weight / Length Displays the weight per unit length of the cable. This value is important when
filling the segment to ensure that the total weight per unit length of the cables in the segment does
not exceed the maximum allowed value for the segment. This is the value assigned to the
Weight Per Length property that appears in the Properties window.
Outside Diameter Displays the outside diameter of the cable. When filling a segment, this
value is important for validating that the accumulated outside diameter of the cables in the
segment does not exceed the maximum allowed value for the segment in the case of an
uncovered segment, or that the accumulated area of the cables does not exceed the maximum
allowed area in the case of a covered segment. This is the value assigned to the Outside
Diameter property that appears in the Properties window.

SmartPlant Electrical User's Guide

661

Windows and Dialog Boxes

External Routing Path Dialog Box


If an external routing path is defined for a cable using values retrieved from SmartPlant 3D, this
dialog box displays the sequence of cableways and cable segments in that routing path.

Reference Cableway Component Common Properties Dialog


Box
Enables you to define reference components for creating cableway segments used in cable
routing. You can define three categories of cableway components: trays, conduits, and
miscellaneous components. You use miscellaneous components to make various connections
between trays and conduits.
General Tab (see "General Tab (Reference Cableway Component Common Properties Dialog
Box)" on page 662)
Procurement Tab (see "Procurement Tab (Reference Cableway Component Common Properties
Dialog Box)" on page 664)

General Tab (Reference Cableway Component Common


Properties Dialog Box)
Sets options for general properties that identify and characterize the cableway component.
Cableway component tag Allows you to specify a tag that uniquely identifies the cableway
component. This is also the commodity tag that identifies the cableway component as a bulk
item.
Category Shows the purpose for which the cableway component is used. Examples of
cableway component categories are tray, conduit, and miscellaneous. The software
automatically assigns the category according to the folder in which you create the cableway
component, and you cannot change the value.
Description Allows you to type a description of the cableway component, for information only.
Type Allows you to select a value for the cableway component type. You can define and
customize cableway component types in the Data Dictionary Manager.
Nominal size Type a numerical value corresponding to the manufacturer's data for the
diameter or width of the cableway component. This value is for reference only; it is not used in
any software calculations.
Length Specifies the default length for the segments to which you assign this cableway
component.

662

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Count quantity Specifies whether to count the tray length Metric or Imperial units (Length), or
to count the number of items (Number of Items).
Covered Select this check box to specify a covered segment; clear for an uncovered
segment. This option applies only to cableway component types for which the category is Tray or
Miscellaneous. Selection of this check box affects the calculation of certain segment fill
parameters in the segment that you associate this cableway component with. If you modify this
property after assigning a cable to a segment based on this cableway component, the software
recalculates the segment fill parameters and accepts the change provided you do not exceed the
loading parameter values. Note that the Covered calculation applies in case you do not select
Area or Width calculation for the segment.
Ventilated Select to specify a cableway component that is ventilated. You can use this value
for filtering cableway components. Note that when using the NEC validation method, the
Ventilated option is disabled.
Metallic Select to specify a cableway component that is metallic. You can use this value for
filtering cableway components.
Flexible Applies to conduits only. Select to specify a flexible conduit; clear to specify a rigid
conduit. You can use this value for filtering cableway components.
Bending radius Allows you to specify a bending radius for a component representing a corner
or junction segment. For a very wide segment, the value you type is likely to be some average
value.
Bottom Allows you to select a value for the structure of the cableway component bottom; for
example, Ladder, Solid. This option applies only to cableway component types for which the
category is Tray or Miscellaneous. You can define and customize cableway component bottom
types in the Data Dictionary Manager. Note that when using NEC validation method, the Bottom
pane does not appear.
Construction Specifies the tray type, which affects how the software calculates the segment
field. Available values are: Ventilated channel, Solid channel, Ladder, Ventilated trough,
Solid bottom tray. This option appears only when using the NEC validation method

Loading parameters
Normal span The span required between two supports to ensure proper support of the
component when fully loaded.
Fill factor Type a positive value to be used as the default for segments to which you assign this
cableway component in your project. The fill factor is a quantity that the software multiplies the
maximum diameter or area of the segment by (according to the segment category) in order to
calculate the allowed area or diameter for cable fill. Note that when using the NEC validation
method, the Fill factor is limited to one.
Weight factor Type a positive value to be used as the default for segments to which you assign
this cableway component in your project. The weight factor is a quantity that the software
multiplies the maximum weight per unit length of the segment by in order to calculate the allowed
weight per unit length for cable fill.
Maximum weight per unit length Allows you to type a value for the maximum weight of cable
per unit length that the segment is capable of supporting.

Dimensions
The software uses the values you type for the dimensions to calculate the area of cableway
segments that you associate with this cableway component. If you change the value of the
dimensions after you have assigned a cable to any of these segments, the software recalculates
the segment fill parameters and accepts the change provided you do not exceed the loading
parameter values.

SmartPlant Electrical User's Guide

663

Windows and Dialog Boxes


Width Allows you to type a value for the width of the cableway component. This option applies
only to cableway components with category Tray or Miscellaneous.
Depth Allows you to type a value for the depth of the cableway component. This option
applies only to cableway components with category Tray or Miscellaneous.
Diameter Allows you to type a value for the diameter of the cableway component. This option
applies only to cableway components with category Conduit.
Area Displays a calculated value of the area of the cableway component, according to the
width and depth (for trays or miscellaneous components) or according to the diameter (for
conduits).

Procurement Tab (Reference Cableway Component Common


Properties Dialog Box)
Allows you to enter information related to ordering a specific cableway component for your
inventory.
Manufacturer Allows you to select a manufacturer. You can define and customize
manufacturers in the Data Dictionary Manager.
Manufacturer part number Allows you to enter a part number specified by the manufacturer of
the cableway component.
Stores part number Allows you to enter a reference number for the cableway component in
your inventory.

Predefined Routes Dialog Box


Displays all the available routes defined in your project. The information on this dialog box is
read-only.

Route list
Route Displays the name of the route.
Description Displays a description for the route.
New Opens the Route Properties dialog box (on page 664) to allow you to create a new route.
Properties Opens the Route Properties dialog box to allow you to view or modify the
properties of the selected route.
Delete Deletes the selected route from the database.

Route Properties Dialog Box


This dialog box allows you to display the cableways and segments in a predefined route.
Route Displays the name of the route.
Description Displays a description for the route.
Segregation level You must select a segregation level for the route. The software applies the
segregation level that you select to all segments in the route. Note that once you have added at
least one segment to the routing, you cannot change the segregation level; to do so, you must first
remove all the segments.

664

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Route details
Cableway Select a cableway to filter the segments. You must select a cableway before you
can select a segment .
Segment Select a segment to use in the routing path. Only segments that have the same
segregation level as the one defined for the route are available for selection. Note that you can use
each segment only once in a route.
Length Displays the length of the selected segment with the appropriate units. This value is
read-only.
Add Adds a new segment row below the currently selected row.
Insert Adds a new segment row above the currently selected row.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order of the segments in the route.
Remove Removes the currently selected segment from the cableway.

Routing Path Dialog Box


If a routing path is defined for a cable in SmartPlant Electrical, this dialog box displays the
sequence of cableways and cable segments in that routing path.

SmartPlant Electrical User's Guide

665

Windows and Dialog Boxes

Custom Folders
A compound filter consists of more than one simple filter. Simple filters are added to the
compound filter either by dragging the simple filter to the compound filter folder or by creating new
simple filters under the compound filter in the filter hierarchy. Compound filters apply only to
homogeneous item types. This dialog box specifies the properties of a compound filter, including
the name, description, and whether to match all or any of the simple filter criteria.

Name Specifies the filter name. The name can be any combination of characters and has no
length limit. Filter names within a plant must be unique. This name appears as the filter name on
the Filter Manager interface.
Description Specifies a phrase or sentence about the filter. The description can be any
combination of characters and has no length limit. The description appears as a ToolTip when you
point to the filter name on the Filter Manager interface.

Filter method
Allows you to decide whether items must meet all or only one criterion to pass through the filter.
Match all Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any Specifies that items matching any one or more of the filtering criteria pass through
the filter. Match any is the default matching method.

Custom Folder Properties Dialog Box


Allows you to view a custom folder's properties and change them if required.
Custom folder name Shows the folders name. Change the name by typing over the existing
name, if desired.
Filter name Shows the filter name for the custom folder. Click Browse to change the filter if
desired.

Filter Properties Dialog Box


Specifies properties of a filter, including the name, description, and the other properties that you
want to filter for. Each item type owns a set of properties. Examples of item types are Battery
Bank, Cable, and Motor, and examples of properties for these item types are Float Voltage,
Resistivity, and Locked Rotor Current, respectively.
Name Specifies the filter name. The name can be any combination of characters and has no
length limit. Filter names within a project must be unique. This name appears as the filter name on
the Filter Manager interface.

666

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Description A phrase or sentence about the filter. The description can be any combination of
characters and has no length limit. The description appears as a ToolTip when you point to the
filter name on the Filter Manager interface.
Filter for Contains the top-level items from the Data Dictionary. Specifies available properties
in the Definition grid.

Definition
Displays all defined criteria associated with a filter. To add to or modify the definition list, you must
select a line in the list and then define or edit the property in the Edit group. If you are defining the
Tabular Editor, the criteria that you enter on the Filter tab on the Advanced Table Properties
dialog box are combined with the base filter that you select.
Match all Items matching ALL of the filtering criteria pass through the filter.
Match any Items matching any one or more of the filtering criteria pass through the filter.
Match any is the default matching method.
Add Places a new entry at the end of the existing definition list. Enables the fields in the Edit
group so that you can edit the new entry.
Delete Removes the selected criterion from the definition list. This button is active only when
you select a criterion in the definition list.

Edit
Allows you to define or edit a single line of filter definition criteria.
Property Displays a list of all properties for a certain item type. Examples of properties include
Rated Power, Rated Voltage, and Frequency. You define or modify filtering criteria by selecting
a property, an operator, and a value.
Operator Specifies the relationship between the property and its value. Relationships include,
for example, greater than, >, equal to, =; not equal to, <>, and so forth.
Value Lists appropriate values for the property specified in the Property column. If a list of
properties is not already associated with the Value box, you must type a value, which can be free
text, or specify null. You can type a percent sign (%) as a wildcard character to find multiple
characters or an underscore (_) as a wildcard character for a single character. Do not use an
asterisk (*) in the Value box.

New Custom Folder Dialog Box


Allows you to create a custom folder, within an item type folder, in the Reference Data Explorer
or the Electrical Index. You then apply a filter to the custom folder to add the specific items you
want to the folder.
Custom folder name Allows you to type the folders name.
Filter name Shows the filter name for the custom folder. Click Browse to select the desired
filter.

SmartPlant Electrical User's Guide

667

Windows and Dialog Boxes

Select Filter Dialog Box


Allows you to select a filter for filtering the data for a particular item type to display in a Tabular
Editor view or in a report. Using this dialog box, you can create a new filter or modify an existing
filter. To display this dialog box, you can:
Click Browse on the Filter tab of the Advanced Table Properties dialog box while you are
choosing your item type for displaying in a Tabular Editor view.
Click Browse on the Filter tab of the Define Report Items dialog box while you are choosing
your report item type.
New Displays the New Filter dialog box, which allows you to specify a new simple or new
compound filter.
Properties Allows you to edit the properties of the selected filter. This button displays the
Filter Properties dialog box or the Compound Filter Properties dialog box, depending on your
selection in the filter list. If you create a compound filter, you select the individual simple filters
that comprise a compound filter and click Properties to view the Filter Properties dialog box for
those simple filters.

Electrical Equipment
Apply Options Dialog Box
Enables you to apply default profiles, circuits, control stations, schematics, and lookup tables, all
of which you define in the Reference Data Explorer, to electrical equipment. In this way, you
can create items and populate them with data in a batch operation, thus keeping to a minimum the
editing that you need to perform for individual items.

Equipment Profile Tab (Apply Options Dialog Box)


Sets options for applying profiles to loads and converting equipment.
Enable equipment profile Makes all the controls on this tab available. This check box is used
for security to prevent you from applying a profile in error.
Number of items to create This option is available only when you select the folder for the item
you require prior to selecting Apply Options, and after you select Enable equipment profile. It
allows you to specify the number of new items to create in the Electrical Index in accordance with
the profile you select.
Equipment type Displays the equipment type to which you apply the profile corresponding to
the item or folder you have selected. Examples of equipment types are motors and cables.
Profile name Displays the default profile for the appropriate equipment class, as defined in the
Equipment Profile Properties dialog box. When you select a folder to create new items in batch
mode using the profile, the label appears as Create item based on profile. Click Find to
navigate to a different profile.
Apply to Enables you to select the rule that the software implements when applying the
profile. The options are:
All items Applies the profile to all the selected items.
Items with no profile Applies the profile only to items without an existing profile. Use this
option to add a profile only to new items among the items that you selected.

668

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Items with a different profile from the selection Changes the profile of the selected
items to the current profile. Use this option to add a profile to items with a modified profile
definition.
Items with the same profile as the selection Updates an existing profile for the selected
items.
Populate empty item properties Select this check box to update only those item properties
that contain null data the software does not overwrite any data that is not null.
Clear the check box to leave existing values of the item properties as they are, regardless of
whether they contain null or not null values.

If you modify the components of a typical circuit that already has a reference from an item, the
software does not update the change in the reference until you next apply a typical circuit or a
profile to the item.
When an item has associated power cables, and you connect the item to a circuit by applying
a profile with a typical circuit, if there is more than one cable, the software associates the free
ends of all the power cables with the circuit.
If you apply a profile for a reference motor with a heater to a project motor without a heater, the
software adds a heater to the project motor.
If the item that you are applying a profile to is connected to a feeder circuit, the system
replaces the circuit so that it matches the applied typical circuit as specified in the profile.
If the item is connected to feeder equipment other than a circuit (such as a variable frequency
drive, a transformer, or a battery bank), the software does not apply the profile.

Typical Circuit Tab (Apply Options Dialog Box)


Sets options for applying typical circuits to electrical equipment.
Enable typical circuit Makes all the controls on this tab available. This check box is used for
security to prevent you from applying a typical circuit in error.

Select typical circuit


Clear last applied typical circuit Clears the typical circuit that you last applied. Select this
option if you do not want to apply any typical circuit to the item.
Function Displays the function of the selected typical circuit. Examples of functions are
Incomer and Feeder.
Typical circuit Displays the typical circuit for the item. Click Find to navigate to the typical
circuit that you want to select.
Apply to Enables you to select the rule that the software implements when associating the
typical circuit. The options are:
All items Applies the typical circuit to all the selected items.
Items with no typical circuit Applies the typical circuit only to items without an existing
typical circuit. Use this option to add a typical circuit only to new items among the items that
you selected.
Items with a different typical circuit from the selection Changes the typical circuit of the
selected items to the current typical circuit. Use this option to add a typical circuit to items with
a modified typical circuit definition.

SmartPlant Electrical User's Guide

669

Windows and Dialog Boxes

Items with the same typical circuit as the selection Updates an existing typical circuit
for the selected items.

If you apply a typical circuit to an item that is already associated with a circuit, the software
adjusts the components of the circuit to match the typical circuit specified by the item.
If you modify the components of a typical circuit that already has a reference from an item, the
software does not update the change in the reference until you next apply a typical circuit or a
profile to the item.
If the item that you are applying the typical circuit to is connected to a feeder circuit, the system
replaces the circuit so that it matches the applied typical circuit as specified in the profile.
If the item is connected to feeder equipment other than a circuit (such as a variable frequency
drive, a transformer, or a battery bank), the software does not apply the typical circuit.
If more than one item is connected to the same circuit, the software changes the last applied
typical circuit for all the items.
If you apply a typical circuit that includes associated reference cables, the software creates
project cables from them and adds the project cables to the circuit with the To sides of the
cables associated with the circuit.
You can clear the typical circuit of an item that is not connected to any circuit by selecting
Clear the last applied typical circuit.
You can apply a typical circuit on a circuit, provided that the circuit has no equipment
connected to it.

Control Stations Tab (Apply Options Dialog Box)


Sets options for applying a control station to a load, converting equipment, generator, battery
bank, and disconnect electrical equipment item.
Enable control stations Makes all the controls on this tab available. This check box is used
for security to prevent you from applying control stations in error.
(Data window) Displays the control stations you select for the load. Click Find to navigate to
the control stations you want to select.

If you select a reference control station that has one or more associated control cables, the
software creates these cables in the control station that you add to the project load.
Apply to Enables you to select the rule that the software implements when associating the
control station. The options are:
All items Applies the control station to all the selected items. Select Replace control
stations to replace all existing control stations and their associated control cables; any
existing associations, such as a connection of a control cable to a junction box, are
retained. Clear Replace control stations to add the selected control stations and their
associated control cables to the selected loads along with the existing control stations.
Items with no control station Applies the control station only to items without an existing
control station. Use this option to add a control station only to new items among those items
that you have selected.

670

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Lookup Table Tab (Apply Options Dialog Box)


Sets options for applying a lookup table to the selected items.
Enable lookup table Makes all the controls on this tab available. This check box is used for
security to prevent you from applying a lookup table in error.
Equipment type Displays the equipment type to which you apply the lookup table
corresponding to the item or folder you have selected. Examples of equipment types are motors
and cables.
Lookup table Displays the default lookup table, as defined in the Lookup Table Properties
dialog box, for the appropriate equipment class. Click Find to navigate to the desired lookup
table. (Not available when applying lookup table to circuits.)

Lookup Table Tab (Apply Options Dialog Box) - for Circuit


Internal Components
Sets options for applying a lookup table to the selected project circuit internal components.
Enable associated lookup tables of circuit internals Makes all the controls on this tab
available. This check box is used for security to prevent you from applying a lookup table in error.
Equipment type Displays the equipment type (Circuit) to which you apply the lookup table.

Typical Schematic Tab (Apply Options Dialog Box)


Sets options for applying typical schematics to loads and instruments.
Enable typical schematic Makes all the controls on this tab available. This check box is used
for security to prevent you from applying a typical schematic in error.

Select typical schematic


Clear last applied typical schematic Clears the typical schematic that you last
applied. Select this option if you do not want to apply any typical schematic to the load.
Typical schematic Displays the typical schematic for the load or instrument. Click Find to
navigate to the typical schematic that you want to select.
Apply to - Enables you to select the rule that the software implements when associating the
typical schematic. The options are:
All items Applies the typical schematic to all the selected loads or instruments.
Items with no typical schematic Applies the typical schematic only to loads or
instruments that have no existing typical schematic. Use this option to add a typical
schematic only to new items among the items that you selected.
Items with a different typical schematic from the selection Changes the typical
schematic of the selected loads or instruments to the current typical schematic. Use this
option to add a typical schematic to items with a modified typical schematic definition.

SmartPlant Electrical User's Guide

671

Windows and Dialog Boxes

Typical I/O Set Tab (Apply Options Dialog Box)


Sets options for applying a typical I/O set to items in the Electrical Index.
Enable typical I/O set Makes all the controls on this tab available. This check box is used for
security to prevent you from applying a typical I/O set in error.

Select typical I/O set


Clear last applied typical I/O set Clears the typical I/O set that you last applied. Select this
option if you do not want to apply any typical I/O set to the item.
Typical I/O set Displays the typical I/O set for the item. Click Find to navigate to the typical I/O
set that you want to select.
Apply to Enables you to select the rule that the software implements when associating the
typical I/O set. The options are:
All items Applies the typical I/O set to all the selected items.
Items with no typical I/O set Applies the typical I/O set only to items without an existing
typical I/O set. Use this option to add a typical I/O set only to new items among the items that
you selected.
Items with a different typical I/O set from the selection Changes the typical I/O set of
the selected items to the current typical I/O set. Use this option to add a typical I/O set to
items with a modified typical I/O set definition.

672

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Typical CBD Tab (Apply Options Dialog Box)


Sets options for applying a typical cable block diagram to plant loads.
You can select a number of loads in the Electrical Index and apply a typical CBD profile to these
loads. As a result of this operation, the software will do the following based on the definitions in the
selected typical CBD:
Create all the plant equipment as defined in the typical CBD.
Make all the associations among the new plant equipment as defined in the typical CBD.
Create plant cable block diagrams in which the selected plant load serves as a focal item. The
names of the new CBDs will be the same as the names of the loads to which you applied the
selected typical CBD.
The tab options are as follows:
Enable equipment profile Makes all the controls on this tab available.. This check box is
used for security to prevent you from applying a profile in error.
Typical cable block diagram Displays the name of the typical block diagram that you have
selected on the Find dialog box.
Find Opens the Find dialog box which allows you to find an appropriate typical cable block
diagram that will be applied to the selected loads.
Populate empty item properties Select the Populate empty item properties check box to
update only those item properties that contain null data. When you select this option, the
software does not overwrite the data that is not null.
Clear the check box to leave existing values of the item properties as they are, regardless of
whether they contain null or not null values.
The software does not apply a typical CBD to plant loads in the following cases and
logs the rejection reason in the Apply Typical CBD log file:
If the typical CBD does not contain any typical item that belongs to the same item type as the
electrical item to which you are applying the typical CBD.
If the typical CBD contains more than one typical item that belongs to the same item type as
the electrical item to which you are applying the typical CBD.
If the electrical item is not associated with a bus but the selected typical CBD contains a
reference bus circuit.
If the selected electrical item is already associated with other plant items.

When applying a typical CBD to motors with space heaters:


The software deletes the space heater from the plant and applies the typical CBD to the motor.
If the typical CBD contains a reference motor with a space heater, the software creates a new
plant space heater under the plant motor after applying the typical CBD.
If the plant space heater is associated with other items (for example, cables, control stations,
signals, terminal strips, and so on), the software does not apply the selected typical CBD to the
motor of the space heater and logs the rejection reason in the Apply Typical CBD log file.
When applying a typical CBD to loads that are associated with buses:
After applying a typical CBD, the software validates that the association has been retained.
If the association has been broken, the software searches for the root item in the electrical
branch where the load is connected. If the root item is not a circuit, the software attempts to
associate the root item with the bus in that electrical branch.
If the association of the root item with a bus is not possible, the software does not stop or
cancel the process of applying the selected typical CBD.

SmartPlant Electrical User's Guide

673

Windows and Dialog Boxes

Batch Load Association Dialog Box


Enables you to balance load flow of a particular bus and associate multiple loads with a power
distribution board (PDB) and a bus. Also, allows you to display the calculated consumption for
the entire power distribution board or a particular bus belonging to the selected power distribution
board. You can also assign a load to a particular phase or define a load as a three-phase load.
Power distribution board Allows you to select a power distribution board with which you
associate the loads.
Bus Allows you to select a specific bus to narrow down the load association.
Show Preferences Displays the preference settings for the calculation method for All Feeder
Load Summary Report and the settings for the inclusion of coupled buses in All Feeder Load
Summary Report.
Bus Tab (see "Bus Tab (Batch Load Association Dialog Box)" on page 674)
Loads Tab (see "Loads Tab (Batch Load Association Dialog Box)" on page 675)
Unassigned Loads Tab (see "Unassigned Loads Tab (Batch Load Association Dialog Box)" on
page 678)
Circuits Tab (see "Circuits Tab (Batch Load Association Dialog Box)" on page 679)
Cached Loads Tab (see "Cached Loads Tab (Batch Load Association Dialog Box)" on page 680)

Bus Tab (Batch Load Association Dialog Box)


Allows you to specify the rated data for a selected bus.
Power distribution board Allows you to select a power distribution board with which you
associate the loads.
Bus Allows you to select a specific bus to narrow down the load association.

Bus rated data


Line voltage Allows you to specify a voltage associated with the bus line.
Maximum line current Allows you to specify the maximum value of the line current.
Maximum active power Allows you to specify the maximum kW value for the selected bus.
Maximum reactive power Allows you to specify the maximum kVAr value for the selected bus.
Maximum apparent power Allows you to specify the maximum kVA value for the selected
bus.
Supply Displays the supply (AC or DC) of the selected bus. You define these values in the
Properties window of the current bus.
Number of phase Displays the phase number for the selected bus. (Applies to AC current
supply only.)
Overload percentage Allows you to specify the overload percentage on the maximum line
current. The line current determines the maximum allowed load on the bus. The overload
percentage can have a value between 0 and 100. For example, if you specify a maximum line
current of 100 A and an overload percentage value of 20, the software determines that the bus is
overloaded if the total calculated line current exceeds 120 A. You can view overload data for a
particular bus on the Total Bus Load Validation dialog box (on page 761).
Spare load percentage Allows you to specify a value between 0 and 100 for the spare
capacity on the bus for future expansion. The software uses this value to calculate the available
spare capacity of the bus.

674

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Required power factor Allows you to specify a power factor value that is required for the
current bus. When calculating the electrical consumption for this bus, the software also
calculates the power factor of a capacitor bank that is needed to correct the power factor of this
bus. For details, see Correcting Bus Power Factors Using Capacitor Banks (on page 247).

Loads Tab (Batch Load Association Dialog Box)


Enables you to balance the load flow of a particular bus and associate multiple loads with a power
distribution board (PDB) and a selected bus. Also, lets you display the calculated consumption
for a particular bus belonging to the selected power distribution board. You can also assign a
load to a particular phase or define a load as a three-phase load.
Power distribution board Specifies the power distribution board with which you associate the
loads.
Bus Allows you to select a specific bus to narrow down the load association.

Bus phases
The check boxes in this group box allow you to filter the display of loads in the Associated loads
data window according to their assigned phases. You define the bus phase labels in the bus
Properties window.
Phase 1 Filters the Associated loads list and displays only the loads that are associated with
phase 1.
Phase 2 Filters the Associated loads list and displays only the loads that are associated with
phase 2.
Phase 3 Filters the Associated loads list and displays only the loads that are associated with
phase 3.
All phases Displays all the loads disregarding their phase association.

Create circuits and cells


Create circuits Enables you to automatically create a feeder circuit for all the loads that are not
associated with circuits. This selection does not affect the associated loads that are already
associated with feeder circuits. The software creates a circuit based on the last applied typical
circuit. If no typical circuit is associated with the current load, the software creates a feeder circuit
without any circuit components.
Create cells Enables you to automatically create a cell where the software creates the feeder
circuits for the associated loads.

Associated loads
Displays the loads or converting electrical equipment that you added to be associated with the
current PDB and bus. Also, displays the loads or converting electrical equipment that you have
already associated with the selected power distribution board before opening this dialog
box. Note that the converting equipment associated with the current bus are shown in the
Associated loads grid if:
You have selected the Account for converting equipment power losses check box on the
Reports tab of the Preferences dialog box.
The converting equipment associated with the current bus has been defined as a load. (In this
case the associated converting equipment appears in the grid regardless of whether or not
you selected the Account for converting equipment power losses check box on the
Reports tab of the Preferences dialog box.)

SmartPlant Electrical User's Guide

675

Windows and Dialog Boxes


The following table summarizes the information presented in the Associated loads grid. For a
comprehensive summary of how the software presents the information on the Batch Load
Association dialog box, see the summary table at the bottom of the Associate Loads with a PDB
in Batch Mode (on page 205) procedure, above the notes.
Item Type

Associated Loads Grid

Loads connected directly to the Shown as non-compensated values.


selected bus.
Converting equipment

Shown when defined as loads and presented


as non-compensated values.

Converting equipment losses

When this preference is selected, the item


tag is shown without any values.

Local panels and junction


boxes

Shown when defined as loads and presented


as non-compensated values.

Cabinets and instruments

Shown as non-compensated values.

Feeder circuit that feeds a


downstream bus or converting
equipment.

Not applicable

Coupler circuit

Not applicable

This data window displays the key properties of the loads, including load type, consumed and
rated power, full load current, and details of their electrical connection hierarchy.
In the data window, you can assign a load to a particular phase or define it at as a multi-phase load
by selecting all three phases. Also, you can select a number of rows and move the selected loads
to cache. The moved loads then appear on the Cached Loads tab. Note that all of the values,
apart from phase assignment, in the Associated loads data window are read-only.
The software takes into account any existing equipment that is connected in
parallel.
Item Tag Displays the item tag of the selected load.
Type Displays the electrical equipment sub-class of the load, for example, motor, heater.
Consumed Active Displays the consumed kW of the selected load.
Consumed Reactive Displays the consumed kVar of the selected load.
Rated Active Displays the rated kW of the selected load.
Rated Reactive Displays the rated kVAr of the selected load.
Full Load Current Displays the full load current for the selected load.
Circuit Displays the circuit with which the load is associated.
Cell Displays the cell with which the selected load is associated.
Phase 1 Allows you to assign the selected load to phase 1.
Phase 2 Allows you to assign the selected load to phase 2.
Phase 3 Allows you to assign the selected load to phase 3.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes.
Move to Cache Unassigns the currently selected loads from its associated bus and moves
them to the Cached Loads tab for reassignment. You can select multiple rows as needed.

676

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Add Adds a load or converting electrical equipment to be associated with the selected power
distribution board.
Remove Cancels the association of the highlighted load or converting electrical equipment
from the PDB or bus. You cannot remove a load that is already connected to a circuit.
Add Selected Loads Adds the loads you selected in the list view pane of the Electrical
Index. These loads become associated with the current PDB after you click OK or Apply.

Calculated results (consumed values)


Displays the calculated consumed values for all the associated loads, such as motors, heaters,
converting electrical equipment (for example, a VFD) and so forth for a selected bus filtered
according to phase definition.
The following table summarizes the information presented in the Associated loads grid. For a
comprehensive summary of how the software presents the information on the Batch Load
Association dialog box, see the summary table at the bottom of the Associate Loads with a PDB
in Batch Mode (on page 205) procedure, above the notes.
Item Type

Calculated Results

Loads connected directly to Accounts for and shows consumed compensated


the selected bus.
values.
Converting equipment

Accounts for and shows consumed compensated


values.

Converting equipment
losses

Accounts for and shows non-compensated values.

Local panels and junction


boxes

Accounts for and shows consumed compensated


values.

Cabinets and instruments

Accounts for and shows consumed compensated


values.

Feeder circuit that feeds a


downstream bus or
converting equipment.

Accounts for and shows consumed compensated


values.

Coupler circuit

Accounts for and shows consumed compensated


values.

Electrical consumption using coincidence factors Displays calculated consumed values


using coincidence factors for either direct loads or all feeders.
Re-Calculate Re-calculates all the values based on the selections you made in the Power
distribution board and Bus lists. When selecting a PDB that contains a large downstream
electrical distribution system, it may take some time for the software to perform all the calculations
before it displays all the values. To avoid this situation, when opening the Batch Load
Association dialog box, the software displays the values that were stored in the database during
the last calculation. Clicking the Re-Calculate button allows you to re-calculate and refresh the
display the current calculation values.
For direct loads only Calculates the total consumed power only for those loads that are
connected directly to the current bus or through a feeder circuit. All other loads are considered
indirect loads including all types of converting equipment.
For all feeders Calculates the total consumed power for all the loads fed by the current bus as
well as the loads that are fed by the buses that are connected to the current bus (as specified in
Options Manager). When you select this option, the Circuits tab becomes available.

SmartPlant Electrical User's Guide

677

Windows and Dialog Boxes


Active [kW] Displays the calculated total consumed active (at the demand point) electrical
power for all the associated loads in kilowatts.
Reactive [kVAR] Displays the calculated total consumed reactive electrical power for all the
associated loads in kilovolt amperes reactive. When displaying the calculated consumed
reactive electrical power for all the associated loads in kilovolt amperes and associating a
capacitor, the software subtracts the rated kVAR value of that capacitor from the total connected
rated kVAR value. Therefore, the consumed electrical power (kVAR) may display a negative
value. This means that there is a lagging power factor.
Apparent [kVA] Displays the calculated total apparent consumed electrical power for all the
associated loads in kilovolt amperes.
Required capacitor correction [kVAR] Displays the calculated value for the power factor of
the capacitor that is needed to correct the bus power factor. For details, see Correcting Bus
Power Factors Using Capacitor Banks (on page 247).
Line current [A] Displays the calculated line current for the associated loads. The software
calculates this value based on the total running load.
Power factor Calculates the power factor by dividing the total rated active power (in kilowatts)
by the total apparent rated power (in kilovolt amperes). If there is a lagging power factor, this
value may be negative. The software calculates this value based on the total running load.
Notes Displays an appropriate message regarding the associated loads. For example,
Incomplete load data.
You can set a preference that instructs the software to account for transformer power
losses. For details, see Customize All Feeder Load Summary Report Preferences (on page 31).

Unassigned Loads Tab (Batch Load Association Dialog Box)


Allows you to associate unassigned loads that are associated with a PDB but have not yet been
associated with a bus.
Power distribution board Specifies the power distribution board with which you associate the
loads.
Bus Allows you to select a specific bus with which you want to associate the selected item tags.
Item Tag Displays the item tag for a load that has not been associated with a bus.
Type Displays the electrical equipment sub-class of the load, for example, motor, heater.
Select Selects the item tag to be assigned to the current bus.
Assign To Bus Associates the selected item tags with the current bus after clicking Apply.

678

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Circuits Tab (Batch Load Association Dialog Box)


Allows you to display all the circuits that are connected to the current bus and which feed other
buses.
The following table summarizes the information presented on the Circuits tab. For a
comprehensive summary of how the software presents the information on the Batch Load
Association dialog box, see the summary table at the bottom of the Associate Loads with a PDB
in Batch Mode (on page 205) procedure, above the notes.
Item Type

Circuits Tab

Loads connected directly Not applicable


to the selected bus.
Converting equipment

Shown only if the converting equipment is not


defined as a load.

Converting equipment
losses

Shown only if the converting equipment is not


defined as a load.

Local panels and


junction boxes

Not applicable

Cabinets and
instruments

Not applicable

Feeder circuit that feeds


a downstream bus or
converting equipment.

Shown if it feeds an incomer circuit or


converting equipment that is not defined as a
load.

Coupler circuit

Shown if it feeds a bus riser.

Power distribution board Specifies the power distribution board with which you associate the
loads.
Bus Allows you to select a specific bus with which you want to associate the selected item tags.
Item Tag Displays the item tag for the circuit connected to the current bus and which feeds
other circuits.
Description Displays the circuit description.
Circuit Type Displays the circuit type, for example: Feeder, Incomer.
Rated Active Power Displays the rated kW of the circuit.
Rated Reactive Power Displays the rated kVAr of the circuit.
Rated Apparent Power Displays the rated kVA of the circuit.

SmartPlant Electrical User's Guide

679

Windows and Dialog Boxes

Cached Loads Tab (Batch Load Association Dialog Box)


Displays a list of loads that you have unassigned from buses in order to reassign them to a
different bus for the purpose of load balancing.
Power distribution board Specifies the power distribution board with which you associate the
loads.
Bus Allows you to select a specific bus to which you want to re-associate the loads in the
cache.
Item Tag Displays the load item tag.
Type Displays the electrical equipment sub-class of the load, for example, motor, heater.
Consumed Active Displays the consumed active power consumption for the load.
Consumed Reactive Displays the consumed reactive power consumption for the load.
Rated Active Displays the rated active power consumption for the load.
Rated Reactive Displays the rated reactive power consumption for the load.
Full Load Current Displays the manufacturer's stated full load current for the load.
Assign To Bus Assigns the cached loads to the current bus.

Battery Bank Common Properties Dialog Box


Sets options for defining the general properties of a battery bank. Also, this dialog box defines
properties that the software uses for calculating electrical output and associating the battery bank
with the electrical supply.
General Tab (see "General Tab (Battery Bank Common Properties Dialog Box)" on page 680)
Electrical Data Tab (see "Electrical Data Tab (Battery Bank Common Properties Dialog Box)" on
page 681)
Controls and Signals Tab (see "Controls and Signals Tab (Battery Bank Common Properties
Dialog Box)" on page 682)
Instruments Tab (see "Instruments Tab (Battery Bank Common Properties Dialog Box)" on page
682)

General Tab (Battery Bank Common Properties Dialog Box)


Sets options for general properties that identify and characterize the battery bank. An asterisk
beside a property name indicates required data.
Item tag Identifies the battery bank. The tag is the name that appears beside the battery bank
in the Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you
must enter a string in this box. In the Electrical Index, the item tag matches the naming
convention for the battery bank. Click the ellipsis button
modify the item tag segments that are editable.

to open a dialog box where you can

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the battery bank, for information only.

680

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Manufacturer Allows you to select a manufacturer for the battery bank. You can define and
customize manufacturers in the Data Dictionary Manager.
Model Allows you to select a battery bank model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular battery bank.
Type Allows you to enter a description of the type of battery bank such as Lead-acid or
Nicad. The software uses this description in filters and reports. You can define and customize
types in the Data Dictionary Manager.
Last applied profile Indicates the last profile that you applied to the battery bank, if
appropriate. This information is read-only.
Last applied typical schematic Indicates the last typical schematic that you applied to the
battery bank, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the battery bank,
if appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the battery
bank. You can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
battery bank. You can define and customize mountings in the Data Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the battery bank.

Electrical Data Tab (Battery Bank Common Properties Dialog


Box)
Provides information about the battery bank properties based on the output power requirements.
Rated active power Shows the maximum quantity of electrical power, usually in kW, that the
battery bank is able to supply to the network.
Rated voltage Select the voltage which the battery bank is designed to supply. This quantity
usually appears on the battery bank nameplate. You can define and customize the available
rated voltages in the Data Dictionary Manager.
Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on the Electrical Data tab; the
calculated value overwrites any value that you previously entered manually. Selecting Manual
enables data entry in the Full load current box, with the last calculated full load current as the
starting value.
Full load current (FLA) The electrical current, in amperes, that the battery bank supplies when
operating at maximum power. The full load current usually appears on the nameplate of the
battery bank. You can select Calculated or Manual from the Override FLA calculation list to
determine whether the software calculates this value or whether you enter a value
manually. When the battery bank has an attached cable, the software copies this value to the
cable and uses it as a default value for sizing the cable.
Flooded seal Select whether the battery bank seal type is flooded or not flooded.
Number of cells Type the number of individual cells that make up the battery bank.

SmartPlant Electrical User's Guide

681

Windows and Dialog Boxes


Float voltage Allows you to select a battery float voltage from a standard set of values. The
float voltage is the voltage that has to be applied to the battery to maintain its charge level.

Controls and Signals Tab (Battery Bank Common Properties


Dialog Box)
Provides optional information for control stations that control the battery bank operation, and
controls and signals for the battery bank.

Associated control stations


Displays a list of control stations associated with the battery bank. This information is read-only
and appears if you associated a control station with the battery bank from the Control Station
Common Properties dialog box.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Describes all the I/O signals that are associated with the item where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be the battery bank, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.
I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
battery bank, if appropriate. This information is read-only and only appears if you apply a typical
I/O set by dragging it from the Reference Data Explorer or by applying options to the battery
bank.

Instruments Tab (Battery Bank Common Properties Dialog Box)


Displays instruments that monitor and control the operation of the battery bank.

Associated instruments
Displays a list of instruments associated with the battery bank. This information is read-only and
appears if you associated an instrument with the battery bank from the Instrument Properties
dialog box on the Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.

682

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

Converting Equipment Common Properties Dialog Box


Sets options for defining the general properties of converting equipment such as a
transformer. Also, this dialog box defines properties that the software uses for calculating
electrical loads and associating the equipment with the electrical supply.
General Tab (see "General Tab (Converting Equipment Common Properties Dialog Box)" on page
683)
Electrical Data Tab (see "Electrical Data Tab (Converting Equipment Common Properties Dialog
Box)" on page 684)
Controls and Signals Tab (see "Controls and Signals Tab (Converting Equipment Common
Properties Dialog Box)" on page 686)
Instruments Tab (see "Instruments Tab (Converting Equipment Common Properties Dialog Box)"
on page 687)
Feeder Data Tab (see "Feeder Data Tab (Converting Equipment Common Properties Dialog
Box)" on page 687)
Alternative Feeder Tab (see "Alternative Feeder Tab (Converting Equipment Common Properties
Dialog Box)" on page 689)

General Tab (Converting Equipment Common Properties Dialog


Box)
Sets options for general properties that identify and characterize the converting equipment. An
asterisk beside a property name indicates required data.
Consumer Allows you to define the current converting equipment item as a consumer. This
means that the software will include this item in load summary calculations, batch load
associations, and as enhanced all feeder summary reports. The software uses the electrical
power values that you enter for this item on the Electrical Data tab.
Also, you can use this property for filtering items that you want to appear in the Tabular Editor or in
reports. The software does not select this check box by default for converting equipment.
Item tag Identifies the item of equipment. The tag is the name that appears beside the item in
the Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you
must enter a string in this box. In the Electrical Index, the item tag matches the naming
convention for the item. Click the ellipsis button
the item tag segments that are editable.

to open a dialog box where you can modify

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the item, for information only.
Manufacturer Allows you to select a manufacturer for the converting equipment. You can
define and customize manufacturers in the Data Dictionary Manager.

SmartPlant Electrical User's Guide

683

Windows and Dialog Boxes


Model Allows you to select an item model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Process equipment Allows you to enter a description of the equipment that the converting
equipment affects or is associated with.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular load.
Converting equipment type Displays the electrical equipment sub-class of the converting
equipment, for example, transformer or UPS. The value is read-only. The software uses this
description in filters and reports.
Type Allows you to enter a description of the specific type of converting equipment indicated
under Converting equipment type. The software uses this description in filters and
reports. You can define and customize types in the Data Dictionary Manager.
Last applied profile Indicates the last profile that you applied to the equipment, if
appropriate. This information is read-only.
Last applied typical schematic Indicates the last typical schematic that you applied to the
equipment, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the equipment, if
appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the converting
equipment. You can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
type of equipment. You can define and customize mountings in the Data Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the item.

Electrical Data Tab (Converting Equipment Common Properties


Dialog Box)
Provides information about the converting equipment properties based on the output power
requirements.
Rated power Allows you to enter the desired maximum input power for the equipment. This
quantity usually appears on the equipment nameplate. You must enter a value with appropriate
units of measure for the standard that you are using. The units of measure depend on the type of
equipment. The software specifies the units of measure in the Data Dictionary Manager.
Rated voltage Select the input voltage at which the equipment is designed to operate. This
quantity ensures electrical compatibility between the electrical supply and the equipment. It
usually appears on the equipment nameplate.
Number of phases Select the number of phases in the power supply to the equipment. You
can select 1 or 3 phases. This property applies for an AC supply only. The value you select from
this list affects the phase arrangement in this tab folder and the phase association in the Feeder
Data tab folder.
Supply Select the type of supply: alternating current (AC) or direct current (DC).
Frequency (Hz) Select the operating frequency of the equipment. This property applies for an
AC supply only.

684

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on the Load Data tab; the
calculated value overwrites any value that you previously entered manually. Selecting Manual
enables data entry in the Full load current box, with the last calculated full load current as the
starting value.
Phase arrangement Select the desired value to determine which of the available phases are in
use for the current equipment, for example 3 PH + N (three phases plus neutral). This property
applies for an AC supply only and the values on this list that are available for selection depend on
the number of phases that you have selected.
Full load current (FLA) The electrical current, in amperes, that the equipment draws from the
supply when operating at maximum power. The full load current usually appears on the
equipment nameplate. You can select Calculated or Manual from the Override FLA
calculation list to determine whether the software calculates this value or whether you enter a
value manually.
Resistive losses Allows you to enter a value for the active power loss that is caused by the
resistance of the windings (copper losses). The software uses this value when taking into
account the converting equipment power losses when calculating batch load association and
generating an All Feeder Load Summary report. The software takes into account these losses if
you set your report preferences accordingly. (Click File > Preferences > Reports and then select
the Account for converting equipment power losses.)
Reactive losses Allows to enter a value for the reactive power loss that is caused by the
magnetic effects in the core (iron losses). The software uses this value when taking into account
the converting equipment power losses during batch load association and generating an All
Feeder Load Summary report. The software takes into account these losses if you set your report
preferences accordingly. (Click File > Preferences > Reports and then select the Account for
converting equipment power losses.)

Electrical power
Entering electrical power values allows you to include these values in the calculations of load
summaries, batch load associations, and when generating enhanced all feeder load summary
reports. When performing a drill-down calculation for a PDB that has a branch connected to a
bus through a consumer converting equipment item, the software accounts for the total of this
branch using the electrical power values of this converting equipment item. Note that the
software will use these values only if the current converting equipment has been defined as a
consumer. For details, see Define Converting Equipment as Consumers (on page 104).
Rated active load Allows you to enter an appropriate rated active load value.
Rated reactive load Allows you to enter an appropriate rated reactive load value.
Rated apparent load Displays the rated apparent load value calculated by the software.
Consumed active load Allows you to enter an appropriate consumed active load value.
Consumed reactive load Allows you to enter an appropriate consumed reactive load value.
Consumed apparent load Displays the consumed apparent load value calculated by the
software.

SmartPlant Electrical User's Guide

685

Windows and Dialog Boxes


Secondary output
This section provides information about the output from the equipment. When the converting
equipment is a transformer, the software displays the item tags for the secondary windings, as
well as appropriate information according to whether the transformer design has one or two sets of
secondary windings. Note that this section is available for all types of converting equipment apart
from limiting current reactors. The name of the secondary equipment appears after a slash in this
label.
Rated power Allows you to enter the desired maximum output power for the equipment.
For three-winding transformers, the rated power of each secondary winding can be
smaller or equal to the rated power of the primary winding. Both secondary windings can have
the same rated power value as long as the rated power value of neither secondary winding
exceeds the rated power value of the primary winding.
Nominal current Enter the output current for the converting equipment, including appropriate
units such as amperes. For a transformer, this is the current in the secondary windings.
Rated voltage Select the output voltage at which the equipment is designed to operate. This
quantity ensures electrical compatibility between the electrical supply and the equipment. It
usually appears on the equipment nameplate.

Current limiting reactors


This section enables you to define the reduction of the short- circuit power of networks or
installations to an acceptable value with regard to the short-circuit strength of the equipment or the
breaking capacity of the circuit breaker.
Insulation level Allows you to enter the rated voltage level for the insulation of the equipment.
Resistance Allows you to enter the resistive value of the current limiting reactor.
Reactance Allows you to enter the reactance values of the current limiting reactor.
Short circuit current [RMS] Allows you to enter the level of fault current (Root Mean Square).
Short circuit current [Peak] Allows you to enter the maximum level of the fault current.
Power factor Allows you to enter an appropriate power factor for the current limiting reactor.
Basic impulse level Allows you to define the maximum voltage level for the impulse test of the
current limiting reactor.

Controls and Signals Tab (Converting Equipment Common


Properties Dialog Box)
Provides optional information for control stations that control the equipment operation, and
controls and signals for the equipment.

Associated control stations


Displays a list of control stations associated with the equipment. This information is read-only
and appears either if you associated a control station with the equipment from the Control
Station Common Properties dialog box.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

686

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Associated I/O signals
Describes all the I/O signals that are associated with the item where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be the converting equipment, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.
I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
equipment, if appropriate. This information is read-only and only appears if you apply a typical I/O
set by dragging it from the Reference Data Explorer or by applying options to the equipment.

Instruments Tab (Converting Equipment Common Properties


Dialog Box)
Displays instruments that monitor and control the operation of the equipment.

Associated instruments
Displays a list of instruments associated with the equipment. This information is read-only and
appears if you associated an instrument with the equipment from the Instrument Properties
dialog box on the Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.
I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

Feeder Data Tab (Converting Equipment Common Properties


Dialog Box)
Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in items of equipment that belong to your
project. The values on this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

Location
Enables you to specify the location of the feeder for the converting equipment item. Also, you can
specify these settings by performing associations in the Electrical Engineer.

SmartPlant Electrical User's Guide

687

Windows and Dialog Boxes


Where the feeder source is an item of equipment other than a PDB, the source tag appears
in the Feeder equipment box and all the properties in this section are disabled.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the equipment, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the equipment is assigned. The values
in this list depend on the selected power distribution board. If you select a bus without specifying
a circuit, the software assigns the bus to the equipment, but you can change feeder data values
later if you need to.
Cell Allows you to specify and display the cell/bucket/compartment to which the equipment is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the equipment is assigned. If the
circuit resides in a particular cell, the values in this list depend on the selected cell. If the circuit is
linked directly to the bus, and is not linked to a cell, the values in the list depend on the selected
bus.
If you select a cell without selecting an existing circuit, the software automatically creates a
new circuit when you click Apply.
Create circuit Allows you to create a new feeder circuit in the bus to which the equipment is
assigned when you click Apply. The software automatically assigns the circuit name. When you
select this check box, the Create cell check box becomes active. Also, with the new circuit, if you
have specified a typical circuit for the equipment, the software assigns circuit components based
on that typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the equipment-bus association does not appear in the Electrical
Engineer. In this case, you can select the check box the next time you select this tab folder to
actually create the circuit.
Create cell Allows you to create a new cell in the bus to which the equipment is assigned. The
software automatically assigns the cell name.
Phase 1 Allows you to associate the current equipment with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 1
refers to the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current equipment with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 2
refers to the label L2 or S, as defined by the value of the Phase Label2 bus property.
Phase 3 Allows you to associate the current equipment with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 3
refers to the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes.
Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update the circuit components, you need to modify the selected circuit in the Electrical
Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.

688

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Feeder equipment
Where equipment other than a PDB circuit feeds the converting equipment, the software displays
the item tag of the feeding equipment in this box. For example, if the feeder equipment is a
generator, the generator tag is displayed.
Where a feeder equipment tag appears, the properties under the Location section are
disabled. Likewise, where the feeder source is a PDB, the source data appears under the
Location section and this property is disabled.

Last applied typical circuit


Indicates the last typical circuit that you applied to the converting equipment, if appropriate.
Tag Displays the tag of the last applied typical circuit.
Function Displays the function of the last applied typical circuit. For a converting equipment
item, this is always Feeder.

Alternative Feeder Tab (Converting Equipment Common


Properties Dialog Box)
Displays the location of an alternative feeder, if defined, in items of equipment that belong to your
project. You specify these settings by performing associations in the Electrical Engineer. All
properties on this tab are view-only.

Location
Power distribution board - Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the equipment is assigned, if defined.
Circuit Displays the circuit to which the equipment is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

Copy Driver Power Absorbed Dialog Box


This dialog box allows you to copy the power values for selected motors from the Driver Power
Absorbed property of the item of process equipment to the Brake Power property of the motor
with which it is associated. This functionality exists for process equipment and motors that have
been retrieved from SmartPlant P&ID.
Select Allows you to select the row for copying the values when you click Apply or OK.
Process Equipment Tag Identifies the process equipment item.
Description Displays the description of the process equipment item, if it exists.
PID Drawing Number Displays the PID drawing number of the process equipment item.
Driver Rated Power Displays the driver rated power of the process equipment item.
Driver Power Absorbed Displays the driver power absorbed of the process equipment
item. This is the property that is copied when you select the item.

SmartPlant Electrical User's Guide

689

Windows and Dialog Boxes


Electrical Equipment Tag Displays the tag of the electrical equipment, such as a motor, with
which the process equipment item is associated.
Motor Rated Power Displays the value of the motor rated power, if the process equipment
item is associated with a motor.
Brake Power Displays the current value of the brake power of the motor, before copying the
values.
Heater Rated Power Displays the value of the heater rated power, if the process equipment
item is associated with a heater.
Select all Selects all of the process equipment items for copying data.

Description Dialog Box


This dialog box allows you to enter a long text value in the Description text box in the Common
Properties dialog box for an item. For long descriptions, click the ellipsis button
the Description dialog box.
Description Allows you to enter a description for the item.

to bring up

Very long descriptions cannot be displayed in their entirety in labels, reports, and so forth.

Disconnect Electrical Equipment Common Properties Dialog


Box
Sets options for defining the general properties of disconnect electrical equipment.
Item tag Identifies the disconnect equipment. The item tag appears beside the disconnect
equipment in the Electrical Index. The item tag matches the naming convention for the
disconnect equipment. Click the ellipsis button
to open a dialog box where you can modify
the tag segments that are editable.
Type Displays the disconnect equipment type.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
equipment, if appropriate. This information is read-only and only appears if you apply a typical I/O
set by dragging it from the Reference Data Explorer or by applying options to the equipment.
Last applied typical schematic Indicates the last typical schematic that you applied to the
equipment, if appropriate. This information is read-only.
Last applied lookup table - Indicates the last lookup table that you applied to the equipment, if
appropriate. This information is read-only.

Associated control stations


Displays a list of control stations associated with the equipment. This information is read-only
and appears if you associated a control station with the load from the Control Station Common
Properties dialog box.
Item Tag Displays the tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Displays a list of all the I/O signals associated with the equipment. This information is read-only
and appears if you associated an I/O signal with the disconnect equipment.

690

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Item Tag Displays the tag for the associated I/O signal.
Equipment Type Displays the disconnect equipment type.
Description Displays the description for the I/O signal, if entered.
I/O Type Displays the I/O type defined for the signal, such as AO, AI, Fieldbus, and so forth.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.

Electrical Motor Common Properties Dialog Box


Sets options for defining the general properties of an electrical motor. Also, this dialog box
defines properties that the software uses for calculating loads and associating the motor with the
electrical supply.
General Tab (see "General Tab (Electrical Motor Common Properties Dialog Box)" on page 692)
Load Data Tab (see "Load Data Tab (Electrical Motor Common Properties Dialog Box)" on page
693)
Electrical Data Tab (see "Electrical Data Tab (Electrical Motor Common Properties Dialog Box)"
on page 696)
Controls and Signals Tab (see "Controls and Signals Tab (Electrical Motor Common Properties
Dialog Box)" on page 697)
Instruments Tab (see "Instruments Tab (Electrical Motor Common Properties Dialog Box)" on
page 698)
Feeder Data Tab (see "Feeder Data Tab (Electrical Motor Common Properties Dialog Box)" on
page 698)
Alternative Feeder Tab (see "Alternative Feeder Tab (Electrical Motor Common Properties Dialog
Box)" on page 700)

SmartPlant Electrical User's Guide

691

Windows and Dialog Boxes

General Tab (Electrical Motor Common Properties Dialog Box)


Sets options for general motor properties that identify and characterize the motor. An asterisk
beside a property name indicates required data.
Consumer You can use this property for filtering items that you want to appear in the Tabular
Editor or in reports. The software selects this check box by default when you create a new motor.
Item tag Identifies the motor. The tag is the name that appears beside the motor in the
Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you must
enter a string in this box. In the Electrical Index, the item tag matches the naming convention for
the motor. Click the ellipsis button
segments that are editable.

to open a dialog box where you can modify the item tag

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the motor, for information only. Click the
ellipsis button

to open a dialog box where you can type longer text for the description.

When typing the description in the dialog box, to begin a new line, press CTRL + ENTER.
Manufacturer Allows you to select a manufacturer for the motor. You can define and
customize manufacturers in the Data Dictionary Manager.
Model Allows you to select a motor model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Process equipment Allows you to enter a description of the equipment that the motor
drives. If the motor was retrieved from SmartPlant P&ID and included an association with an item
of process equipment, the software fills this property with the name of the process equipment.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular motor.
Conformity to standard Allows you to specify the standard for electrical calculations when
you associate a power cable with the motor. The standard affects the sizing calculation that the
software uses for an associated cable. The standard options defined in the Data Dictionary
Manager are:
National Electrical Code (NEC) The standard used in the US. When you select the NEC
standard, the software allows you to use the NEC lookup tables to automate population of
motor data in your project.
International Electrotechnical Commission (IEC) The standard used primarily in
Europe.
The conformity to standard also determines the available values of conductor size, frequency, and
rated voltage.
Motor design letter Allows you to select a design letter, which is a standard designation for
NEC motors. The design letter provides an indication of the values of various mechanical and
electrical characteristics of the motor.
Type Allows you to enter a description of the type of motor. The software uses this description
in filters and reports. You can define and customize types in the Data Dictionary Manager.

692

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Last applied profile Indicates the last profile that you applied to the motor, if appropriate. This
information is read- only.
Last applied typical schematic Indicates the last typical schematic that you applied to the
motor, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the motor, if
appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the motor. For
example, standards include Totally Enclosed Air Cooled (TEAC) and Totally Enclosed Fan
Cooled (TEFC). You can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
type of the load or machine. You can define and customize mountings in the Data Dictionary
Manager.
Process operational requirements Allows you to select the operational requirements of the
plant in which the motor is located. The following standard system options are available:
Emergency
Normal plant operation
Shutdown
Startup
You can define additional values for this list in the Data Dictionary Manager.
Frame size Provides a list of US standard values that define the physical and mechanical
properties and dimensions of the motor. You can define and customize frame sizes in the Data
Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the motor.

Load Data Tab (Electrical Motor Common Properties Dialog Box)


Provides information about the mechanical power and usage requirements of the motor. You can
find many of these quantities on the motor nameplate. An asterisk beside a property name
indicates required data.
Rated power Allows you to select a standard rated power value that represents the maximum
mechanical power that a motor shaft is required to supply. This quantity usually appears on the
motor nameplate. You can define and customize the rated power values in the Data Dictionary
Manager. The available rated power values can only have hp or kW as the units of measure.
Brake power Allows you to enter the minimum mechanical power required to make the motor
shaft rotate and drive the pump or process equipment attached to the motor. If you enter a value,
it cannot be greater than the value of the rated power and must have appropriate units of measure
for the standard that you are using: W, kW, MW, or hp. You can specify the default project units of
measure in the Data Dictionary Manager.
Minimum required power Allows you to enter a value that corresponds to a minimum power
requirement of the motor. This quantity is applicable if you are using the IEC (European)
standard. If you enter a value, it cannot be greater than the value of the rated power and must
have appropriate units of measure: W, kW, MW, or hp. You can specify the default project units
of measure in the Data Dictionary Manager.
Supply Select the type of supply: alternating current (AC) or direct current (DC).
Number of poles Select the number of poles for the motor. For example, you can select 2 or
4 poles. You can define and customize the available number of poles in the Data Dictionary
Manager.

SmartPlant Electrical User's Guide

693

Windows and Dialog Boxes


Rated voltage Select the voltage at which the motor is designed to operate. This quantity
usually appears on the motor nameplate. You can define and customize the available rated
voltages in the Data Dictionary Manager.
Particular power Allows you to enter the power requirement of the motor under a specific
operating point that the user specifies. This quantity is applicable if you are using the IEC
standard. If you enter a value, it cannot be greater than the value of the rated power and must
have appropriate units of measure: W, kW, MW, or hp. You can specify the default project units
of measure in the Data Dictionary Manager.
Number of phases Select the number of phases in the power supply to the motor. You can
select 1 or 3 phases. This property applies for an AC supply only. The value you select from this
list affects the phase arrangement in this tab folder and the phase association in the Feeder Data
tab folder.
Frequency (Hz) Select the operating frequency of the motor. You can define and customize
the available frequencies in the Data Dictionary Manager. This property applies for an AC supply
only.
Phase arrangement Select the desired value to determine which of the available phases are in
use for the current load, for example 3 PH + N (three phases plus neutral). This property applies
for an AC supply only and the values on this list that are available for selection depend on the
number of phases that you have selected.

Coincidence factors
Allows you to enter values corresponding to the percentage utilization of the motor for the selected
operating mode. Also known as duty factors. Type a value between 0 and 1 for the desired
mode. A value of 0 corresponds to an unused motor, while a value of 1 corresponds to
continuous operation.
Operating mode - Select the operating mode that describes how the motor is used in practice in
the plant. The standard available operating modes are:
Continuous
Intermittent
Standby
Spare
The coincidence factor corresponding to the selected operating mode provides a
quantitative measure of the motor behavior in that mode.
Operating factor Enter a value between 0 and 1 to represent the ratio of the load power
requirement to the rated power at an operating point that you specify. The software multiplies the
consumed electrical power by the operating factor to calculate average power usage.

694

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Demand factor Displays a calculated value that represents the ratio of the brake power to the
motor rated power. The software calculates the demand factor automatically using the values of
the brake power and the motor rated power that you specify on this dialog box tab. Alternatively,
you can type a demand factor value for the software to calculate the Brake power value. Demand
factor values affect the following properties of electrical motors:
Brake power
Power factor and efficiency at demand
Consumed electrical power

You can enter demand factor values only if it has been enabled in Data Dictionary
Manager.
For details about the various calculation modes, see Break Power / Demand Factor
Calculation (see "Brake Power / Demand Factor Calculation" on page 84).
LRC power factor Allows you to enter the value of the ratio of the active power to the apparent
power at locked rotor current (LRC). The LRC power factor can have a value between 0 and 1.
Number of wires Select the number of wires used to supply power to the motor.
Synchronous speed Displays the maximum theoretical rate of rotation of a machine shaft, in
revolutions per minute (rpm), assuming no energy losses due to the magnetic field, pole
architecture, and so forth.
Asynchronous speed Allows you to enter the actual rate of rotation of a motor shaft. If you
enter a value, it cannot be greater than the value of the synchronous speed.
Te stall time Allows you to enter the time that it takes the motor to come to rest after you switch
off the power.
Run-up time Allows you to enter the time that it takes the motor to reach its operating speed
after you switch on the power.

Power factor and efficiency


Enter the values under the conditions of 50%, 75%, and 100% of the rated power. The software
uses these values with the rated power and demand factor to calculate the power factor and
efficiency at the brake power.
Power factor Enter the ratio of active power to apparent power under the conditions of 50%,
75%, and 100% of the rated power. The power factor can have a value between 0 and 1.
Efficiency Enter the ratio of power output to power input under the conditions of 50%, 75%,
and 100% of the rated power. The efficiency can have a value between 0 and 1.
At demand The software calculates the power factor and efficiency at the brake power by
linear interpolation of the values you enter at 50%, 75%, and 100% of the rated power.

SmartPlant Electrical User's Guide

695

Windows and Dialog Boxes

Electrical Data Tab (Electrical Motor Common Properties Dialog


Box)
Provides information about the electrical motor properties based on the mechanical power
requirements. Note that the software makes non-compensated calculations.

Electrical power
The software calculates the electrical power based on load data for the motor. Note that these
calculations are non-compensated. (For details about non-compensated values, see Calculating
Bus Load Summaries (on page 214).) Note that the values are all read-only.
The software can perform the calculation at three operating points:
Rated Maximum power.
Consumed Normal operation at the motor brake power.
Particular An additional point that you can specify.
Active Shows the quantity of electrical power in kW drawn from the network and supplied to the
motor that is actually converted to mechanical work.
Reactive Shows the quantity of reactive power in kVAR that the motor draws from the network.
Apparent Shows the quantity of electrical power in kVA that represents the vector sum of the
active and reactive power. This quantity is the actual power that the network needs to generate.
Average Shows the average electrical power consumption for the motor. The software uses
the average electrical power consumption to calculate overall electrical load requirements. The
software calculates the average load by multiplying the consumed active electrical power by the
operating factor that you entered on the Load Data tab.

Full load current and locked rotor current data


Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. The following options are available:
Calculated The software calculates the full load current value based on values you enter
on the Load Data tab (rated power and rated voltage); the calculated value overwrites any
previous value. You can then type a value manually for the Locked rotor current or the LRC
to FLA ratio property; whichever one of these values you type, the software then calculates
the remaining value automatically.
Manual Enables data entry in the Full load current box. In this mode, you must first type
a value for the full load current. Next, you can type a value for the Locked rotor current or
the LRC to FLA ratio property; whichever one of these values you type, the software then
calculates the remaining value automatically.
Tables Enables you to use NEC or other lookup tables to apply values for the Full load
current and Locked rotor current properties (in this mode, these properties and the LRC to
FLA ratio property are read-only). With this option, you can select Use locked rotor
indicating code, in which case the software calculates a value for the Locked rotor current
property by using the maximum value for the specified indicating code letter. If you clear Use
locked rotor indicating code, the software applies a value from the lookup tables (if
applied). Note that to make this option available, you must first import the NEC lookup tables
into your plant (for details, see Import Reference Data in the Options Manager User's Guide)
and on the General tab, you must select NEC as the value for Conformity to standard.
Full load current (FLA) The electrical current, in amperes, that the motor draws from the
supply when operating at maximum power. The full load current usually appears on the motor
nameplate. You can modify the value of this property only when you select Manual from the

696

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Override FLA calculation list. Note that in the Calculated mode, the actual value calculated
depends on whether the motor is single- or 3-phase. When the motor has an attached cable, the
software copies this value to the cable and uses it as a default value for sizing the cable.
Locked rotor current (LRC) Shows the initial electrical current, in amperes or kilo amperes,
required to start rotation of the motor. The software calculates this value automatically when
values for the full load current and the LRC / FLA ratio already appear. Note that in Manual
mode, if you want to enter a value in this field manually so that the software can calculate the value
of the LRC / FLA ratio, you must first type a value for the Full load current property. When you
select Tables as the value of the Override FLA calculation property, you can select an indicating
code letter for the software to calculate a value. The software uses the following formula when
calculating locked rotor currents (kVA/hp):
MotorRatedPower*CodeIndicatingFactor*1000/ k*RatedVoltage
where k = SQRT(3) if there are 3 phases and 1 if there is one phase.
LRC to FLA ratio Shows the value of the ratio of locked rotor current to full load current,
usually shown on the motor nameplate. The software calculates this value automatically when
values for the full load current and the locked rotor current already appear. Note that in Manual
mode, if you want to enter a value in this field manually so that the software can calculate the value
of the locked rotor current, you must first type a value for the Full load current property.
Use locked rotor indicating code Select to enable the Indicating code letter (kVA / HP) list
and then select a code letter from the list. Some manufacturers indicate the code letter on the
motor nameplate. This option is only available when you select the Tables mode.
Indicating code letter (kVA / HP) Select the code that specifies the power requirement for the
motor with locked rotor, applicable if you are working with the NEC standard. Each code letter
represents a specified range of kilovolt- amperes per horsepower with locked rotor. The software
uses the highest value in the range to calculate the locked rotor current.

Controls and Signals Tab (Electrical Motor Common Properties


Dialog Box)
Provides optional information for control stations that control the motor operation, and controls
and signals for the motor.

Associated control stations


Displays a list of control stations associated with the motor. This information is read-only and
appears either if you associated a control station with the motor from the Control Station
Common Properties dialog box or if you applied a profile defined in the Reference Data
Explorer.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Describes all the I/O signals that are associated with the motor where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be the motor, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.

SmartPlant Electrical User's Guide

697

Windows and Dialog Boxes


I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
motor, if appropriate. This information is read-only and only appears if you apply a typical I/O set
by dragging it from the Reference Data Explorer or by applying options to the motor.

Controller
Provides controller details in the case where there is a device that controls the motor operation.
Type of controller Describes the controller mechanism. Examples of controller mechanisms
are solid- state relay (SSR), silicon controlled rectifier (SCR), and electronic.
Variable frequency drive Select this check box if the controller is a variable-frequency drive.

Restart options
Auto restart Select the desired option to indicate whether motor restart after a power outage is
automatic or manual.
Restart group Select the group of motors to which the motor belongs when restarting. After a
power outage, the motors restart in groups, rather than all together, to avoid overloading the
network.

Instruments Tab (Electrical Motor Common Properties Dialog


Box)
Displays instruments that monitor and control the motor operation.

Associated instruments
Displays a list of instruments associated with the motor. This information is read-only and
appears if you associated an instrument with the motor from the Instrument Properties dialog
box on the Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.
I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

Feeder Data Tab (Electrical Motor Common Properties Dialog


Box)
Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in motors that belong to your project. The values on
this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

698

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Location
Enables you to specify the location of the motor feeder. Also, you can specify these settings by
performing associations in the Electrical Engineer.
Where the feeder source is an item of equipment other than a PDB, the source tag
appears in the Feeder equipment box and all the properties in this section are disabled.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the motor, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the motor is assigned. The values in
this list depend on the selected power distribution board. If you select a bus without specifying a
circuit, the software assigns the bus to the motor, but you can change feeder data values later if
you need to.
Cell Allows you to specify and display a cell/bucket/ compartment to which the motor is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the motor is assigned. If the
circuit resides in a particular cell, the values in this list depend on the selected cell. If the circuit is
linked directly to the bus, and is not linked to a cell, the values in the list depend on the selected
bus.
If you select a cell without selecting an existing circuit, the software automatically
creates a new circuit when you click Apply.
Create circuit Allows you to create a new feeder circuit in the bus to which the motor is
assigned when you click Apply. The software automatically assigns the circuit name. When you
select this check box, the Create cell check box becomes active. Also, with the new circuit, if you
have specified a typical circuit for the motor, the software assigns circuit components based on
that typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the motor-bus association does not appear in the Electrical Engineer. In
this case, you can select the check box the next time you select this tab folder to actually
create the circuit.
Create cell Select to create a new cell in the bus to which the motor is assigned. The software
automatically assigns the cell name.
If you select both the Create cell and Create circuit check boxes, the software
creates a circuit directly under the cell in the Electrical Index.
Phase 1 Allows you to associate the current load with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 1 refers to
the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current load with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 2 refers to
the label L2 or S, as defined by the value of the Phase Label2 bus property.
Phase 3 Allows you to associate the current load with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 3 refers to
the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes.

SmartPlant Electrical User's Guide

699

Windows and Dialog Boxes


Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update and replace the circuit components, you need to re-apply a typical circuit to
the motor or modify the selected circuit in the Electrical Index. For more information, refer to
Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Feeder equipment
Where equipment other than a PDB circuit feeds the motor, the software displays the item tag of
the feeding equipment in this box. For example, if a Variable Frequency Drive (VFD) feeds the
motor, the VFD tag is displayed.
Where a feeder equipment tag appears, the properties under the Location section are
disabled. Likewise, where the feeder source is a PDB, the source data appears under the
Location section and this property is disabled.

Last applied typical circuit


Indicates the last typical circuit that you applied to the motor, if appropriate.
Tag Displays the tag of the last applied typical circuit.
Function Displays the function of the last applied typical circuit. For a motor, this property
appears as Feeder.

Alternative Feeder Tab (Electrical Motor Common Properties


Dialog Box)
Displays the location of an alternative motor feeder, if defined, in motors that belong to your
project. You specify these settings by performing associations in the Electrical Engineer. All
properties on this tab are view-only.

Location
Power distribution board Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the motor is assigned, if defined.
Circuit Displays the circuit to which the motor is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

700

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Generator Common Properties Dialog Box


Sets options for defining the general properties of a generator. Also, this dialog box defines
properties that the software uses for calculating electrical output and associating the generator
with the electrical supply.
General Tab (see "General Tab (Generator Common Properties Dialog Box)" on page 701)
Electrical Data Tab (see "Electrical Data Tab (Generator Common Properties Dialog Box)" on
page 703)
Controls and Signals Tab (see "Controls and Signals Tab (Generator Common Properties Dialog
Box)" on page 704)
Instruments Tab (see "Instruments Tab (Generator Common Properties Dialog Box)" on page
704)

General Tab (Generator Common Properties Dialog Box)


Sets options for general properties that identify and characterize the generator. An asterisk
beside a property name indicates required data.
Item tag Identifies the generator. The tag is the name that appears beside the generator in the
Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you must
enter a string in this box. In the Electrical Index, the item tag matches the naming convention for
the generator. Click the ellipsis button
tag segments that are editable.

to open a dialog box where you can modify the item

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the generator, for information only.
Manufacturer Allows you to select a manufacturer for the generator. You can define and
customize manufacturers in the Data Dictionary Manager.
Model Allows you to select a generator model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Process equipment Allows you to enter a description of the equipment that the generator
affects.
Exciter type Allows you to select the type of exciter used to establish the magnetic field in the
stator; for example, Fixed, Brushless, Static. The software uses this description in filters and
reports. You can define and customize exciter types in the Data Dictionary Manager.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular generator.
Type Allows you to enter a description of the type of generator; for example Turbo, Hydro,
Air-cooled. The software uses this description in filters and reports. You can define and
customize types in the Data Dictionary Manager.
Last applied profile Indicates the last profile that you applied to the generator, if
appropriate. This information is read-only.

SmartPlant Electrical User's Guide

701

Windows and Dialog Boxes


Last applied typical schematic Indicates the last typical schematic that you applied to the
generator, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the generator, if
appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the
generator. You can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
type of the generator. You can define and customize mountings in the Data Dictionary Manager.
Governor type Allows you to select the type of governor used to control the generator speed;
for example, Steam turbine, Gas turbine, Digital. The software uses this description in filters
and reports. You can define and customize governor types in the Data Dictionary Manager.
Frame size Provides a list of US standard values that define the physical and mechanical
properties and dimensions of the generator. You can define and customize frame sizes in the
Data Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the generator.

702

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Electrical Data Tab (Generator Common Properties Dialog Box)


Provides information about the load properties based on the output power requirements.
Rated apparent power Shows the quantity of electrical power in kVA that represents the
vector sum of the active and reactive power.
Power factor Enter the ratio of active power to apparent power at 100% of the rated power and
at the demand point. The power factor can have a value between 0 and 1.
Rated active power Shows the maximum quantity of electrical power in kW that the generator
needs to supply to the network.
Supply Select the type of supply that the generator produces: alternating current (AC) or direct
current (DC).
Number of phases Select the number of phases in the generator output. You can select 1 or
3 phases. This property applies for an AC supply only. The value you select from this list affects
the phase arrangement in this tab folder and the phase association in the Feeder Data tab folder.
Frequency (Hz) Select the operating frequency of the generator. You can define and
customize the available frequencies in the Data Dictionary Manager. This property applies for an
AC output only.
Rated voltage Select the voltage which the generator is designed to supply. This quantity
usually appears on the generator nameplate. You can define and customize the available rated
voltages in the Data Dictionary Manager.
Efficiency Enter the ratio of power output to power input under the conditions of 50%, 75%,
and 100% of the rated power. The efficiency can have a value between 0 and 1.
Neutral Earthing Allows you to select a child power cable or busway to create a neutral
earthing connection branch under the current generator in the Electrical Engineer. In an SLD,
the software will create an independent branch connected to a non-power connection point of the
generator. For more information, see Define a Neutral Earthing Connection for Generators (on
page 100).
Number of poles Select the number of poles for the generator. For example, you can select 2
or 4 poles. You can define and customize the available number of poles in the Data Dictionary
Manager.
Synchronous speed Displays the maximum theoretical rate of rotation of a machine shaft, in
revolutions per minute (rpm), assuming no energy losses due to the magnetic field, pole
architecture, and so forth.
Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on this tab; the calculated value
overwrites any value that you previously entered manually. Selecting Manual enables data entry
in the Full load current box, with the last calculated full load current as the starting value.
Full load current (FLA) The electrical current, in amperes, that the generator supplies when
operating at maximum power. The full load current usually appears on the nameplate of the
generator. You can select Calculated or Manual from the Override FLA calculation list to
determine whether the software calculates this value or whether you enter a value manually.
Control mode Allows you to select the generator control mode that determines how the
generator behaves under different load conditions; for example, Isochronous, Droop,
Isochronous/Droop. The software uses this description in filters and reports. You can define
and customize control modes in the Data Dictionary Manager.

SmartPlant Electrical User's Guide

703

Windows and Dialog Boxes

Controls and Signals Tab (Generator Common Properties Dialog


Box)
Provides optional information for control stations that control the generator operation, and controls
and signals for the generator.

Associated control stations


Displays a list of control stations associated with the generator. This information is read-only and
appears if you associated a control station with the generator from the Control Station Common
Properties dialog box.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Describes all the I/O signals that are associated with the item where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be the generator, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.
I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
generator, if appropriate. This information is read-only and only appears if you apply a typical I/O
set by dragging it from the Reference Data Explorer or by applying options to the generator.

Instruments Tab (Generator Common Properties Dialog Box)


Displays instruments that monitor and control the operation of the generator.

Associated instruments
Displays a list of instruments associated with the generator. This information is read-only and
appears if you associated an instrument with the generator from the Instrument Properties
dialog box on the Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.
I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

704

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Instrument Common Properties Dialog Box


Sets options for defining the general properties of instruments. Also, this dialog box defines
properties that the software uses for calculating electrical loads and associating the instrument
with the electrical supply.
General Tab (see "General Tab (Instrument Common Properties Dialog Box)" on page 705)
Electrical Data Tab (see "Electrical Data Tab (Instrument Common Properties Dialog Box)" on
page 706)
Associated Items Tab (see "Associated Items Tab (Instrument Common Properties Dialog Box)"
on page 707)
Instrument Data Tab (see "Instrument Data Tab (Instrument Common Properties Dialog Box)" on
page 708)
Feeder Data Tab (see "Feeder Data Tab (Instrument Common Properties Dialog Box)" on page
709)
Alternative Feeder Tab (see "Alternative Feeder Tab (Instrument Common Properties Dialog
Box)" on page 710)

General Tab (Instrument Common Properties Dialog Box)


Sets options for general properties that identify and characterize an instrument. An asterisk
beside a property name indicates required data.
Item tag Identifies the instrument. The tag is the name that appears beside the instrument in
the Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you
must enter a string in this box. In the Electrical Index, the item tag matches the naming
convention for the instrument. Click the ellipsis button
modify the item tag segments that are editable.

to open a dialog box where you can

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the instrument, for information only.
Manufacturer Allows you to select a manufacturer for the instrument. You can define and
customize manufacturers in the Data Dictionary Manager.
Model Allows you to select an instrument model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular instrument.
Type Allows you to select an instrument type such as I/P TRANSDUCER or D/P TYPE FLOW
TRANSMITTER. The available instrument types depend on the selected process function. The
software uses this value in filters and reports and when specifying data for import or export.
Process function Allows you to select a process function such as flow, level, relief valve, and
so forth.

SmartPlant Electrical User's Guide

705

Windows and Dialog Boxes


Criticality Allows you to select the desired instrument criticality, which is used for classifying
instruments for maintenance purposes. The software uses this value in filters and reports and
when specifying data for import or export.
System I/O type Allows you to select an instrument system I/O type such as AO (analog
output) or PI (pulse input).
Reference loop number Allows you to type the number of a control loop to which the
instrument belongs, if appropriate.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
instrument, if appropriate. This information is read-only and only appears if you apply a typical I/O
set by dragging it from the Reference Data Explorer to the instrument.
Notes Allows you to enter text, for example, if you want to provide additional information about
the instrument.

Electrical Data Tab (Instrument Common Properties Dialog Box)


Provides information about instrument properties and properties of the equipment associated with
the instrument.
Supply Select the type of supply that the instrument requires: alternating current (AC) or direct
current (DC).
Number of phases Select the number of phases for the instrument. You can select 1 or 3
phases. This property applies for an AC supply only. The value you select from this list affects
the phase arrangement in this tab folder and the phase association in the Feeder Data tab folder.
Frequency (Hz) Select the operating frequency of the instrument. You can define and
customize the available frequencies in the Data Dictionary Manager. This property applies for an
AC output only.
Instrument rated power Allows you to enter the power requirement for the instrument.
Power factor Enter the ratio of active power to apparent power at 100% of the rated power and
at the demand point for the associated equipment. The power factor can have a value between 0
and 1.
Rated voltage Select the voltage at which the instrument is designed to operate. This quantity
usually appears on the instrument nameplate. You can define and customize the available rated
voltages in the Data Dictionary Manager.
Rated active power Shows the quantity of electrical power in kW drawn from the network and
supplied to the associated equipment that is actually converted to output power.
Rated reactive power Shows the quantity of reactive power in kVAR that the associated
equipment draws from the network.
Rated apparent power Shows the quantity of electrical power in kVA that represents the
vector sum of the active and reactive power. This quantity is the actual power that the network
needs to generate for the associated equipment.
Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on this tab; the calculated value
overwrites any value that you previously entered manually. Selecting Manual enables data entry
in the Full load current box, with the last calculated full load current as the starting value.
Full load current (FLA) The electrical current, in amperes, that the instrument measures for
the associated equipment when operating at maximum power. You can select Calculated or
Manual from the Override FLA calculation list to determine whether the software calculates this
value or whether you enter a value manually. When the associated equipment has an attached
cable, the software copies this value to the cable and uses it as a default value for sizing the cable.

706

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Starting current The electrical current, in amperes, that the instrument measures for the
associated equipment when starting. When the instrument has an attached cable, the software
copies this value to the cable and uses it as a default value for sizing the cable.

Coincidence factors
Allows you to enter values corresponding to the percentage utilization of the associated
equipment for the selected operating mode. Also known as duty factors. Type a value between
0 and 1 for the desired mode. A value of 0 corresponds to an unused load, while a value of 1
corresponds to continuous operation.
Operating mode - Select the operating mode that describes how the associated equipment is
used in practice in the plant. The standard available operating modes are:
Continuous
Intermittent
Standby
Spare
The coincidence factor corresponding to the selected operating mode provides a
quantitative measure of the associated equipment behavior in that mode. You can customize the
available operating modes in the Data Dictionary Manager.

Associated Items Tab (Instrument Common Properties Dialog


Box)
Provides information for the equipment and cables that are associated with the instrument.
Associated equipment Displays the item of electrical equipment associated with the
instrument.
You can associate one electrical item only per instrument.
Find Opens the Find dialog box, which allows you to select an electrical item to associate with
the instrument.
Clear Allows you to clear the electrical item association to the instrument.

Associated cables
Displays the project cables that the software associates with the instrument.
(Data window) Describes the names and cable specifications of the associated cables.
Add Opens the Find dialog box, which allows you to select control, grounding, or
instrumentation cables to associate with the instrument.
You can associate more than one cable per instrument.
Remove Removes the selected associated cable from the instrument.

SmartPlant Electrical User's Guide

707

Windows and Dialog Boxes

Instrument Data Tab (Instrument Common Properties Dialog


Box)
Displays instrument data including switching properties and measurement ranges.
Output type The output types provides an indication of how the instrument output behaves in
response to the input. Output can be linear or square root, for example. The value you select is
informative only and does not affect any other data values. You can define and customize output
types in the Data Dictionary Manager.
Switch action Where the instrument includes a mechanical or an electronic switch, select an
option that describes how the switch behaves, for example, Energize to trip, Open on failure,
and so forth.
Solenoid supply Where the instrument includes a solenoid, select the type of supply to the
solenoid: alternating current (AC) or direct current (DC).
Solenoid voltage Where the instrument includes a solenoid, select the voltage at which the
solenoid is designed to operate. You can define and customize the available rated voltages in the
Data Dictionary Manager.
Solenoid action Where the instrument includes a solenoid, select an option that describes
how the solenoid behaves, for example, Energize to trip, Open on failure, and so forth.
Set point 1 value Allows you to type a value for a set point (input) at which the instrument
alarms or trips, if required, and select the appropriate units from the list.
Set point 2 value Allows you to type a value for a second set point (input) at which the
instrument alarms or trips, if required, and select the appropriate units from the list.
Set point 3 value Allows you to type a value for a third set point (input) at which the instrument
alarms or trips, if required, and select the appropriate units from the list.
Set point 4 value Allows you to type a value for a fourth set point (input) at which the
instrument alarms or trips, if required, and select the appropriate units from the list.
Lower range value Allows you to type a value for the lowest input that the instrument can
accept and select the appropriate units from the list.
Higher range value Allows you to type a value for the highest input that the instrument can
accept and select the appropriate units from the list.
Minimum output value Allows you to type a value for the lowest output that the instrument is
required to produce and select the appropriate units from the list.
Maximum output value Allows you to type a value for the highest output that the instrument is
required to produce and select the appropriate units from the list.
Display scale minimum Allows you to type a value for the minimum value that normally
appears on the instrument display and select the appropriate units from the list. This is usually
important for analog displays.
Display scale maximum Allows you to type a value for the maximum value that normally
appears on the instrument display and select the appropriate units from the list.

708

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Feeder Data Tab (Instrument Common Properties Dialog Box)


Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in instruments that belong to your project. The
values on this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

Location
Enables you to specify the location of the instrument feeder. Also, you can specify these settings
by performing associations in the Electrical Engineer.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the instrument, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the instrument is assigned. The values
in this list depend on the selected power distribution board. If you select a bus without specifying
a circuit, the software assigns the bus to the instrument, but you can change feeder data values
later if you need to.
Cell Allows you to specify and display a cell/bucket/ compartment to which the instrument is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the instrument is assigned. If the
circuit resides in a particular cell, the values in this list depend on the selected cell. If the circuit is
linked directly to the bus, and is not linked to a cell, the values in the list depend on the selected
bus.
If you select a cell without selecting an existing circuit, the software automatically creates a
new circuit when you click Apply.
Create circuit Select to create a new feeder circuit in the bus to which the instrument is
assigned when you click Apply. The software automatically assigns the circuit name. When you
select this check box, the Create cell check box becomes active. Also, with the new circuit, if you
have specified a typical circuit for the instrument, the software assigns circuit components based
on that typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the instrument-bus association does not appear in the Electrical
Engineer. In this case, you can select the check box the next time you select this tab folder to
actually create the circuit.
Create cell Select to create a new cell in the bus to which the instrument is assigned. The
software automatically assigns the cell name.
Phase 1 Allows you to associate the current instrument with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 1
refers to the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current instrument with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 2
refers to the label L2 or S, as defined by the value of the Phase Label2 bus property.
Phase 3 Allows you to associate the current instrument with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on

SmartPlant Electrical User's Guide

709

Windows and Dialog Boxes


the Electrical Data tab and applies only where the selected bus has an AC supply. Phase 3
refers to the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes to assign the instrument to two
phases.
Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update the circuit components, you need to modify the selected circuit in the Electrical
Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Alternative Feeder Tab (Instrument Common Properties Dialog


Box)
Displays the location of an alternative feeder, if defined, in instruments that belong to your
project. You specify these settings by performing associations in the Electrical Engineer. All
properties on this tab are view-only.

Location
Power distribution board - Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the instrument is assigned, if defined.
Circuit Displays the circuit to which the instrument is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

Item Tag Dialog Box


The item tag dialog box appears whenever you create, or duplicate an item in the Reference Data
Explorer or Electrical Index or whenever you duplicate an item.
In Common Properties dialog boxes, the Item Tag dialog box opens when you click the ellipsis
button
beside the Item tag text box.
Item tag Allows you to type text for the item tag, which can either be free text or a mask that fits
the item naming convention according to whether you invoke the use of the naming convention for
the item type. You define and activate the naming convention for the item type in Options
Manager.

710

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Metering Equipment Common Properties Dialog Box


Enables you to specify general and electrical data for equipment used to measure electrical
parameters.
General Tab (see "General Tab (Metering Equipment Common Properties Dialog Box)" on page
711)
Ranges Tab (see "Ranges Tab (Metering Equipment Common Properties Dialog Box)" on page
712)
Functions Tab (see "Functions Tab (Metering Equipment Common Properties Dialog Box)" on
page 713)

General Tab (Metering Equipment Common Properties Dialog


Box)
Sets options for general properties that identify and characterize the metering equipment. An
asterisk beside a property name indicates required data.
Item tag Identifies the metering equipment. The tag is the name that appears beside the
metering equipment in the Electrical Index. The item tag matches the naming convention for the
metering equipment. Click the ellipsis button
item tag segments that are editable.

to open a dialog box where you can modify the

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the metering equipment, for information only.
Manufacturer Allows you to select a manufacturer for the metering equipment. You can
define and customize manufacturers in the Data Dictionary Manager.
Model Allows you to select a metering equipment model. The available models are specific to
the manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Type Displays the type of metering equipment, such as Potential Transformer, Ammeter, or
Multimeter. The metering equipment type determines the electrical properties that appear on
this dialog box. This value is read-only.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular metering equipment item.
Design type Allows you to select a standard that specifies the construction of the metering
equipment. You can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
metering equipment. You can define and customize mountings in the Data Dictionary Manager.
Primary rating Enter the voltage applied on the primary winding. Applies to current
transformers and potential transformers only.
Secondary rating Enter the voltage output on the secondary winding. Applies to current
transformers and potential transformers only.

SmartPlant Electrical User's Guide

711

Windows and Dialog Boxes


Ratio The calculated ratio of the primary rating to the secondary rating. Applies to current
transformers and potential transformers only.
Connection type Allows you to specify whether a potential transformer is used to measure
voltages between two lines or between one line and ground.
Operating voltage Select a nominal operating voltage for a voltmeter.
Operating current Enter a nominal operating current for an ammeter, including units. Note
that the software does not validate this value against the minimum and maximum meter ranges.
Minimum meter range Enter the minimum voltage or current that the meter is designed to
measure, including units. Applies to ammeters and voltmeters only.
Maximum meter range Enter the maximum voltage or current that the meter is designed to
measure, including units. Applies to ammeters and voltmeters only.
Notes Allows you to enter text, for example, if you want to provide additional information about
the metering equipment.

Ranges Tab (Metering Equipment Common Properties Dialog


Box)
Allows you to set nominal operating values and ranges for specified properties of a multimeter.

Current
Select if using the meter to measure current values.
Operating current Allows you to enter a nominal operating current for the meter, including
units. Note that the software does not validate this value against the minimum and maximum
meter ranges.
Minimum meter range Allows you to enter the minimum current that the meter is designed to
measure, including units.
Maximum meter range Allows you to enter the maximum current that the meter is designed to
measure, including units.

Voltage
Select if using the meter to measure voltage values.
Operating voltage Allows you to select a nominal operating voltage for the meter.
Minimum meter range Allows you to enter the minimum voltage that the meter is designed to
measure, including units.
Maximum meter range Allows you to enter the maximum voltage that the meter is designed to
measure, including units.

Active power
Select if using the meter to measure active power values.
Operating power Allows you to enter a nominal operating value of active power for the meter,
including units. Note that the software does not validate this value against the minimum and
maximum meter ranges.
Minimum meter range Allows you to enter the minimum active power that the meter is
designed to measure, including units.
Maximum meter range Allows you to enter the maximum active power that the meter is
designed to measure, including units.

712

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Reactive power
Select if using the meter to measure reactive power values.
Operating power Allows you to enter a nominal operating value of reactive power for the
meter, including units. Note that the software does not validate this value against the minimum
and maximum meter ranges.
Minimum meter range Allows you to enter the minimum reactive power that the meter is
designed to measure, including units.
Maximum meter range Allows you to enter the maximum reactive power that the meter is
designed to measure, including units.

Frequency
Select if using the meter to measure frequency values.
Operating frequency Allows you to select a nominal operating frequency for the meter.
Minimum meter range Allows you to enter the minimum frequency that the meter is designed
to measure, including units.
Maximum meter range Allows you to enter the maximum frequency that the meter is designed
to measure, including units.

Power factor
Select if using the meter to measure power factor values.
Operating PF Allows you to type a nominal operating power factor value for the meter.
Minimum meter range Allows you to type the minimum power factor that the meter is
designed to measure.
Maximum meter range Allows you to type the maximum power factor that the meter is
designed to measure.

Functions Tab (Metering Equipment Common Properties Dialog


Box)
Allows you to specify functions for a protection relay.
Functions
Displays the relay functions according to the data based on the reference function that you select
with default or modified values as specified under Function details. You can sort the data
according to column names by clicking a column header.
To maintain a particular sequence of relay functions that you require, add a user-defined
field that can hold sequence numbers and then click the header of that column to sort the
data.
Add Adds another row and opens the Find dialog box which allows you to select a reference
function as a basis for the relay function you define.
Remove Removes the currently selected function.

Function details
After you select a reference function, this section allows you to modify the values. The software
retains any values that you modify for the specific protection relay.
Item Tag Displays the item tag of the reference item you selected on the Find dialog box. You
can click and type another item type name as needed.

SmartPlant Electrical User's Guide

713

Windows and Dialog Boxes


Type Select a function type from the list of available function types.
Code Type a relay function code value if you require.
Setting (%) Allows you to specify a value representing the percentage of the entire
measurement range at which the relay action takes place.
Setting Allows you to specify the absolute value of the measurement at which the relay action
takes place.
Relay action Select the action for the relay to perform at the specified setting value.
Time To Trip Allows you to specify an appropriate time to trip value.
Status Select an appropriate item tag status from the list.
In Data Dictionary, you can add user-defined properties for your protection relay functions.
For details, see the Data Dictionary documentation.

Other Electrical Equipment Common Properties Dialog Box


Sets options for defining the general properties of an item of equipment such as a lighting fixture or
a socket outlet. Also, this dialog box defines properties that the software uses for calculating
electrical loads and associating the item with the electrical supply.
General Tab (see "General Tab (Other Electrical Equipment Common Properties Dialog Box)" on
page 714)
Load Data Tab (see "Load Data Tab (Other Electrical Equipment Common Properties Dialog
Box)" on page 716)
Electrical Data Tab (see "Electrical Data Tab (Other Electrical Equipment Common Properties
Dialog Box)" on page 717)
Controls and Signals Tab (see "Controls and Signals Tab (Other Electrical Equipment Common
Properties Dialog Box)" on page 718)
Instruments Tab (see "Instruments Tab (Other Electrical Equipment Common Properties Dialog
Box)" on page 718)
Feeder Data Tab (see "Feeder Data Tab (Other Electrical Equipment Common Properties Dialog
Box)" on page 719)
Alternative Feeder Tab (see "Alternative Feeder Tab (Other Electrical Equipment Common
Properties Dialog Box)" on page 720)

General Tab (Other Electrical Equipment Common Properties


Dialog Box)
Sets options for general properties that identify and characterize the load. An asterisk beside a
property name indicates required data.
Consumer You can use this property for filtering items that you want to appear in the Tabular
Editor or in reports. The software selects this check box by default when you create a new item.
Item tag Identifies the load. The tag is the name that appears beside the load in the Electrical
Index or the Reference Data Explorer. In the Reference Data Explorer, you must enter a string
in this box. In the Electrical Index, the tag matches the naming convention for the load. Click
the ellipsis button
editable.

to open a dialog box where you can modify the item tag segments that are

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When

714

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the load, for information only.
Manufacturer Allows you to select a manufacturer for the load. You can define and customize
manufacturers in the Data Dictionary Manager.
Model Allows you to select a load model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Process equipment Allows you to enter a description of the equipment that the load affects.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular load.
Type Allows you to select one of the following electrical equipment sub-classes: Lighting
Fixture, Socket Outlet, Welding Outlet, or Special Electrical Equipment. When you select a
value, the software moves the item to the appropriate sub-folder of the Electrical Index. The
software uses this description in filters and reports.
Last applied profile Indicates the last profile that you applied to the load, if appropriate. This
information is read- only.
Last applied typical schematic Indicates the last typical schematic that you applied to the
load, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the load, if
appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the load. You
can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
type of the load or machine. You can define and customize mountings in the Data Dictionary
Manager.
Process operational requirements Allows you to select the operational requirements of the
plant in which the load is located. The following standard system options are available:
Emergency
Normal plant operation
Shutdown
Startup
You can define additional values for this list in the Data Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the load.

SmartPlant Electrical User's Guide

715

Windows and Dialog Boxes

Load Data Tab (Other Electrical Equipment Common Properties


Dialog Box)
Provides information about the mechanical power and usage requirements of the load. You can
find many of these quantities on the load nameplate. An asterisk beside a property name
indicates required data.
Rated power The nameplate power output of the load. You must enter a value with
appropriate units of measure for the standard that you are using. The units of measure depend
on the type of load. You can specify the default project units of measure in the Data Dictionary
Manager.
For harmonic filters and capacitors, the rated power units are VAR, kVAR, or mVAR.
Rated voltage Allows you to select the voltage at which the load is designed to operate. This
quantity ensures electrical compatibility between the electrical supply and the equipment. It
usually appears on the load nameplate. You can define and customize the available rated
voltages in the Data Dictionary Manager.
Demand factor Allows you to enter a value between 0 and 1 to represent the ratio of the load
power requirement at a specified operating point to the rated power. The demand factor
influences the consumed electrical power for the load.
The software can calculate the demand factor if you enter the required values for rated
power and absorbed power. Enter the required values and then click in the Demand factor
box to display the calculated value.
Absorbed power Allows you to enter the minimum electrical power required to operate the
static load. If you enter a value, it cannot be greater than the value of the rated power and must
have appropriate units of measure for the standard that you are using: W, kW, MW, or hp. You
can specify the default project units of measure in the Data Dictionary Manager.
The software can calculate the absorbed power if you enter the required values for the
rated power and demand factor. Enter the required values and then click in the Absorbed
power box to display the calculated value.
Supply Allows you to select the type of supply: alternating current (AC) or direct current (DC).
Number of phases Allows you to select the number of phases in the power supply to the
load. You can select 1 or 3 phases. This property applies for an AC supply only. The value you
select from this list affects the phase arrangement in this tab folder and the phase association in
the Feeder Data tab folder.
Phase arrangement Allows you to select the desired value to determine which of the available
phases are in use for the current load, for example 2 PH + N (two phases plus neutral). This
property applies for an AC supply only and the values on this list that are available for selection
depend on the number of phases that you have selected.
Frequency (Hz) Allows you to select the operating frequency of the load. This property
applies for an AC supply only. You can define and customize the available frequencies in the
Data Dictionary Manager.
Number of wires Allows you to select the number of wires used to supply power to the load.

Coincidence factors
Allows you to enter values corresponding to the percentage utilization of the load for the selected
operating mode. Also known as duty factors. Type a value between 0 and 1 for the desired
mode. A value of 0 corresponds to an unused load, while a value of 1 corresponds to continuous
operation.

716

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Operating mode Allows you to select the operating mode that describes how the load is used
in practice in the plant. The standard available operating modes are:
Continuous
Intermittent
Standby
Spare
The coincidence factor corresponding to the selected operating mode provides a
quantitative measure of the load behavior in that mode.

Power factor and efficiency


Enter the values under conditions of 100% of the rated power and at the demand point. The
software uses these values in the Load Summary Report.
Power factor Allows you to enter the ratio of active power to apparent power at 100% of the
rated power and at the demand point. The power factor can have a value between 0 and 1.
Power factor does not apply to harmonic filters and capacitors.
Efficiency Allows you to enter the ratio of power output to power input at 100% of the rated
power and at the demand point. The efficiency can have a value between 0 and 1.

Electrical Data Tab (Other Electrical Equipment Common


Properties Dialog Box)
Provides information about the load properties based on the output power requirements.

Electrical power
The software calculates the electrical power based on the load data. The values are all
read-only. The software can perform the calculation at two operating points:
Rated Maximum power.
Consumed Normal operation at the operating power.
Active Shows the quantity of electrical power in kW drawn from the network and supplied to the
load that is actually converted to output power.
Reactive Shows the quantity of reactive power in kVAR that the load draws from the network.
Apparent Shows the quantity of electrical power in kVA that represents the vector sum of the
active and reactive power. This quantity is the actual power that the network needs to generate.
Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on the Load Data tab; the
calculated value overwrites any value that you previously entered manually. Selecting Manual
enables data entry in the Full load current box, with the last calculated full load current as the
starting value.
Full load current (FLA) The electrical current, in amperes, that the load draws from the supply
when operating at maximum power. The full load current usually appears on the nameplate of the
load. You can select Calculated or Manual from the Override FLA calculation list to determine
whether the software calculates this value or whether you enter a value manually. When the load
has an attached cable, the software copies this value to the cable and uses it as a default value for
sizing the cable.

SmartPlant Electrical User's Guide

717

Windows and Dialog Boxes

Controls and Signals Tab (Other Electrical Equipment Common


Properties Dialog Box)
Provides optional information for control stations that control the load operation, and controls and
signals for the load.

Associated control stations


Displays a list of control stations associated with the load. This information is read-only and
appears either if you associated a control station with the load from the Control Station Common
Properties dialog box.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Describes all the I/O signals that are associated with the item where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be the electrical equipment, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.
I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
load, if appropriate. This information is read-only and only appears if you apply a typical I/O set
by dragging it from the Reference Data Explorer or by applying options to the load.

Instruments Tab (Other Electrical Equipment Common


Properties Dialog Box)
Displays instruments that monitor and control the operation of the equipment.

Associated instruments
Displays a list of instruments associated with the equipment. This information is read-only and
appears if you associated an instrument with the equipment from the Instrument Properties
dialog box on the Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.
I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

718

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Feeder Data Tab (Other Electrical Equipment Common


Properties Dialog Box)
Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in loads that belong to your project. The values on
this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

Location
Enables you to specify the location of the load feeder. Also, you can specify these settings by
performing associations in the Electrical Engineer.
Where the feeder source is an item of equipment other than a PDB, the source tag appears
in the Feeder equipment box and all the properties in this section are disabled.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the load, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the load is assigned. The values in this
list depend on the selected power distribution board. If you select a bus without specifying a
circuit, the software assigns the bus to the load, but you can change feeder data values later if you
need to.
Cell Allows you to specify and display a cell/bucket/ compartment to which the load is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the load is assigned. If the circuit
resides in a particular cell, the values in this list depend on the selected cell. If the circuit is linked
directly to the bus, and is not linked to a cell, the values in the list depend on the selected bus.
If you select a cell without selecting an existing circuit, the software automatically creates a
new circuit when you click Apply.
Create circuit Allows you to create a new feeder circuit in the bus to which the load is assigned
when you click Apply. The software automatically assigns the circuit name. When you select
this check box, the Create cell check box becomes active. Also, with the new circuit, if you have
specified a typical circuit for the load, the software assigns circuit components based on that
typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the load-bus association does not appear in the Electrical Engineer. In this
case, you can select the check box the next time you select this tab folder to actually create the
circuit.
Create cell Allows you to create a new cell in the bus to which the load is assigned. The
software automatically assigns the cell name.
Phase 1 Allows you to associate the current load with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 1 refers to
the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current load with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 2 refers to
the label L2 or S, as defined by the value of the Phase Label2 bus property.

SmartPlant Electrical User's Guide

719

Windows and Dialog Boxes


Phase 3 Allows you to associate the current load with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 3 refers to
the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes.
Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update the circuit components, you need to modify the selected circuit in the Electrical
Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Feeder equipment
Where equipment other than a PDB circuit feeds the load, the software displays the item tag of the
feeding equipment in this box. For example, if a transformer feeds the load, the transformer tag is
displayed.
Where a feeder equipment tag appears, the properties under the Location section are
disabled. Likewise, where the feeder source is a PDB, the source data appears under the
Location section and this property is disabled.

Last applied typical circuit


Indicates the last typical circuit that you applied to the load, if appropriate.
Tag Displays the tag of the last applied typical circuit.
Function Displays the function of the last applied typical circuit. For a load, this is always
Feeder.

Alternative Feeder Tab (Other Electrical Equipment Common


Properties Dialog Box)
Displays the location of an alternative load feeder, if defined, in loads that belong to your
project. You specify these settings by performing associations in the Electrical Engineer All
properties on this tab are view-only.

Location
Power distribution board - Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the load is assigned, if defined.
Circuit Displays the circuit to which the load is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

720

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Parallel Equipment Assistant Dialog Box


This dialog box allows you to define pairs of equipment items that can be connected in parallel.
You can then place these pairs on cable block diagrams and they will appear as connected in
parallel.
The definition of a parallel relationship between items is subject to certain rules. For
details, see Rules Governing Parallel Relations (on page 201).
To open this dialog box, click
on the Actions toolbar or click Actions > Manage Parallel
Equipment.
The dialog box options are as follows:

Show parallel equipment data


Enables you to filter the data that is displayed in the Parallel equipment definition section of the
dialog box.
Show all existing parallel pairs Shows all the existing parallel equipment items that have
been defined as pairs in the current plant.
Parallel pairs placed on the current cable block diagram only Shows only those paired
equipment items that have been placed on the current cable block diagram.
Parallel pairs not placed on any cable block diagram Shows only those paired equipment
items that have not been placed on any cable block diagram.

Parallel equipment definition


Enables you define equipment items as couples so that they can be connected in parallel. To
define two items as coupled or to replace one of the coupled items, select a row and then click
to find the equipment item that you require. You can then set the direction of the equipment
connection (In or Out). Note that the
Item 1 Clicking

and list arrow appear only after selecting a row.

allows you to select the first equipment item in the current couple.

Item 2 Clicking
allows you to select the second equipment item in the current couple.
Input/Output Allows you to select the connection direction of the equipment: In or Out. Note
that list arrow appears only after you select a particular line.
Add Appends a new empty row to the grid, after which you can click
to find an appropriate
equipment item.
Remove Removes the selected row from the grid and after clicking Apply or OK cancels the
coupling of the items.
The software saves the changes only after you click Apply or OK.

After completing the definition of the parallel pairs and opening a cable block diagram, all the
parallel pairs become available in the Parallel pairs list on the Modify Connector ribbon.
This ribbon becomes available after clicking a cable that has been placed on a cable block
diagram. For details, see Connect Equipment Items in Parallel (on page 202).

SmartPlant Electrical User's Guide

721

Windows and Dialog Boxes

In the Electrical Index and Electrical Engineer, a special indicator


equipment items that are connected in parallel.
For example
.

appears next to the

Static Load Common Properties Dialog Box


Sets options for defining the general properties of a static load such as a heater. Also, this dialog
box defines properties that the software uses for calculating electrical loads and associating the
item with the electrical supply.
General Tab (see "General Tab (Static Load Common Properties Dialog Box)" on page 722)
Load Data Tab (see "Load Data Tab (Static Load Common Properties Dialog Box)" on page 723)
Electrical Data Tab (see "Electrical Data Tab (Static Load Common Properties Dialog Box)" on
page 725)
Controls and Signals Tab (see "Controls and Signals Tab (Static Load Common Properties Dialog
Box)" on page 726)
Instruments Tab (see "Instruments Tab (Static Load Common Properties Dialog Box)" on page
726)
Feeder Data Tab (see "Feeder Data Tab (Static Load Common Properties Dialog Box)" on page
727)
Alternative Feeder Tab (see "Alternative Feeder Tab (Static Load Common Properties Dialog
Box)" on page 728)

General Tab (Static Load Common Properties Dialog Box)


Sets options for general properties that identify and characterize the load. An asterisk beside a
property name indicates required data.
Consumer You can use this property for filtering items that you want to appear in the Tabular
Editor or in reports. The software selects this check box by default when you create a new static
load.
Item tag Identifies the load. The tag is the name that appears beside the load in the Electrical
Index or the Reference Data Explorer. In the Reference Data Explorer, you must enter a string
in this box. In the Electrical Index, the item tag matches the naming convention for the
load. Click the ellipsis button
segments that are editable.

to open a dialog box where you can modify the item tag

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the load, for information only.
Manufacturer Allows you to select a manufacturer for the load. You can define and customize
manufacturers in the Data Dictionary Manager.
Model Allows you to select a load model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.

722

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Process equipment Allows you to enter a description of the equipment that the load affects. If
the load was retrieved from SmartPlant P&ID and included an association with an item of process
equipment, the software fills this property with the name of the process equipment.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular load.
Type Displays the electrical equipment sub-class of the load, for example, heater or harmonic
filter. The value is read-only. The software uses this description in filters and reports.
Last applied profile Indicates the last profile that you applied to the load, if appropriate. This
information is read- only.
Last applied typical schematic Indicates the last typical schematic that you applied to the
load, if appropriate. This information is read-only.
Last applied lookup table Indicates the last lookup table that you applied to the load, if
appropriate. This information is read-only.
Design type Allows you to select a standard that specifies the construction of the load. You
can define and customize design types in the Data Dictionary Manager.
Mounting Allows you to select a standard type of mounting as specified by the vendor for the
type of the load or machine. You can define and customize mountings in the Data Dictionary
Manager.
Process operational requirements Allows you to select the operational requirements of the
plant in which the load is located. The following standard system options are available:
Emergency
Normal plant operation
Shutdown
Startup
You can define additional values for this list in the Data Dictionary Manager.
Notes Allows you to enter text, for example, if you want to provide additional information about
the load.

Load Data Tab (Static Load Common Properties Dialog Box)


Provides information about the mechanical power and usage requirements of the load. You can
find many of these quantities on the load nameplate. An asterisk beside a property name
indicates required data.
Rated power The nameplate power output of the load. You must enter a value with
appropriate units of measure for the standard that you are using. The units of measure depend
on the type of load. You can specify the default project units of measure in the Data Dictionary
Manager. Note that for harmonic filters and capacitors, the rated power units are VAR, kVAR, or
mVAR.
Rated voltage Allows you to select the voltage at which the load is designed to operate. This
quantity ensures electrical compatibility between the electrical supply and the equipment. It
usually appears on the load nameplate. You can define and customize the available rated
voltages in the Data Dictionary Manager.
Demand factor Allows you to enter a value between 0 and 1 to represent the ratio of the load
power requirement at a specified operating point to the rated power. The demand factor
influences the consumed electrical power for the load.
The software can calculate the demand factor if you enter the required values for rated
power and absorbed power. Enter the required values and then click in the Demand factor
box to display the calculated value.

SmartPlant Electrical User's Guide

723

Windows and Dialog Boxes


Absorbed power Allows you to enter the minimum electrical power required to operate the
static load. If you enter a value, it cannot be greater than the value of the rated power and must
have appropriate units of measure for the standard that you are using: W, kW, MW, or hp. You
can specify the default project units of measure in the Data Dictionary Manager.
The software can calculate the absorbed power if you enter the required values for the
rated power and demand factor. Enter the required values and then click in the Absorbed
power box to display the calculated value.
Supply Allows you to select the type of supply: alternating current (AC) or direct current (DC).
Number of wires Allows you to select the number of wires used to supply power to the load.
Number of phases Allows you to select the number of phases in the power supply to the
load. You can select 1 or 3 phases. This property applies for an AC supply only. The value you
select from this list affects the phase arrangement in this tab folder and the phase association in
the Feeder Data tab folder.
Phase arrangement Allows you to select the desired value to determine which of the available
phases are in use for the current load, for example 2 PH + N (two phases plus neutral). This
property applies for an AC supply only and the values on this list that are available for selection
depend on the number of phases that you have selected.
Frequency (Hz) Allows you to select the operating frequency of the load. This property
applies for an AC supply only. You can define and customize the available frequencies in the
Data Dictionary Manager.

Coincidence factors
Allows you to enter values corresponding to the percentage utilization of the load for the selected
operating mode. Also known as duty factors. Type a value between 0 and 1 for the desired
mode. A value of 0 corresponds to an unused load, while a value of 1 corresponds to continuous
operation.
Operating mode Allows you to select the operating mode that describes how the load is used
in practice in the plant. The standard available operating modes are:
Continuous
Intermittent
Standby
Spare
The coincidence factor corresponding to the selected operating mode provides a
quantitative measure of the load behavior in that mode.

Neutral earthing data


(Available only for resistors.)
The values in group box relate to a resistor that is used as a neutral earthing resistor.
Resistance Allows you to select you to select a resistance value for the current resistor.
Reactance Allows you to select a reactance value for the current resistor.
Initial current Allows you to select an initial current value for the current resistor.
Line to neutral voltage Allows you to select a line to neutral voltage value for the current
resistor.
Allowable "time on" Allows you to select an allowable "time on" value for the current resistor.

724

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Power factor and efficiency
Enter the values under conditions of 100% of the rated power and at the demand point. The
software uses these values in the Load Summary Report.
Power factor Allows you to enter the ratio of active power to apparent power at 100% of the
rated power and at the demand point. The power factor can have a value between 0 and 1.
Power factor does not apply to harmonic filters and capacitors.
Efficiency Allows you to enter the ratio of power output to power input at 100% of the rated
power and at the demand point. The efficiency can have a value between 0 and 1.

Electrical Data Tab (Static Load Common Properties Dialog Box)


Provides information about the load properties based on the output power requirements.

Electrical power
The software calculates the electrical power based on the load data. Note that these calculations
are non-compensated. (For details about non-compensated values, see Calculating Bus Load
Summaries (on page 214).) Note that the values are all read-only.
The software can perform the calculation at two operating points:
Rated Maximum power.
Consumed Normal operation at the operating power.
Active Shows the quantity of electrical power in kW drawn from the network and supplied to the
load that is actually converted to output power.
Reactive Shows the quantity of reactive power in kVAR that the load draws from the network.
Apparent Shows the quantity of electrical power in kVA that represents the vector sum of the
active and reactive power. This quantity is the actual power that the network needs to generate.
For harmonic filters and capacitors, the active power is zero, therefore the reactive power
is equivalent to the apparent power.
Override FLA calculation Allows you to select the desired option to determine whether the
software uses a calculated or manually typed full load current value. If you select Calculated, the
software calculates the full load current value based on values you enter on the Load Data tab;
the calculated value overwrites any value that you previously entered manually. Selecting
Manual enables data entry in the Full load current box, with the last calculated full load current
as the starting value.
Full load current (FLA) The electrical current, in amperes, that the load draws from the supply
when operating at maximum power. The full load current usually appears on the nameplate of the
load. You can select Calculated or Manual from the Override FLA calculation list to determine
whether the software calculates this value or whether you enter a value manually. When the load
has an attached cable, the software copies this value to the cable and uses it as a default value for
sizing the cable.

SmartPlant Electrical User's Guide

725

Windows and Dialog Boxes

Controls and Signals Tab (Static Load Common Properties


Dialog Box)
Provides optional information for control stations that control the load operation, and controls and
signals for the load.

Associated control stations


Displays a list of control stations associated with the load. This information is read-only and
appears either if you associated a control station with the load from the Control Station Common
Properties dialog box or if you applied a profile defined in the Reference Data Explorer.
Item Tag Displays the control station tag for the associated control station.
Type Displays the reference control station when you create the associated project control
station by copying a reference control station from the Reference Data Explorer. For a control
station that you created in the Electrical Index, no value appears in this column.

Associated I/O signals


Describes all the I/O signals that are associated with the item where the signals need monitoring
or operation at the PLC / DCS.
Item Tag Displays the signal tag for the associated I/O signal.
Equipment Type Displays the equipment type of the item that the signal originates from, which
can be a heater, a capacitor, a harmonic filter, an associated circuit, or a control station.
Description Displays a description of the associated I/O signal.
I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
load, if appropriate. This information is read-only and only appears if you apply a typical I/O set
by dragging it from the Reference Data Explorer or by applying options to the load.

Instruments Tab (Static Load Common Properties Dialog Box)


Displays instruments that monitor and control the load operation.

Associated instruments
Displays a list of instruments associated with the load. This information is read-only and appears
if you associated an instrument with the load from the Instrument Properties dialog box on the
Associated Equipment tab.
Item Tag Displays the tag for the associated instrument.
Instrument Type Displays the reference instrument when you create the associated project
instrument by copying an instrument from the Reference Data Explorer. For an instrument that
you created in the Electrical Index, no value appears in this column.
Description Displays a description of the associated instrument.
I/O Type Displays the system I/O type for the instrument according to whether the signal is an
input or an output, and whether the signal type is analog or digital. This value appears if you
defined a system I/O type on the Instrument Properties dialog box.

726

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Feeder Data Tab (Static Load Common Properties Dialog Box)


Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in loads that belong to your project. The values on
this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

Location
Enables you to specify the location of the load feeder. Also, you can specify these settings by
performing associations in the Electrical Engineer.
Where the feeder source is an item of equipment other than a PDB, the source tag appears
in the Feeder equipment box and all the properties in this section are disabled.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the load, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the load is assigned. The values in this
list depend on the selected power distribution board. If you select a bus without specifying a
circuit, the software assigns the bus to the load, but you can change feeder data values later if you
need to.
Cell Allows you to specify and display a cell/bucket/ compartment to which the load is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the load is assigned. If the circuit
resides in a particular cell, the values in this list depend on the selected cell. If the circuit is linked
directly to the bus, and is not linked to a cell, the values in the list depend on the selected bus.
If you select a cell without selecting an existing circuit, the software automatically
creates a new circuit when you click Apply.
Create circuit Creates a new feeder circuit in the bus to which the load is assigned when you
click Apply. The software automatically assigns the circuit name. When you select this check
box, the Create cell check box becomes active. Also, with the new circuit, if you have specified a
typical circuit for the load, the software assigns circuit components based on that typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the load-bus association does not appear in the Electrical Engineer. In
this case, you can select the check box the next time you select this tab folder to actually
create the circuit.
Create cell Creates a new cell in the bus to which the load is assigned. The software
automatically assigns the cell name.
Phase 1 Allows you to associate the current load with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 1 refers to
the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current load with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 2 refers to
the label L2 or S, as defined by the value of the Phase Label2 bus property.

SmartPlant Electrical User's Guide

727

Windows and Dialog Boxes


Phase 3 Allows you to associate the current load with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 3 refers to
the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes.
Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update the circuit components, you need to modify the selected circuit in the
Electrical Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Feeder equipment
Where equipment other than a PDB circuit feeds the load, the software displays the item tag of the
feeding equipment in this box. For example, if a transformer feeds the load, the transformer tag is
displayed.
Where a feeder equipment tag appears, the properties under the Location section are
disabled. Likewise, where the feeder source is a PDB, the source data appears under the
Location section and this property is disabled.

Last applied typical circuit


Indicates the last typical circuit that you applied to the load, if appropriate.
Tag Displays the tag of the last applied typical circuit.
Function Displays the function of the last applied typical circuit. For a load, this is always
Feeder.

Alternative Feeder Tab (Static Load Common Properties Dialog


Box)
Displays the location of an alternative load feeder, if defined, in loads that belong to your
project. You specify these settings by performing associations in the Electrical Engineer. All
properties on this tab are view-only.

Location
Power distribution board Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the load is assigned, if defined.
Circuit Displays the circuit to which the load is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

728

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Transformer Connections and Tapping Dialog Box


Sets options for defining the types of connection (Delta, Wye, and so forth) and neutral grounding
for 3-phase transformers in your project. Also allows you to specify tapping arrangements on the
primary and secondary transformer windings for transformers with all types of feeds.
Primary Tab (see "Primary Tab (Transformer Connections and Tapping Dialog Box)" on page
729)
Secondary 1 / Secondary 2 Tab (see "Secondary Tab (Transformer Connections and Tapping
Dialog Box)" on page 730)

Primary Tab (Transformer Connections and Tapping Dialog Box)


Allows you to specify values for connections and tapping on the primary transformer winding.
Tag Identifies the transformer. The tag is the name that appears beside the item in the
Electrical Index. The tag matches the naming convention for the item. Click the ellipsis button
to open a dialog box where you can modify the tag segments that are editable.
Connection Allows you to select the type of connection for a 3-phase input.
Neutral grounding Allows you to specify whether to use neutral grounding. The following
standard options are available:
Ungrounded Does not require grounding.
Solid grounding Grounding is achieved by means of a cable connected directly to
ground.
Impedance Grounding is achieved by means of a cable connected to ground via a
resistor.
Grounding cable Allows you to specify a grounding cable when the Neutral grounding value
is Solid grounding or Impedance. Click the ellipsis button
to open the Find dialog box from
which you can select a suitable grounding cable. Note that for a cable to be available for use as a
grounding cable, its Neutral Earthing property must be set to True.
Grounding resistor Allows you to specify a resistor when the Neutral grounding value is
Impedance. You can use a grounding resistor with or without a grounding cable. Click the
ellipsis button
to open the Find dialog box from which you can select a suitable
resistor. You define resistors under Static Electrical Equipment in the Electrical Index. Note
that on the Find dialog box, the software retrieves all the existing resistors regardless of whether
they have or have not been associated with transformers. Make sure that you select an
appropriate resistor that has not been associated yet.

Tapping options
Tapping required Allows you to enable the tapping options.
Tapping Allows to select a tapping option. The options are for information only and do not
affect the ability to enter data values for the other properties in this section.
Tapping percentage per step Allows to type the percentage of the total winding length to be
used for each step interval for tapping.
Number of steps Allows to type the total number of tapping points required along the winding.
Total tapping percentage range The calculated value of the product of the tapping
percentage per step and the number of steps.

SmartPlant Electrical User's Guide

729

Windows and Dialog Boxes


Neutral Earthing Metering Equipment
Component Type Displays the Component Type.
Component Tag Displays the Component Tag number.
Order Shows the order of appearance of the metering equipment on your drawing, the lower
the number the closer to the winding.
Add Opens the Find dialog box and lists available PT/CT whose Neutral Earthing flag is
False.
Remove Removes the selected component.

Secondary Tab (Transformer Connections and Tapping Dialog


Box)
Allows you to specify values for connections and tapping on a secondary transformer winding.
Tag Identifies the transformer. The tag is the name that appears beside the item in the
Electrical Index. The tag matches the naming convention for the item. Click the ellipsis button
to open a dialog box where you can modify the tag segments that are editable.
Connection Allows you to select the type of connection for a 3-phase output.
Neutral grounding Allows you to specify whether to use neutral grounding. The following
standard options are available:
Ungrounded - Does not require grounding.
Solid grounding - Grounding is achieved by means of a cable connected directly to
ground.
Impedance - Grounding is achieved by means of a cable connected to ground via a
resistor.
Grounding cable Allows you to specify a grounding cable when the Neutral grounding value
is Solid grounding or Impedance. Click the ellipsis button
to open the Find dialog box from
which you can select a suitable grounding cable. Note that for a cable to be available for use as a
grounding cable, its Neutral Earthing property must be set to True.
Grounding resistor Allows you to specify a resistor when the Neutral grounding value is
Impedance. You can use a grounding resistor with or without a grounding cable. Click the
ellipsis button
to open the Find dialog box from which you can select a suitable
resistor. You define resistors under Static Electrical Equipment in the Electrical Index. Note
that on the Find dialog box, the software retrieves all the existing resistors regardless of whether
they have or have not been associated with transformers. Make sure that you select an
appropriate resistor that has not been associated yet.
Connection group Allows you to select a connection group from the list, for example Dy11,
Yy0. Note that the software does not validate the connection group value with respect to the
values of the other connection properties that you specify.
Phase shift (degrees) Allows you to type a value between 0 and 360 representing the phase
shift between this winding and the winding that feeds it.
Winding fed from Allows you to select an option to specify whether the primary winding or the
other secondary winding feeds the current winding (relevant to 3-winding transformers only).
Combined phase shift (degrees) allows you to type a value between 0 and 360 representing
the phase shift between this winding and the primary winding (relevant to 3-winding transformers
only).

730

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Tapping options
Tapping required Allows you to select this check box to enable the tapping options.
Tapping Allows you to select a tapping option. The options are for information only and do not
affect the ability to enter data values for the other properties in this section.
Tapping percentage per step Allows you to type the percentage of the total winding length to
be used for each step interval for tapping.
Number of steps Allows you to type the total number of tapping points required along the
winding.
Total tapping percentage range The calculated value of the product of the tapping
percentage per step and the number of steps.

Neutral Earthing Metering Equipment


Component Type Displays the Component Type.
Component Tag Displays the Component Tag number.
Order Shows the order of appearance of the metering equipment on your drawing, the lower
the number the closer to the winding.
Add Opens the Find dialog box and lists available PT/CT whose Neutral Earthing flag is
False.
Remove Removes the selected component.

External Documents
Associate Documents Dialog Box
Enables you to associate documents with selected electrical items. Also, you can open the
associated documents for editing, and you can dissociate a document if needed. An asterisk
beside a property name indicates required data.
The dialog box opens when you select an electrical item and then click Actions > Associate
Documents.
The options are as follows:

Filter by
Allows you to select a set of criteria to filter the documents that you associate with selected
electrical items.
Document category Filters the documents according to document category. This selection
determines the available options in the Document type list. You can define and customize
document categories in the Data Dictionary Manager.
Document type Filters the document category according to document type. This selection
determines the documents that the software retrieves after you click Find in the Edit group.
Selecting All types filters the documents according to category only. You can define and
customize document types in the Data Dictionary Manager.

List
Displays all the documents associated with the selected electrical items.
Add Opens the Find dialog box that allows you to find a document that you want to associate
with the current electrical item.

SmartPlant Electrical User's Guide

731

Windows and Dialog Boxes


Open Opens the document that you have selected under List. (Not available for internal
documents.)
Remove Removes the document that you have selected under List.

Properties
Displays the properties of a document that you select under List.
Document Displays the name of the selected document. The value for this property appears
after you click Find and select the document reference on the Find dialog box. The Find dialog
box retrieves all the existing document references and documents belonging to the selected
document category and type.
Document type Displays the type of the selected document.
Description Displays the description of a selected document.
Path and file name Displays the name and the file path of the selected external file.

Define Document Reference Dialog Box


Enables you to define a reference for an external document.

Filter by
Includes the set of criteria to filter the external documents that you associate with selected
electrical items.
Document category Filters the external documents according to document category. This
selection determines the external document references that the software retrieves after clicking
the ellipsis button
in the Edit group beside Path and file name. You can define and
customize document categories in the Data Dictionary Manager.
Document type Filters the external document category according to document type. This
selection determines the external documents that the software retrieves after clicking the ellipsis
button
in the Edit group beside Path and file name. Selecting All types causes the software
to filter the documents according to category only. You can define and customize document
categories in the Data Dictionary Manager.

List
Displays all the documents associated with the selected electrical items.
Open Opens the document that you have selected under List.
Remove Removes the document that you have selected under List.
Add Appends a new document row with information about a document you are about to
associate.

Properties
Allows you to edit the properties of a document that you select under List.
Document Allows you to type the name of the selected external document.
Document type Allows you to select the type of the selected external document.
Description Allows you to type the description of a selected external document.
Path and file name Displays the name and the file path of the selected external file. To
navigate to the file name and path, click the ellipsis button

732

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Interfaces
Retrieve Document Dialog Box
Source XML folder allows you to type the path to the source folder containing the .xml files
associated with the document that you want to retrieve, or click Browse to navigate to the desired
location.
Document Allows you to select from the list the document that you want to retrieve.
OK Retrieves the selected document and closes the dialog box.

Internal Documents and Revisions


Batch Compare Documents Dialog Box
Allows you to compare data for the current versions of multiple selected documents with the last
saved revision for each document.

Save options
Save files Saves the selected drawings as external files.
Path Allows you to type the file path or click Browse to navigate to the folder where you want to
save the drawings. The software automatically displays the default path that you have set for
your drawings in the Options Manager.
Save as type Allows you to select a file format for the drawings you want to save.
Print drawings Prints out all the drawings that you are comparing.
Print comparison reports Prints a comparison report for each selected document.

Compare Documents Dialog Box


Allows you to compare data for the current version of the selected document with the last saved
revision for that document.
Document number Displays the document name.
Description Displays the document description.
Revision method Displays the revision numbering method for the current document.

Revisions
Select a revision to compare with the current version.
Archived A check mark in this box indicates that the software archived a copy of the pertinent
document revision.
Revision Number Displays the revision number that complies with the selected revision
method. After clicking New, the software increments the last revision by one or use the next letter
in the alphabet. Also, the software allows you to type an appropriate revision number if you
choose not to accept the displayed value.
Revision Date The date when you made the revision.
Created by The name or the initials of the person who made the revision.

SmartPlant Electrical User's Guide

733

Windows and Dialog Boxes


Checked by The name or the initials of the person who checked the revision.
Approved by The name or the initials of the person who approved the revision.
Description Displays a description of the revision.
View Allows you to open a selected archived version of the document. The software opens
archived documents in view mode only.
Compare Compares the current version of the document with the selected revision.

Document Properties Dialog Box


Enables you to enter and manage the properties of a document. You can define the document
name, select an appropriate template, and type a description. On the Revisions tab, you can
enter and manage internal document revisions. On the Associated Items tab, you can associate
items for multi-item schematics. Note that if you open this dialog box without first opening a
pertinent document, all the dialog box options are in view mode only.
Document number Allows you to type the document name.
Template name (available only for SLDs, wiring diagrams, cable block diagrams, and PDB layout
drawings) Allows you to choose an appropriate template for your drawing.
Description Allows you to type the document description.
Scale factor (available only for PDB layout drawings) Allows you to enter a value that
determines the size ratio of the displayed items in the current drawing.

For multi-tag schematics only:


Multi-tag typical schematic Allows you to select a multi-tag typical schematic when you first
create a multi-tag schematic document. A multi-tag schematic is one that includes in its
definitions multi-tag blocks with header and list macros used to display the tag data. Once you
associate items with the document, the software displays this property in view mode only. Note
that this property is not available for single-tag schematics.

Display cable types in cable block diagrams


Allows you to choose the cable types to be displayed in your cable block diagram. You can
change the cable type at any time by opening the Properties dialog box and selecting or clearing
the relevant check boxes. Selecting a particular check box displays the cables of that type on
your cable block diagram. The available options are:
Power
Instrumentation
Control
Grounding
Display only cables connecting two items visible on the drawing Select to display only
those cables that connect between two items that are actually visible on the drawing. If only
one of the items is visible, the cable is not displayed. This option applies only to the cable
types that you choose to display. Clear this check box to display all cables of the selected
types.

For cable block diagrams only:


Focal item Allows you to define a focal item for a cable block diagram. A focal item is a plant
item which is associated with a specific cable block diagram. An item can be associated with more
than one CBD.

734

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Find Opens the Find dialog box that allows you to select an appropriate item that will function
as the focal item.
Clear Allows you to dissociate the focal item from the current CBD.

For registered reports only:


Report item type Displays the main item that the selected report template represents.
Document main item type For certain report item types only, allows you to select an item type
related to the document, for example, where the report item type is Electrical Equipment, you
can select from this list Cable, Converting Equipment, Motor, and so forth. The value that you
select is for information purposes only.
Revisions Tab (see "Revisions Tab (Document Properties Dialog Box)" on page 735)
Associated Items Tab (see "Associated Items Tab (Document Properties Dialog Box)" on page
737)

Revisions Tab (Document Properties Dialog Box)


Enables you to enter and manage internal document revisions. Note that if you open this dialog
box without first opening a pertinent document, all the dialog box options are in view mode only.
Document number Allows you to type the document name.
Template name (available only for SLDs, wiring diagrams, cable block diagrams, and PDB layout
drawings) Allows you to choose an appropriate template for your drawing.
Description Allows you to type the document description.
Scale factor (available only for PDB layout drawings) Allows you to enter a value that
determines the size ratio of the displayed items in the current drawing.

For multi-tag schematics only:


Multi-tag typical schematic Allows you to select a multi-tag typical schematic when you first
create a multi-tag schematic document. A multi-tag schematic is one that includes in its
definitions multi-tag blocks with header and list macros used to display the tag data. Once you
associate items with the document, the software displays this property in view mode only. Note
that this property is not available for single-tag schematics.

Display cable types in cable block diagrams


Allows you to choose the cable types to be displayed in your cable block diagram. You can
change the cable type at any time by opening the Properties dialog box and selecting or clearing
the relevant check boxes. Selecting a particular check box displays the cables of that type on
your cable block diagram. The available options are:
Power
Instrumentation
Control
Grounding
Display only cables connecting two items visible on the drawing Select to display only
those cables that connect between two items that are actually visible on the drawing. If only
one of the items is visible, the cable is not displayed. This option applies only to the cable
types that you choose to display. Clear this check box to display all cables of the selected
types.

SmartPlant Electrical User's Guide

735

Windows and Dialog Boxes


For cable block diagrams only:
Focal item Allows you to define a focal item for a cable block diagram. A focal item is a plant
item which is associated with a specific cable block diagram. An item can be associated with more
than one CBD.
Find Opens the Find dialog box that allows you to select an appropriate item that will function
as the focal item.
Clear Allows you to dissociate the focal item from the current CBD.

For registered reports only:


Report item type Displays the main item that the selected report template represents.
Document main item type For certain report item types only, allows you to select an item type
related to the document, for example, where the report item type is Electrical Equipment, you
can select from this list Cable, Converting Equipment, Motor, and so forth. The value that you
select is for information purposes only.
Revision method Allows you to select a revision numbering method for the current
document. The selected method affects the value displayed under Revision Number after you
click New. If you change the revision method for a document with existing revisions, the software
starts a new numbering the next time you add a revision. Note that if you select Other, the
software does not display a revision number after clicking New.

Revisions
Archived A check mark in this box indicates that the software archived a copy of the pertinent
document revision.
Revision Number Displays the revision number that complies with the selected revision
method. After clicking New, the software increments the last revision by one or use the next letter
in the alphabet. Also, the software allows you to type an appropriate revision number if you
choose not to accept the displayed value.

If you type a value that does not comply with the current revision method, the next time you
add a new revision, the software starts a new numbering. For example, the selected revision
method is P0, P1, P2 and the last revision is P3. If you add a new revision number RRR and
then another one using the P0, P1, P2 method, the software displays the newly added revision
as P0.
If you type a value that complies with the numbering method but the value you is not
sequential, the software increments the number of the next revision that you add. For
example, the selected revision method is P0, P1, P2 and the last revision is P3. If you add a
new revision number P1, the software increments the following revision to P2.
Revision Date The date and time of the revision.
Created by The name or the initials of the person who made the revision.
Checked by The name or the initials of the person who checked the revision.
Approved by The name or the initials of the person who approved the revision.
Description Allows you to type a brief revision description.
Revision Name The name of the revision or other identifying text. You can overwrite this text
if desired.
View Allows you to open a selected archived version of the document. The software opens
archived documents in view mode only.

736

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Using the Data Dictionary Manager, it is possible to determine which fields are available on
the Revisions tab. To hide a specific field, set the Display to User property in the Data Dictionary
to No. For details, see Modify Properties of Database Tables in the Data Dictionary User's
Guide.

Associated Items Tab (Document Properties Dialog Box)


Enables you to associate items for multi-tag schematics.
Document number Allows you to type the document name.
Template name (available only for SLDs, wiring diagrams, cable block diagrams, and PDB layout
drawings) Allows you to choose an appropriate template for your drawing.
Description Allows you to type the document description.
Scale factor (available only for PDB layout drawings) Allows you to enter a value that
determines the size ratio of the displayed items in the current drawing.

For multi-tag schematics only:


Multi-tag typical schematic Allows you to select a multi-tag typical schematic when you first
create a multi-tag schematic document. A multi-tag schematic is one that includes in its
definitions multi-tag blocks with header and list macros used to display the tag data. Once you
associate items with the document, the software displays this property in view mode only. Note
that this property is not available for single-tag schematics.

Display cable types in cable block diagrams


Allows you to choose the cable types to be displayed in your cable block diagram. You can
change the cable type at any time by opening the Properties dialog box and selecting or clearing
the relevant check boxes. Selecting a particular check box displays the cables of that type on
your cable block diagram. The available options are:
Power
Instrumentation
Control
Grounding
Display only cables connecting two items visible on the drawing Select to display only
those cables that connect between two items that are actually visible on the drawing. If only
one of the items is visible, the cable is not displayed. This option applies only to the cable
types that you choose to display. Clear this check box to display all cables of the selected
types.

For cable block diagrams only:


Focal item Allows you to define a focal item for a cable block diagram. A focal item is a plant
item which is associated with a specific cable block diagram. An item can be associated with more
than one CBD.
Find Opens the Find dialog box that allows you to select an appropriate item that will function
as the focal item.
Clear Allows you to dissociate the focal item from the current CBD.

For registered reports only:


Report item type Displays the main item that the selected report template represents.

SmartPlant Electrical User's Guide

737

Windows and Dialog Boxes


Document main item type For certain report item types only, allows you to select an item type
related to the document, for example, where the report item type is Electrical Equipment, you
can select from this list Cable, Converting Equipment, Motor, and so forth. The value that you
select is for information purposes only.

Associated Items (available for multi-tag schematics only)


Item type Allows you to select an item type for the electrical items that you want to associate
with the current multi-item schematic:
Selecting the Bus item type enables you to generate a multi-tag schematic that includes all the
circuits that are connected to the bus selected from the list on the right.
Selecting any other item type apart from Bus, enables you to associate only those items that
belong to the selected item type. You can associate the required items by clicking Associate.
Power Distribution Board (available only if you selected Bus from the Item type list) Allows
you to select an appropriate PDB that has the bus which you want to associate with the current
multi-item schematic.
Bus (available only if you selected Bus from the Item type list) Allows you to select an
appropriate bus which you want to associate with the current multi-item schematic.
Associated Items Displays the list of items of a particular item type that are associated with
the document. If you selected Bus in the Item type list, the associated items are the circuits that
belong to the selected bus.
Associate (available only if you did not select Bus from the Item type list) Opens the Find
dialog box to allow you to associate with the document items of a particular item type.
Dissociate (not available if you selected Bus from the Item type list) Dissociates the selected
item from the document. You can only dissociate items individually.
Sort by Enables you to sort the associated items. Note that this setting determines the sorting
of items in the table that appears in the generated multi-tag schematic.
Item tag Sorts the associated items according to their item tag names.
Sequence in group (available only if the associated items are circuits) Sorts the
associated circuits according to their sequence in group values.

738

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

File Properties Dialog Box


Tracks information about the properties of a drawing. Open this dialog box by clicking File >
Properties on the main menu bar.
General Tab (see "General Tab (File Properties Dialog Box)" on page 739)
Summary Tab (see "Summary Tab (File Properties Dialog Box)" on page 739)
Statistics Tab (see "Statistics Tab (File Properties Dialog Box)" on page 740)
Units Tab (see "Units Tab (File Properties Dialog Box)" on page 740)
You must save the drawing before you can access the Statistics and Summary tabs of
the File Properties dialog box.

General Tab (File Properties Dialog Box)


Displays general information about the current document.
Type Displays the type of document. The type is based on the application used to create the
document.
Location Displays the directory containing the document.
Size Displays the size of the document in bytes, kilobytes, and megabytes.
MS-DOS Name Displays the name of the document as it would appear in a Windows file
naming system.
Created Displays the date and time that the document was created or copied.
Modified Displays the date and time that the document was last modified.
Accessed Displays the date that the document was last opened or copied.
Attributes Displays the properties of the current document. These settings are read-only.
Read-Only Indicates that the document is read-only. You cannot open a read-only file for
writing. You cannot create a file with the same name as a read-only file.
Archive Shows that the document is an archive document.
Hidden Indicates that the document is a hidden document. You usually cannot see this
document in the Windows.
System Shows that the document is a system document. You usually cannot see this
document unless you change the view options in Windows Explorer.
If some of the above information is not available, the dialog box displays Unknown.

Summary Tab (File Properties Dialog Box)


Displays the title and author, if available, along with keywords and comments for the current
document. The software generates the author and template information when you create, save, or
print the document. You can edit these properties, with the exception of the template, unless the
document is write-protected.
Title Specifies the title of the current document.
Subject Gives a general description of the current document.
Author Displays the name of the person who created the document.
Keywords Displays a list of words that identify the document when you browse or search
documents.
Comments Specifies comments about the current document.
Template Specifies the current drawing template.

SmartPlant Electrical User's Guide

739

Windows and Dialog Boxes

Statistics Tab (File Properties Dialog Box)


Displays detailed information about the current document. The software automatically generates
these properties when you create, save, or print the document.
Created Displays the date and time the document was created or copied.
Creating Application Displays the name of the application that created the document.
Modified Displays the date and time the document was last modified.
Accessed Displays the date that the document was last opened or copied.
Last Saved By Displays the name of the person who last saved the document.
Saving Application Displays the name of the application that most recently saved the
document.
Currently Opened By Displays the name of the person who has the document open.

Units Tab (File Properties Dialog Box)


Sets up units of measure and precision readout for the length, area, or angle values in a drawing.
The precision readout sets the number of significant figures to appear. It represents the accuracy
of the unit readout value. The precision setting does not alter the numbers that you type into a
property, only the display of the numbers. Values ending in 5 are rounded up. For example, if the
precision readout is .123 and you draw a line that is 2.1056 inches long, then the line value length
is rounded up to 2.106 inches.
Length Readout Sets the unit of measure and precision readout for the length values in a
document.
Angle Readout Sets the unit of measure and precision readout for the angle values in a
document.
Area Readout Sets the unit of measure and precision readout for the area values in a
document.

740

To avoid loss of precision in units when switching between small and large types of a particular
unit, increase the precision, that is, increase decimal places, of the larger unit through Format
Manager.
All delivered labels use plant default units, which are defined in the Options Manager, and so
labels do not always display the units selected in the Properties window. Change the Unit
definition in the SmartText Editor dialog box in Catalog Manager to see a different unit of
measure in a label.
The software supports round-trip conversion of units without loss of precision. That is, you can
convert centimeters to meters and back and retain the originally entered value of centimeters
with no round-off loss.

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Browser Tab (File Properties Dialog Box)


Sets the home address for the active document. Every time you open this document and click
Home on the Symbol Explorer, the Symbol Explorer goes to the address in the Address box.
Address Sets the home address for the current document. When you open a document and
then open the Symbol Explorer and click Home
, the Symbol Explorer goes to the address
that you type here. You can any address that you use in a web browser, such as Microsoft Internet
Explorer; for example, you can type http://www.smartsketch.com.
If you want to set the Symbol Explorer to always look at the symbols directory on your computer,
you can enter the full path to your symbols directory in the Address box. Each time you open this
document and click Home in the Symbol Explorer, the symbol documents in the directory path
you specified are displayed.
Browse Accesses the Modify Location dialog box so that you can set another directory for the
Symbol Explorer to look in. You can set the dialog box to look in directories on your computer or
a network drive.

Global Revisions Dialog Box


Enables you to assign and manage revisions to a group of documents that you select.
Activity Allows you to select one of the following revision activities:
Add revision Adds a new revision to the selected documents in accordance with the value
you specify in the Revision number field in the Settings group box.. The software
determines which revision method suits best the value that you typed in the Revision number
field and adjusts the revision method accordingly. If the revision number value that you are
adding conforms with method of the last existing revision, the software will continue to number
the new revision accordingly. If the software cannot determine a suitable revision method for
the typed value, the revision method will switch to Other. Also, if you do not enter a value in
the Revision number field, the software will add a new revision using the Other method and
will not provide a value in the Revision number field of the individual documents.
Upgrade revision Adds a new revision by raising the last revision number of all the
selected documents. The software identifies the revision numbering method of each
document (P0, P1, P2; 0,1,2, A,B,C, and so forth) and raises the revision number to the next
value according to the existing revision method. You cannot change the revision method but
you can update all the other settings by entering new settings.
Delete last revision Deletes the last revision of all the selected documents.
Delete all revisions Deletes all the revisions of all the selected documents.
Revision method for items without revisions Allows you to select a revision method for
documents without revisions. This option is available only after selecting Upgrade revision from
the Activity list.

Settings
Revision number Allows you to type an appropriate revision number to be used when adding
or updating revisions. This setting is not available when upgrading revisions.
Revision date Allows you to enter the revision date.
Created by Allows you to type the name or the initials of the person who made the revision.

SmartPlant Electrical User's Guide

741

Windows and Dialog Boxes


Checked by Allows you to type the name or the initials of the person who checked the revision.
Approved by Allows you to type the name or the initials of the person who approved the
revision.
Revision description Allows you to type a brief revision description.
The software archives all the added and upgraded revisions of the selected documents so
that you can compare the data of an archived document with the current version. For more
information, see Comparing Documents (see "Compare an Archived Document with a Current
Document" on page 367).

New Miscellaneous Drawing Dialog Box


Allows you to specify a new miscellaneous drawing for saving to the SmartPlant Electrical
database. A miscellaneous drawing can be any drawing that was created in SmartSketch or
some other CAD application. After saving this drawing to your SmartPlant Electrical database,
the software allows you to associate this drawing with a SmartPlant Electrical item, and manage
revisions. Note that the software does not allow you to archive miscellaneous drawings.
On clicking OK, the software opens the selected template and you can then insert .sym files
created in SmartSketch or some other application.
Template Click the ellipsis button
to select a drawing template (.spe file). The template
determines the paper size and orientation, and the title block that appears on the drawing.
Document number Allows you to type a document number used to identify the drawing.
Description Allows you to type a description for the drawing if required.

Registered Report Common Properties Dialog Box


Enables you to register plant reports in the SmartPlant Electrical database so that you can apply
revisions to the reports in the same way as for other documents. When you register a report, it
appears under Documents > Registered Reports in the Electrical Index.
Report template Displays the report template associated with the report you select to
register. To select a report, click the ellipsis button
and navigate to one of the Excel reports
that comes shipped with SmartPlant Electrical. For the full list of shipped reports, see Shipped
Reports (on page 382).
Filter Displays a filter, if selected, for filtering the data that you want to present in the report. To
select a filter, click the ellipsis button
and choose a filter that is appropriate for the report
template.
Report item type Displays the main item that the selected report template represents.
Document main item type For certain report item types only, allows you to select an item type
related to the document, for example, where the report item type is Electrical Equipment, you
can select from this list Cable, Converting Equipment, Motor, and so forth. The value that you
select is for information purposes only.
Document name Allows you to type a name for the document, which appears under the
Reports folder.
Description Allows you to type text description for the report if required. Press CTRL +
ENTER to start a new line.

742

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Enable document for publishing Select to use the report for publishing data to an XML
file. This option is available for reports based on item types that you can publish: cabinets,
instruments, equipment (which you should filter for cabinets and instruments), and signal
run. Clear the check box if you do not intend to publish data for one of these item types. Clearing
the check box makes the report registration process faster.

Panels
Cabinet Common Properties Dialog Box
Sets options for defining the general properties of wiring cabinets. Also, this dialog box defines
properties that the software uses for calculating electrical loads and associating the item with the
electrical supply.
General Tab (see "General Tab (Cabinet Common Properties Dialog Box)" on page 743)
Electrical Data Tab (see "Electrical Data Tab (Cabinet Common Properties Dialog Box)" on page
744)
Feeder Data Tab (see "Feeder Data Tab (Cabinet Common Properties Dialog Box)" on page 745)
Alternative Feeder Tab (see "Alternative Feeder Tab (Cabinet Common Properties Dialog Box)"
on page 746)

General Tab (Cabinet Common Properties Dialog Box)


Sets options for general properties that identify and characterize the cabinet. An asterisk beside
a property name indicates required data.
Item tag - Identifies the cabinet. The tag is the name that appears beside the cabinet in the
Electrical Index or the Reference Data Explorer. In the Reference Data Explorer, you must
enter a string in this box. In the Electrical Index, the item tag matches the naming convention for
the cabinet. Click the ellipsis button
segments that are editable.

to open a dialog box where you can modify the item tag

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option that you set in Options Manager.
Description Allows you to type a description of the cabinet, for information only.
Manufacturer Allows you to select a manufacturer for the cabinet. You can define and
customize manufacturers in the Data Dictionary Manager.
Model Allows you to select a cabinet model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Type Displays the type of cabinet. You can define and customize cabinet types in the Data
Dictionary Manager. The software uses this description in filters and reports.
Data quality Allows you to select a standard term that provides a qualitative measure of the
reliability of the data for this particular cabinet. For example, Preliminary, Certified, or As Built.
Notes Allows you to enter text, for example, if you want to provide additional information about
the cabinet.

SmartPlant Electrical User's Guide

743

Windows and Dialog Boxes

Electrical Data Tab (Cabinet Common Properties Dialog Box)


Provides information about the electrical requirements of the cabinet.
Cabinet rated power The power supply that the cabinet can handle, as shown on the cabinet
nameplate. You must enter a value with appropriate units of measure for the standard that you
are using. The units of measure depend on the type of load. You can specify the default project
units of measure in the Data Dictionary Manager.
Power factor Enter the ratio of active power to apparent power at 100% of the rated power and
at the demand point. The power factor can have a value between 0 and 1.
Rated active power Shows the quantity of electrical power in kW drawn from the network and
that is actually converted to output power.
Rated reactive power Shows the quantity of reactive power in kVAR that the cabinet items
draw from the network.
Rated apparent power - Shows the quantity of electrical power in kVA that represents the vector
sum of the active and reactive power. This quantity is the actual power that the network needs to
generate.
Supply Select the type of supply: alternating current (AC) or direct current (DC).
Number of phases Select the number of phases in the power supply to the load. You can
select 1 or 3 phases. This property applies for an AC supply only. The value you select from this
list affects the phase arrangement in this tab folder and the phase association in the Feeder Data
tab folder.
Frequency (Hz) Select the operating frequency of the load. This property applies for an AC
supply only. You can define and customize the available frequencies in the Data Dictionary
Manager.
Phase arrangement Select a value to determine which of the available phases are in use for
the current load, for example 2 PH + N (two phases plus neutral). This property applies for an AC
supply only and the values on this list that are available for selection depend on the number of
phases that you have selected.
Rated voltage Select the voltage at which the load is designed to operate. This quantity
ensures electrical compatibility between the electrical supply and the equipment. It usually
appears on the load nameplate. You can define and customize the available rated voltages in the
Data Dictionary Manager.
Number of wires Select the number of wires used to supply power to the load.
Override FLA calculation Select the desired option to determine whether the software uses a
calculated or manually typed full load current value. If you select Calculated, the software
calculates the full load current value based on values you enter on the Load Data tab; the
calculated value overwrites any value that you previously entered manually. Selecting Manual
enables data entry in the Full load current box, with the last calculated full load current as the
starting value.
Full load current (FLA) The electrical current, in amperes, that the load draws from the supply
when operating at maximum power. The full load current usually appears on the nameplate of the
load. You can select Calculated or Manual from the Override FLA calculation list to determine
whether the software calculates this value or whether you enter a value manually. When the load
has an attached cable, the software copies this value to the cable and uses it as a default value for
sizing the cable.
Starting current The electrical current, in amperes, that the cabinet uses for the associated
equipment when starting. When the cabinet has an attached cable, the software copies this value
to the cable and uses it as a default value for sizing the cable.

744

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Coincidence factors
Allows you to enter values corresponding to the percentage utilization of the load for the selected
operating mode. Also known as duty factors. Type a value between 0 and 1 for the desired
mode. A value of 0 corresponds to an unused load, while a value of 1 corresponds to continuous
operation.
Operating mode Select the operating mode that describes how the cabinet is used in practice
in the plant. The standard available operating modes are:
Continuous
Intermittent
Standby
Spare
The coincidence factor corresponding to the selected operating mode provides a
quantitative measure of the cabinet behavior in that mode. You can customize the available
operating modes in the Data Dictionary Manager.

Feeder Data Tab (Cabinet Common Properties Dialog Box)


Provides information about the feeder and details of associated protection devices such as fuses,
circuit breakers, overload relays, and so forth in cabinets that belong to your project. The values
on this tab reflect the definitions that you make in the Electrical Engineer.
Once you associate the equipment with a circuit, the feeder data becomes
read-only. Further changes are possible only through the Electrical Engineer. For more
information, see Associate Electrical Equipment with Feeders (on page 194).

Location
Enables you to specify the location of the cabinet feeder. Also, you can specify these settings by
performing associations in the Electrical Engineer.
Where the feeder source is an item of equipment other than a PDB, the source tag appears
in the Feeder equipment box and all the properties in this section are disabled.
Power distribution board Allows you to specify and display the power distribution board in
which the feeder is located. If you select a PDB without specifying a bus, the software assigns the
PDB to the cabinet, but you can change feeder data values later if you need to.
Bus Allows you to specify and display the bus to which the cabinet is assigned. The values in
this list depend on the selected PDB number. If you select a bus without specifying a circuit, the
software assigns the bus to the cabinet, but you can change feeder data values later if you need
to.
Cell Allows you to specify and display a cell/bucket/ compartment to which the cabinet is
assigned. The values in this list depend on the selected bus.
Circuit Allows you to specify and display the circuit to which the cabinet is assigned. If the
circuit resides in a particular cell, the values in this list depend on the selected cell. If the circuit is
linked directly to the bus, and is not linked to a cell, the values in the list depend on the selected
bus.
If you select a cell without selecting an existing circuit, the software automatically creates a
new circuit when you click Apply.
Create circuit Allows you to create a new feeder circuit in the bus to which the cabinet is
assigned when you click Apply. The software automatically assigns the circuit name. When you
select this check box, the Create cell check box becomes active. Also, with the new circuit, if you

SmartPlant Electrical User's Guide

745

Windows and Dialog Boxes


have specified a typical circuit for the cabinet, the software assigns circuit components based on
that typical circuit.
If you do not select this check box, then unless you select a cell, the software does not
create a circuit and the cabinet-bus association does not appear in the Electrical Engineer. In
this case, you can select the check box the next time you select this tab folder to actually create
the circuit.
Create cell Allows you to create a new cell in the bus to which the cabinet is assigned. The
software automatically assigns the cell name.
Phase 1 Allows you to associate the current cabinet with phase 1 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 1 refers to
the label L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the current cabinet with phase 2 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 2 refers to
the label L2 or S, as defined by the value of the Phase Label2 bus property.
Phase 3 Allows you to associate the current cabinet with phase 3 of the selected bus. The
availability of this option depends on the value you selected from the Number of phases list on
the Load Data tab and applies only where the selected bus has an AC supply. Phase 3 refers to
the label L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes to assign the cabinet to two phases.
Details of circuit internals Displays details of the components in the selected circuit. The
values are read-only.
To update the circuit components, you need to modify the selected circuit in the Electrical
Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Alternative Feeder Tab (Cabinet Common Properties Dialog Box)


Displays the location of an alternative feeder, if defined, in cabinets that belong to your
project. You specify these settings by performing associations in the Electrical Engineer. All
properties on this tab are view-only.

Location
Power distribution board Displays the power distribution board in which the feeder is located.
Bus Displays the bus belonging to the power distribution board.
Cell Displays a cell/bucket/ compartment to which the cabinet is assigned, if defined.
Circuit Displays the circuit to which the cabinet is assigned.
Feeder equipment Displays the item used as the alternative supply (generator, battery bank,
off-site power and so forth).

746

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Control Station Common Properties Dialog Box


Enables you to associate a control station with a cable and an electrical item such as a motor,
heater, capacitor, harmonic filter, resistor, heat traces, UPS, VFD, battery chargers, other
converting and electrical equipment.
Item tag Identifies the control station. The item tag appears beside the control station in the
Electrical Index. The item tag matches the naming convention for the control station. Click the
ellipsis button
to open a dialog box where you can modify the tag segments that are editable.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
control station, if appropriate. This information is read-only and only appears if you apply a typical
I/O set by dragging it from the Reference Data Explorer or by applying options to the control
station.
Associated equipment Displays the electrical item associated with the control station.
You can associate one electrical item only per control station.
Find Opens the Find dialog box, which allows you to select an electrical item to associate with
the control station.
Dissociate Allows you to clear the association of the selected equipment with the control
station.

Associated cables
Displays the project cables that the software associates with the control station.
(Data window) Describes the names and cable specifications of the associated cables.
Add Opens the Find dialog box, which allows you to select control, grounding, or
instrumentation cables to associate with the control station.
You can associate more than one cable per control station.
Remove Removes the selected associated cable from the control station.

SmartPlant Electrical User's Guide

747

Windows and Dialog Boxes

Project Management
Project Management Table (As-Built)
The Project Management table in As-Built allows you to select a target project and to scope items
for that project, and to merge items in the project back to As-Built after you have edited or created
them in the project. The commands associated with the Project Management table are all on
the Project Management toolbar (on page 749). This table opens when you click Window > New
> Project Management on the main menu bar.

748

Header

Description

(Check box)

Applies to main items only. When selected, includes those items


in the action specified the Scope, Clear, and Merge
commands. The check box in the main header row is used to
select or clear all the check boxes in the column.

Main Item Tag

The tag of the main item. A main item can be a motor or some
other load, converting equipment, a power source, any free cable,
a PDB, or a document.

Related Item Tag

The tag of the related item which has an electrical association with
the main item; for example, if the main item is a motor, related
items can include cables, signals, control stations, and circuits.

Item Type

Indicates the item type of the main item or related item.

Status in project

Indicates the status of the item. For details, see Understanding


Statuses (on page 450).

Claim Mode

Indicates whether the item, if claimed, has been claimed


exclusively or shared, or whether it has been released from the
claim. In As-Built, this property is read-only.

New Item

Indicates whether an item has been newly-created in the


project. Note that after merging the item, this field appears blank.

Item Path

Indicates the parent hierarchy of a non- unique item. For


example, in the case of a circuit, the item path shows the
PDB\Bus\(Cell) hierarchy.

Description

The item description, if appropriate, as it appears for the item


properties.

Plant Group

Indicates the plant group to which the item belongs.

Deleted

Indicates whether the item has been deleted in the project since
the last time it was scoped.

Result Status

Indicates the result of a major operation such as Merge. For


example, the status Done appears after the software commits an
operation successfully.

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


When scoping an item that is connected in parallel with another equipment item, the
software automatically scopes all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3, the
software will also automatically scope Motor-2 and Motor-3 together with their upstream items all
the way to their power sources.

Project Management Toolbar


Contains the commands that you can run from the Project Management table (see "Project
Management Table (As-Built)" on page 748).
Icon

Command

Explanation

Select Project

Allows you to select a project for scoping and claiming


As-Built data. You must select a project that already exists
and is assigned to the plant before you can perform any
other activities.

Project Status

Allows you to change the current status of the


project. Possible project statuses are: Active, Completed,
Merged, or Canceled. For details of the rules governing
changes in the project status, see Rules for Changing
Statuses (on page 451).

Add Items

When you select one or more items from the Electrical


Index or the Tabular Editor, adds those items to the Project
Management table where you can select them for scoping
to your project. For items that you select in the Electrical
Engineer, adds the selected item with any related items
below it, and also related items above it up to the feeder
PDB.

Scope

Makes each main item from the Project Management table


available for the project if the check box beside it is
selected. If a selected main item has related items, these
are also included in the scope. If you scope an item that is
not a main item, such as a control station, the software
automatically selects the associated main item for
scoping. Where an item was previously scoped, this
command refreshes the data.

Test Merge

Allows you to test the merging of items that have status


Completed and for which you have selected the check
boxes. This operation can assist you in troubleshooting
problems before you commit to merging the data.

Merge

Allows you to merge items that have status Completed and


for which you have selected the check boxes.

Find Completed
Items

Opens the Find dialog box, which allows you to find all the
completed items in the project. You can select all or some of
the completed items and then merge them into As-Built.

SmartPlant Electrical User's Guide

749

Windows and Dialog Boxes


Icon

Command

Explanation

Show Merged
Items

Filters the display to show only those items that have been
merged back into As-Built. Note that the filter relates to the
status of the items in the database and not necessarily the
status currently displayed in the Project Management
table.

Show Claimed
Items

Filters the display to show only those items that have been
claimed for the project. Note that the filter relates to the
status of the items in the database and not necessarily the
status currently displayed in the Project Management
table.

Show Items
Deleted from AsBuilt

Filters the display to show only those items that have been
deleted in As-Built. Note that the filter relates to the status
of the items in the database and not necessarily the status
currently displayed in the Project Management table.

Show Item
Properties

Displays the values of the item properties for an item similar


to the Properties window view, but in read- only
mode. Click Alphabetic
to display the properties in
alphabetical order; click Categorized
to display the
properties grouped by specific categories. The software
can display the properties of only one item at a time; the item
for which the row is highlighted.

Clear All

Clears all items from the Project Management table.

Clear

Clears each main item from the Project Management table


if the check box beside it is selected. If a selected main item
has related items, these are also cleared.

Show / Hide
Buffer

Toggles the buffer display, which you use to make a


preliminary selection of items that you may want to add to
the Project Management table. You drag selected items to
the buffer from the Electrical Index, the Electrical
Engineer, or the Tabular Editor.

Paste from Buffer Pastes to the Project Management table items from the
buffer whose check boxes are selected.

750

Excel Report

Generates a report in Excel showing the current selection in


the Project Management table, arranged according to the
main items. In the report, you can expand the main items to
display their related items.

Display

Allows you to specify the display mode in the data


window. You can display the main items only, the main
items expanded to show their related items, or a list showing
all items. If a particular related item is associated with more
than one main item, that related item appears once only in
the list view. In list view only, you can sort the items as
desired by clicking the column headers in the data window.

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Icon

Command

Explanation

Compare
Documents

After scoping and modifying items in a project, you use this


command to compare documents of the same type in
As-Built and in the project, for example, registered reports,
SLDs, schematics. If changes that you made to the item
are reflected in the document, the software compares the
changes and indicates them on a comparison report. Note
that the software generates As-Built and project reports
automatically when you run this command.

Project Management Table (Project)


The Project Management table, when opened in the project, displays all items that you last scoped
from As-Built, along with any previously scoped items whether or not they have been claimed. Its
main purpose is for claiming items and releasing claimed items. Note that you can claim related
items independently of their main items. The commands associated with the Project
Management table are all on the Project Management toolbar (on page 752). This table opens
when you click Window > New > Project Management on the main menu bar.
Header

Description

(Check box)

Applies to main items only. When selected, includes those items


in the action specified the Scope, Clear, and Merge
commands. The check box in the main header row is used to
select or clear all the check boxes in the column.

Main Item Tag

The tag of the main item. A main item can be a motor or some
other load, a PDB, a cable.

Related Item Tag

The tag of the related item which has an electrical association


with the main item; for example, if the main item is a motor,
related items can include cables, signals, control stations, and
circuits.

Item Type

Indicates the item type of the main item or related item.

Status in project

Indicates the status of the item. For details, see Understanding


Statuses (on page 450).

Claim Mode

Indicates whether the item, if claimed, has been claimed


exclusively or shared, or whether it has been released from the
claim. In As-Built, this property is read-only.

New Item

Indicates whether an item has been newly-created in the


project. Note that after merging the item, this field appears
blank.

Item Path

Indicates the parent hierarchy of a non- unique item. For


example, in the case of a circuit, the item path shows the
PDB\Bus\(Cell) hierarchy.

Description

The item description, if appropriate, as it appears for the item


properties.

SmartPlant Electrical User's Guide

751

Windows and Dialog Boxes


Header

Description

Plant Group

Indicates the plant group to which the item belongs.

Result Status

Indicates the result of a major operation such as Merge. For


example, the status Done appears after the software commits an
operation successfully.

When merging an item that is connected in parallel with another equipment item, the
software automatically merges all the items that are connected in parallel to the scoped item. For
example, if you select Motor-1 that has been connected in parallel with Motor-2 and Motor-3, the
software will also automatically merge Motor-2 and Motor-3 and their upstream items all the way
to their power sources.

Project Management Toolbar


Contains the commands that you can run from the Project Management table (see "Project
Management Table (Project)" on page 751).
Icon

Command

Explanation

Project
Management

Opens the Project Status dialog box, which displays


the status of the current project status, both with
respect to SmartPlant Foundation.

Add Items

Allows you to add items that you added or modified in


the project for eventually merging to As-Built.

Apply

Applies the command to change the status of the items


whose check boxes are selected. The action
performed depends on the status of the item.

Set Claim Mode

Allows you to mark any item with status Scoped or


Merged for claiming, if the check box beside the item is
selected. Note that after claiming an item exclusively,
it becomes unavailable for claiming to other
projects. After clicking Apply, the status of each
marked item changes to Claimed.

Mark as Reclaimed Marks an item with status Merged for claiming again in
the project, if the check box beside the item is
selected. After clicking Apply, the status of the item
changes to Claimed.

752

Mark as
Completed

Marks an item with status Claimed for being ready to


merge back to As-Built, if the check box beside the item
is selected. You can then merge these items in
As-Built.

Clear Mark as
Completed

Marks an item with status Completed for returning to


Claimed status, if the check box beside the item is
selected. After clicking Apply, the status of each
marked item changes to Claimed. The claim mode,
Exclusive or Shared, returns to what it was when the
item was originally claimed.

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Icon

Command

Explanation

Release Claim

Marks an item with status Claimed for releasing from


the claim, if the check box beside the item is
selected. After clicking Apply, the status of the item
changes to Scoped as the software re- scopes these
items.

Release from
Merge

Marks an item with status Merged for releasing from


the merge, if the check box beside the item is
selected. After clicking Apply, the status of the item
changes to Scoped and the software makes it possible
to claim these items for other projects.

Test Merge

Allows you to test the merging of items that have status


Completed and for which you have selected the check
boxes. This operation can assist you in
troubleshooting problems before you commit to
merging the data.

Publish After
Merge

Publishes all documents that have already been


published in the scope of the project and afterwards
merged into As-Built. (For use with an integrated
environment.)

Find Completed
Items

Opens the Find dialog box, which allows you to find all
the completed items in the project. You can select all or
some of the completed items and then merge them into
As-Built.

Show Merged
Items

Filters the display to show only those items that have


been merged back into As-Built. Note that the filter
relates to the status of the items in the database and
not necessarily the status currently displayed in the
Project Management table.

Show Claimed
Items

Filters the display to show only those items that have


been claimed for the project. Note that the filter
relates to the status of the items in the database and
not necessarily the status currently displayed in the
Project Management table.

Show Items
Deleted from
Project

Filters the display to show only those items that have


been deleted from the project. Note that the filter
relates to the status of the items in the database and
not necessarily the status currently displayed in the
Project Management table.

SmartPlant Electrical User's Guide

753

Windows and Dialog Boxes


Icon

Command

Explanation

Show Item
Properties

Displays the values of the item properties for an item


similar to the Properties window view, but in read- only
mode. Click Alphabetic
to display the properties
in alphabetical order; click Categorized
to display
the properties grouped by specific categories. The
software can display the properties of only one item at
a time; the item for which the row is highlighted.

Select Related
Items

Allows you to select all related items for which the main
item is already selected for the next action that you
want to perform. A sub-menu option also allows you to
clear the selection of all related items.

Clear All

Clears all items from the Project Management table.

Clear

Clears each item from the Project Management table


if the check box beside it is selected.

Excel Report

Generates a report in Excel showing the current


selection in the Project Management table, reflecting
the selected display mode. In the report, you can
expand the main items to display their related items.

Display

Allows you to specify the display mode in the data


window. You can display the main items only, the
main items expanded to show their related items, or a
list showing all items. If a particular related item is
associated with more than one main item, that related
item appears once only in the list view. In list view
only, you can sort the items as desired by clicking the
column headers in the data window.

Project Status Dialog Box


Displays the current project status, both with respect to SmartPlant Foundation and the plant and
allows you to update or modify those statuses. This dialog box opens when you click
on the
Project Management toolbar.

You can change the status of a SmartPlant Electrical project only from a project. If you open
the Project Status dialog box in As-Built, the project status is view-only and it cannot be
changed.
You cannot claim items in a project whose status has been set to Completed or Merged.
SmartPlant project status Displays information about the status of the active project with
respect to SmartPlant Foundation. This area is not active if the plant is not registered with
SmartPlant Foundation.
Refresh Status Searches for and displays the status of this project in SmartPlant Foundation
and updates this information in SmartPlant Foundation if appropriate. This button is not available
if the plant is not registered with SmartPlant Foundation.

754

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


SmartPlant Electrical project status Active, Completed, Merged, Canceled. If your project
status is Merged, then no further actions are available on this dialog box.
Reactivate Returns the SmartPlant Electrical project status to active. This button is
available only when the SmartPlant Electrical project status is Completed and the SmartPlant
project status, if applicable, is Active.
Complete Project Sets the SmartPlant Electrical project status to completed. This button
is available only when the SmartPlant Electrical project status is Active and the SmartPlant
project status is also Active. When you click Complete Project, a confirmation message
appears.
Merge Project Sets the SmartPlant Electrical project status to Merged. This button is
available only when the SmartPlant Electrical project status is Completed and the SmartPlant
project status is also Completed. When you click Merge Project, a confirmation message
appears.
Cancel Project Clears all claims on all objects and sets the SmartPlant Electrical project
status to Canceled. This button is available only when the SmartPlant project status is
Canceled. If the Plant is not registered with SmartPlant, then the project is simply canceled out of
SmartPlant Electrical.

Select Project Dialog Box


Allows you to select a project for scoping items.
Project Allows you to select a project for scoping items.
Description Displays the project description.
Status Displays the project status: Active, Completed, Merged, or Canceled.
View related items in scope Allows you to view the items related to the items you select for
scoping. Note that selecting this option slows down the performance. The software scopes
related items automatically even if they are not viewed.

Power Distribution Boards


Add New Internal Item Dialog Box
Allows you to add an internal item to a PDB circuit from the Circuit Common Properties dialog
box. Internal items can include various types of disconnect equipment, converting equipment,
and measuring equipment.
Available Items Allows you to select an item to add as an internal item for the circuit.

Circuit Common Properties Dialog Box


Sets options for defining the general properties of a circuit. Also, this dialog box defines
properties that the software uses for associating the circuit with the electrical supply.
General Tab (see "General Tab (Circuit Common Properties Dialog Box)" on page 756)
Electrical Data Tab (see "Electrical Data Tab (Circuit Common Properties Dialog Box)" on page
756)
Associated Items Tab (see "Associated Items Tab (Circuit Common Properties Dialog Box)" on
page 757)

SmartPlant Electrical User's Guide

755

Windows and Dialog Boxes

General Tab (Circuit Common Properties Dialog Box)


Sets options for general properties that identify and characterize the circuit. An asterisk beside a
property name indicates required data.
Item tag Identifies the circuit. The tag is the name that appears beside the circuit in the
Electrical Index. The item tag matches the naming convention for the circuit. Click the ellipsis
button

to open a dialog box where you can modify the item tag segments that are editable.

The tag property Comply with Naming Convention determines the behavior of an item
tag name. When the property is set to True, the protection masks and segment properties
behave according to the settings for the item naming convention in the Options Manager. When
the property is set to False, you can edit the tag name value freely. Whether you set this property
to True or False, the software ensures compliance with uniqueness if you set the Is Unique
parameter to True in the Item Type Properties option of the Options Manager.
Description Allows you to type a description of the circuit, for information only.
Circuit mode Indicates whether the circuit is connected or disconnected. When you
designate the circuit as Connected, the software includes in power calculations any loads that are
associated with the circuit. The results of these calculations appear on the Batch Load
Association dialog box and in various shipped load summary reports.
Circuit type Describes the type of circuit: incomer, feeder, coupler, or bus riser.
Last applied typical circuit Indicates the last typical circuit that you applied to the circuit, if
appropriate. This information is read-only.
Last applied typical schematic - Indicates the last typical schematic that you applied to the
circuit, if appropriate. This information is read-only.
Last applied typical I/O set Indicates the last typical I/O set of signals that you applied to the
circuit, if appropriate. This information is read-only and only appears if you apply a typical I/O set
by dragging it from the Reference Data Explorer or by applying options to the circuit.
Notes Allows you to enter text, for example, if you want to provide additional information about
the circuit.

Electrical Data Tab (Circuit Common Properties Dialog Box)


Provides electrical information about the equipment connected to the circuit and the circuit
location.
Supply Allows you to select the type of supply that the circuit produces: alternating current
(AC) or direct current (DC).
Rated voltage Allows you to select the voltage which the circuit is designed to supply. This
quantity usually appears on the circuit nameplate. You can define and customize the available
rated voltages in the Data Dictionary Manager.
Frequency (Hz) Allows you to select the operating frequency of the circuit. You can define
and customize the available frequencies in the Data Dictionary Manager. This property applies
for an AC output only.
Number of phases Allows you to select the number of phases in the circuit output. You can
select 1 or 3 phases. This property applies for an AC supply only. The value you select from this
list affects the available values of phase arrangement and phase association.
Phase arrangement Allows you to select a value to determine which of the available phases
are in use for the current circuit, for example 3 PH + N (three phases plus neutral). This property
applies for an AC supply only and the values on this list that are available for selection depend on
the number of phases that you have selected.

756

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Phase 1 Allows you to associate the circuit with phase 1 of the selected bus. The availability of
this option depends on the value you selected from the Number of phases list on the Electrical
Data tab and applies only where the selected bus has an AC supply. Phase 1 refers to the label
L1 or R, as defined by the value of the Phase Label1 bus property.
Phase 2 Allows you to associate the circuit with phase 2 of the selected bus. The availability of
this option depends on the value you selected from the Number of phases list on the Electrical
Data tab and applies only where the selected bus has an AC supply. Phase 2 refers to the label
L2 or S, as defined by the value of the Phase Label2 bus property.
Phase 3 Allows you to associate the circuit with phase 3 of the selected bus. The availability of
this option depends on the value you selected from the Number of phases list on the Electrical
Data tab and applies only where the selected bus has an AC supply. Phase 3 refers to the label
L3 or T, as defined by the value of the Phase Label3 bus property.
If you want a single-phase load to simulate a two-phase load that is connected to
a three-phase bus, select two of the Phase check boxes to assign the circuit to two phases.

Location
Specifies the location of the circuit in the electrical network.
Power distribution board - Indicates the power distribution board in which the circuit is located.
Bus Indicates the bus on which the circuit is located.
Cell Indicates the cell/bucket/compartment on which the circuit is located, if applicable.

Associated Items Tab (Circuit Common Properties Dialog Box)


Provides optional information for signals and internal items associated with the circuit. Also,
allows to associate a lookup table with a circuit internal component.

Associated loads
Displays the list of loads that are associated with the circuit. It is possible to display only those
loads that are associated directly with the current circuit (this is the default option) or all the loads
associated downstream with the current circuit.
Item Tag Displays the item tag for the associated load.
Type Displays the electrical equipment item type of the associated load, for example, motor,
heater.
Show only loads associated directly Displays in the Associated loads box only those loads
that are connected directly to the current circuit. (This is the default setting.)
Show all loads associated downstream Displays in the Associated loads box all the loads
that are connected downstream to the current circuit. Note that the application resets the selection
to the default option after reopening this dialog box.
After selecting this option, the software retrieves all the downstream loads that
are associated with the current circuit. If this electrical network branch is long, it can take a
long time to retrieve all the data.

Circuit signals
Describes all the signals that are associated with the circuit.
Item Tag Displays the signal tag for the associated circuit signal.
Equipment Type Displays the equipment type of the item that the signal originates from.
Description Displays a description of the associated I/O signal.

SmartPlant Electrical User's Guide

757

Windows and Dialog Boxes


I/O Type Displays the signal I/O type according to whether the signal is an input or an output,
and whether the signal type is analog or digital.
Loop Number Displays the loop number, if one exists, for signal data that you retrieved from
SmartPlant Instrumentation.

Associated cables
Describes all the cables that are associated with the circuit.
Reference Cable Displays the reference cable for the cable associated with the circuit.
Specification Indicates the family of cables to which the cable belongs.
Cable Formation Displays the cable formation (number and size of conductors) for the cable.

Circuit internals
Displays details of the components in the selected circuit. The values are read-only.
To update the circuit components, you need to modify the selected circuit in the Electrical
Index. For more information, refer to Related Topics.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Electrical Index.
Lookup Table Allows you to select a lookup table that you want to associate with an internal
component of a circuit. You will then be able to apply this associated lookup table to a project
circuit when you run the Apply Lookup Tables feature on the Apply Options dialog box to
propagate the lookup table data to the circuit internal components.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.
Add Opens the Add Internal Item dialog box to enable you to add new internal components for
the circuit.
Move Out Allows you to move a circuit internal out of the circuit and place it under the circuit in
the Electrical Engineer as stand-alone disconnect equipment. It is only possible to move out an
internal whose Order value in the Circuit internals pane is 1.
Remove Removes the currently selected component from the circuit.

Circuit Dialog Box


This dialog box allows you to define a circuit after dragging a reference circuit from the Reference
Data Explorer to a cable block diagram. The software creates this circuit in the cable block
diagram and the Electrical Index in the location that you specify here.
Power distribution board Allows you to select a power distribution board where the new
circuit will be located.
Bus Allows you to select a bus where the new circuit will be located.
Cell Allows you to select a cell where the new circuit will be located.
Create cell If a cell that you need does not exist yet, allows you to create a new cell.

758

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Cell Size Dialog Box


Enables you to change the size of a compartment so that it can accommodate a cell with a
different size. You can resize a compartment that is already assigned to a cell.
Width Enter the cell width.
Height Enter the cell height.

One unit of measure represents the width or height of a standard cell. You can make the size
of a cell as big as needed as long as the cell is within the limits of the defined PDB
cabinet. Also, you can define a cell to have a fraction of a cell size. For example, enter 0.5
for half the cell width or height.
When decreasing the size of a compartment, the maximum number of compartments that a
vertical section or a horizontal row can have depends on the value that you enter for the
Compartments in Row and Compartments in Section properties in the Properties window
for the power distribution board to which the cell belongs.
When increasing the size of a compartment, the software enlarges the compartment only to its
right or down.
When increasing the size of a compartment, the software checks if the adjacent cells that are
under and to the right of the current cell can accommodate the new cell size. Note that you
have to divide the adjacent compartment to prepare it for the new increased cell.
You cannot exceed the boundaries of a vertical section. You can only increase the number of
compartments within the boundaries of a vertical section. You can increase the height of a
compartment. In this case, the compartment will occupy the full size of the compartment
located directly below it.
The software resizes the compartments with the upper left corner of the compartment as its
point of origin.
You cannot resize a compartment if its new size infringes on an adjacent compartment that is
occupied by another cell.

Power Distribution Board Structure Dialog Box


Allows you to design the physical structure of a power distribution board. This structure takes the
form of a layout grid made up of units for which you set the required height and width. You define
the number of vertical sections and the number of rows in the PDB. After designing a PDB
structure, you can open the layout drawing for a particular PDB and make the required cell
associations with appropriate layout grid units.

General definitions
These settings allow you to define the height and width of the grid units that make up the PDB
layout drawing. The width of the vertical sections and the height of the grid rows are measured in
these units. Also, you can define the current PDB as double-sided.
Item tag Displays the name of the power distribution board for which you are designing this
structure.
Double-sided PDB Allows you to set the current PDB as double-sided. This will enable you to
define a section side as front or rear.
Grid unit height Allows you to define the height of the grid units in the PDB layout
drawing. This setting determines the height of the grid rows.
Grid unit width Allows you to define the width of the grid units in the PDB layout drawing. This
setting affects the width of the vertical sections.

SmartPlant Electrical User's Guide

759

Windows and Dialog Boxes


Section definitions
These settings allow you to define the vertical sections of the current PDB.
Number of sections Allows you to enter the number of sections that will comprise the current
PDB. You can add more sections at the bottom of the list if you click Add.
Sequence Displays the sequence number of the vertical sections in the PDB.
Section Allows you to type a name for a vertical section.
Width Allows you to type a number that will define the width of the current section. The value
is measured in grid units. For example, if you type 3 under Width and the grid unit width is 10
inches, the section width will be 30 inches.
Section Side Allows you to set the section side as Front or Rear.
Add Allows you to add another section to the bottom of the list. The new section will appear on
the right side of the PDB in the PDB design drawing.
Move Up Allows you to move a selected section up the list. Note that the software retains the
name of the section after moving it.
Move Down Allows you to move a selected section down the list. Note that the software
retains the name of the section after moving it.
Delete Allows you to delete a section from the bottom of the list. You can select and delete
several consecutive section from the bottom of the list. Note that the software does not allow you
to delete a section that already contains an assigned cell. Remove the assigned cell from the
PDB layout before deleting the redundant section.

Grid rows
Allows you to define the vertical structure of the current PDB. That is, you define the number of
rows that will make up the height of the current PDB.
Number of rows Allows you to enter the number of rows that will comprise the layout of the
current PDB. You can add more rows at the top of the list if you click Add.
Row naming type Allows you to automatically name the rows according to the type that you
select. The options are:
Free text Allows you to type any alpha-numeric characters that you need. This is the
default setting. Note that if you already have names for your rows, changing this setting to
Free text removes all the names that were displayed before.
A.B.C. Names the rows as A, B, C, and so on.
1,2,3 Names the rows as 1, 2, 3, and so on.
Vertical Position Displays the vertical sequence numbers of the grid rows. Note that the top
of the list always shows the lowest row in the PDB.
Row Displays the row names. Also allows you to type a name as you require, which overrides
the automatic naming.
Add Allows you to add another row to the top of the list. Note that the software names the
added row according to the selected naming type. You can click in the required row name and
over type the name as you need.
Delete Allows you to delete a row from the top of the list. You can select and delete several
consecutive rows from the top of the list. Note that the software does not allow you to delete a
row that is already assigned to a cell. Remove the assigned cell from the PDB layout before
deleting the redundant row.

Command Buttons
Apply After changing the data, refreshes the display of data in the dialog box.

760

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Select Alternative Power Source Dialog Box


Displays the contents of the Electrical Engineer, from which you can select an alternative power
source when working with dual power source equipment.
OK This command is enabled after you select a valid item for use as an alternative power
source.
Cancel Closes the dialog box without selecting an alternative power source.
Expand Expands the hierarchy below the selected item.
Find Opens the Find dialog box to allow you to select a suitable item for use as an alternative
power source.

Total Bus Load Validation Dialog Box


Allows you to validate the total loads on buses for selected power distribution boards or
buses. The software calculates the total full load current for all loads attached to each bus and
displays the results for each bus that you included in the selection. You can export the list to an
Excel file for checking or marking up the information conveniently.
PDB (Power Distribution Board) Displays the name of the power distribution board with
which the bus is associated.
Bus Displays the name of the bus for which the software validates the load data.
Overload If the total calculated line current exceeds the maximum allowable load for the bus
the software displays Yes to indicate that the bus is overloaded. The maximum allowable load
equals the maximum bus capacity plus the percentage overload specified for the bus.
Total Calculated Line Current (A) The sum of the current in amperes for all the loads that are
attached to the bus.
Bus Current Rating (A) The maximum rated current that the bus is designed to carry.
Required Overload Percentage The percentage overload allowed on the bus before the
software displays a warning message.
Actual Overload Percentage The actual percentage overload above the maximum bus
capacity. If the total line current is less than or equal to the maximum bus capacity, displays a
value of 0 (zero).
Required Spare Load Percentage The percentage spare load allocated on the bus for future
addition of loads.
Actual Spare Load Percentage The percentage difference between the value of the bus
current rating that you specify on the Batch Load Association dialog box and the calculated line
current. If the total line current is greater than or equal to the required spare load percentage,
displays a value of 0 (zero).
Close Click to close this dialog box.
Excel Report Click to display the data in this dialog box in a Microsoft Excel file. This is useful
if you want to format the layout or print out the data.

SmartPlant Electrical User's Guide

761

Windows and Dialog Boxes

Zoom Options Dialog Box


Enables you to modify the magnification level of the displayed PDB layout design sheet.
Fit to cabinet size Displays the entire PDB layout design sheet.
Use same zoom factor (%) for height and width Sets the same zoom ratio for both the height
and width of the cell boxes in the PDB layout design sheet.
Size With the option Use same zoom factor (%) for height and width, enter the cell box
zoom factor for the cell height and width.
Select custom zoom factor (%) Sets the zoom ratio independently for the height and width of
the cell boxes in the PDB layout design sheet.
Height With the option Select custom zoom factor (%), enter the cell box zoom factor for the
cell height.
Width With the option Select custom zoom factor (%), enter the cell box zoom factor for the
cell width.
Use default size Displays the PDB layout design sheet at the original zoom level.

Redlining and Annotations


Text Properties Dialog Box
Enables you to add or modify an annotation and create a watermark in a single line diagram.
General Tab (see "General Tab (Text Properties Dialog Box)" on page 762)
Properties Tab (see "Properties Tab (Text Properties Dialog Box)" on page 763)

General Tab (Text Properties Dialog Box)


Enables you to enter an annotation text string in a single line diagram.

Text
Caption Type the text that you want to appear in the in the annotation box.

Watermark
Set as watermark Select the box if you want to use the text as a watermark, which means that
it appears behind other drawing items. This option is not available when editing an annotation.

Annotation locking
Lock to item tag Select the box to lock the position of the annotation text to the selected item
tag. In this case, when moving the item tag, the attached annotation moves with it.
Move independently Select this option to be able to move the annotation text independently
from the item tag that it is locked to. For this option, the software keeps the annotation text locked
to the item tag, but allows you to move the annotation text too.

762

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Properties Tab (Text Properties Dialog Box)


Sets text properties such as font, size, alignment in the text box, and rotation for an annotation in
a single line diagram.

Style
The preview window displays the appearance of the selected font.
Font Click to open the standard Windows Font dialog box to define the font, font style, size,
color, and other properties.

Border
Show Border Select this option to display a border around the text.

Text alignment
Horizontal Select the horizontal alignment of the text: left, center, or right.
Vertical Select the vertical alignment of the text: top, center, bottom, or justified.

Placement
Rotation Type the rotation angle of the text in degrees. You can enter positive values from 0
to 360 degrees, or negative values to 180 degrees. The text rotates counter-clockwise when you
type a negative value.
Orientation Select the orientation of the text inside the text box: horizontal or vertical.

Reference Items
Associate Reference Cable Dialog Box
Enables you to select an existing reference cable or specify a new reference cable to associate
with a control station or an item profile.
Cable specification Allows you to select an appropriate cable specification. You must select
a cable specification before you can select a cable.

Cable definition
Select from cable library Choose this option to select an existing reference cable.
Reference cable Indicates the selected reference cable for associating with the control station
or profile.
Select Opens the Reference Cable Library window, which shows the cables that belong to
the cable specification that you selected.
Specify construction Select this option to define a new reference cable based on a specified
conductor arrangement. This option is available only when you define a reference cable for an
item profile and a reference circuit.

SmartPlant Electrical User's Guide

763

Windows and Dialog Boxes


Conductor arrangement Allows you to define the number and arrangement of the conductors
in the cable. The following standard options are available:
Single core cable Creates a current-carrying cable with a single core. For this option, you
can specify an arrangement of any number of single-core conductors, for example, 3
single-core cables, but you cannot specify any additional conductors.
2-core cable Creates a cable with two current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
2+1-core cable Creates a cable with two current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3-core cable Creates a cable with three current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
3+1-core cable Creates a cable with three current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3+2-core cable Creates a cable with three current-carrying conductors and two additional
conductors. You cannot modify the cable construction for this option.
Multicore cable Creates a cable with multiple conductors. For this option, you can specify
any number of conductors and additional conductors.
You can change the names of the standard conductor arrangement items in the Data
Dictionary Manager. However, the software performs calculations according to the position in the
list of the item that you select. For example, a 2-core cable is always the second item in the list.
Conductors Allows you to specify the number of conductors within the cable used for carrying
the current, excluding the neutral, the ground, or additional conductors. If you selected Singlecore or Multicore as the conductor arrangement, this option allows you to specify the number of
conductors or cores in the cable that carry the electric current.
Additional conductors If you selected Multicore as the conductor arrangement, allows you to
specify the number of additional non-current-carrying conductors, such as ground wires.

Equipment Profile Properties Dialog Box


Defines a profile in the Reference Data Explorer. For each profile, you can select a typical
schematic, a lookup table, a catalog item, associated cables, control stations, and a typical circuit
with protection devices. For a motor with an internal heater, you can select a cable and typical
circuit for the heater.
General Tab (see "General Tab (Equipment Profile Properties Dialog Box)" on page 764)
Protection Devices Tab (see "Protection Devices Tab (Equipment Profile Properties Dialog Box)"
on page 765)
Space Heater Tab (see "Space Heater Tab (Equipment Profile Properties Dialog Box)" on page
765)
Miscellaneous Tab (see "Miscellaneous Tab (Equipment Profile Properties Dialog Box)" on page
767)

General Tab (Equipment Profile Properties Dialog Box)


Specifies values for general profile properties that apply to loads in the Electrical Index.
Profile tag Allows you to enter a tag name that identifies the profile.
Item type Indicates the equipment type according to the folder in which you created the
profile. The value is read-only.
Set as default Defines this profile as the default for the specified equipment type when you
apply a profile to a load.

764

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Reference item Allows you to select a reference item for copying the property values when you
apply the profile.

Associated cables and cable assembly


Displays the reference cables and cable assembly that the software associates with the load when
you apply the profile.
Cables Describes the properties of the associated cables. In particular, this window shows the
conductor arrangement.
Add Opens the Select Reference Cable dialog box to associate a new reference cable with
the profile.
Edit Opens the Select Reference Cable dialog box to select a different reference cable for
associating with the profile.
Remove Removes the selected associated cable from the profile.
Cable assembly Displays the reference cable assembly that you selected in the Find dialog
box.
Find Opens the Find dialog box where you can find an appropriate cable assembly for the
current profile.
Remove Removes the selected associated cable assembly from the profile.

Typical control station


Displays the names and descriptions of typical control stations that the software associates with
the load when you apply the profile.
Control stations may have associated cables.
Add Click to display all the available control stations on the Find dialog box, where you can
select a control station for the profile.
Remove Removes the selected control station and its cable from the profile.

Protection Devices Tab (Equipment Profile Properties Dialog


Box)
Specifies typical circuits for use when applying profiles to equipment in the Electrical Index.
Typical circuit Displays the circuit that the software associates with the equipment when you
apply the profile.
Find Allows you to select a typical circuit.
Clear Allows you to clear the selected typical circuit association to the equipment.
Function Indicates the purpose of the selected typical circuit. You define the typical circuit
function when you create the typical circuit. For loads, the typical circuit function is always
Feeder.
Internal components Displays details of the internal components for the selected typical
circuit. For example, an internal component can be a contractor or a fuse.

Space Heater Tab (Equipment Profile Properties Dialog Box)


Enables you to define cables and typical circuits associated with a space heater. This option is
available only for profiles that include a motor with an internal heater.

SmartPlant Electrical User's Guide

765

Windows and Dialog Boxes


Associated cables
Displays the reference cables that the software associates with the space heater when you apply
the profile.
(Data window) Describes the properties of the associated cables. In particular, this window
shows the conductor arrangement.
Add Opens the Select Reference Cable dialog box to associate a new reference cable with
the heater.
Edit Opens the Select Reference Cable dialog box to select a different reference cable for
associating with the heater.
Remove Removes the selected associated cable from the heater.
Typical circuit Displays the circuit that the software associates with the space heater when
you apply the profile.
Find Click to select a typical circuit.
Clear Allows you to clear the selected typical circuit association to the space heater.
Function Indicates the purpose of the typical circuit. You define the typical circuit function
when you create the typical circuit. An example of a function is a feeder.
Internal components Describes details of the internal components for the selected typical
circuit.

766

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Miscellaneous Tab (Equipment Profile Properties Dialog Box)


Specifies a typical schematic and lookup table for a profile.
Typical schematic Allows you to select a typical schematic for the item to which you want to
apply the profile. The software then uses this typical schematic when you generate a schematic
for the item.
Find Allows you to display all the available typical schematics on the Find dialog box, where
you can select the desired typical schematic for the profile.
Clear Allows you to clear the selected typical schematic association to the item.
Lookup table Allows you to select a lookup table for the desired item to which you apply the
profile. The software then uses this lookup table when you generate a schematic for the item.
Find Allows you to display all the available lookup tables on the Find dialog box, where you can
select the desired lookup table for the profile.
Clear Allows you to clear the selected lookup table association to the item.
Typical instruments Allows you to select one or more typical instruments for the profile. If
required, you can add the same typical instrument more than once. When you apply the profile to
an item, the software creates associated instruments for the item based on the typical
instruments.
Add Allows you to display all the available typical instruments on the Find dialog box, where
you can select the desired typical instrument for the profile.
Remove Removes the currently selected typical instrument from the list.

Lookup Table Properties Dialog Box


Defines default values for a set of properties that you can apply to a project item.
Data Tab (see "Data Tab (Lookup Table Properties Dialog Box)" on page 767)
Structure Tab (see "Structure Tab (Lookup Table Properties Dialog Box)" on page 768)

Data Tab (Lookup Table Properties Dialog Box)


Specifies sets of data values for the properties defined on the Structure tab. You usually define
the structure once, but you will probably add data quite often. The key values define the
uniqueness of each row of data. When you apply a lookup table to a project item and select a
particular row, the software enters the values in that row for the appropriate properties of the
project item.
Lookup table tag Allows you to enter a tag name that identifies the lookup table.
Set as default Select to define this lookup table as the default for the specified equipment type
when you apply a lookup table to a load.

Each time you define a row of data, the software adds a new blank row automatically at the
end of the list. To define more than 17 rows, you have to do one of the following: increase the
window size, maximize the window, close the window and then re-open it, or press the 'down
arrow' key on the keyboard.
Each combination of data in the key fields must be unique. The software indicates key fields
by double sets of asterisks (**) in the header labels. For more details, see Lookup Table Data
Example (on page 58).

SmartPlant Electrical User's Guide

767

Windows and Dialog Boxes

For a 2- or 3-winding transformer, the Number of Secondaries property always appears by


default as a key field. For a 2- winding transformer, it has a value of 1; for a 3-winding
transformer, it has a value of 2.
You can split the view of the data columns by dragging or double-clicking the split box at the
left of the horizontal scroll bar. This allows you to scroll the columns independently in each
split region. To remove the split, drag the vertical divider to the left.
You can sort the rows of data according to a particular column by clicking the column
header. Repeatedly clicking a column header displays the data in alternating ascending and
descending order.
Remove Removes the currently selected row of data.
Copy Row Copies the data from the currently selected row to the Clipboard.
Paste Row Pastes data from the Clipboard to the currently selected row. This action replaces
all existing values in the row.
Excel Report Click to display the data in this dialog box in a Microsoft Excel file. This is useful
if you want to format the layout or print out the data. Also, after correcting errors, you can use the
Excel file as a data source for re-importing the data using the Import Manager.

Structure Tab (Lookup Table Properties Dialog Box)


Specifies the properties for which you want to assign default values to a project item. You define
each property as an input (key value) or an output.
Lookup table tag Allows you to enter a tag name that identifies the lookup table.
Set as default Select to define this lookup table as the default for the specified equipment type
when you apply a lookup table to a project item.
Definition Displays the properties included in the lookup table.
Add Adds a new row. You define a property and its characteristics in the Edit section of this
dialog box.
Remove Removes the currently selected property from the lookup table definition.
Up Moves the selected row above the previous row each time that you click this option. The
order of the rows affects the order in which the properties appear on the Data tab.
Down Moves the selected row below the next row each time that you click this option. The
order of the rows affects the order in which the properties appear on the Data tab.

Edit
Provides options for you to select a property and specify how it behaves when you apply the
lookup table.
Item type Displays the item type for which the lookup table applies. The value is read-only,
except in the case of transformers, where you can select whether to show the properties of the
primary winding or of a secondary winding.
Property Allows you to select a property for use in the lookup table. In the case of a lookup
table for a transformer, the Number of Secondaries property appears by default and you cannot
delete it.
Caption Allows you to type any text to use as the caption for the property. The caption
appears in the header row on the Data tab.

768

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Input / output Allows you to specify how the software uses the property when you apply the
lookup table to a load. Available options are:
Input The property behaves as a key - that is, it specifies the uniqueness of each set of
lookup table values on the Data tab, in addition to providing the data value.
Output The property only provides a data value when you apply the lookup table to a
load. This option is disabled for read-only data.
Overwrite option Allows you to specify whether the property value overwrites an existing
value when you apply the lookup table to a load.

Reference Cable Common Properties Dialog Box


Sets options for defining general cable properties and design details for reference cables from
which you create project cables in the Electrical Index.
General Tab (see "General Tab (Reference Cable Common Properties Dialog Box)" on page 769)
Design Data Tab (see "Design Data Tab (Reference Cable Common Properties Dialog Box)" on
page 772)
Connections Tab (see "Connections Tab (Reference Cable Common Properties Dialog Box)" on
page 773)
Procurement Tab (see "Procurement Tab (Reference Cable Common Properties Dialog Box)" on
page 773)

General Tab (Reference Cable Common Properties Dialog Box)


Sets options for general properties that identify and characterize the cable. An asterisk beside a
property name indicates required data.
Reference cable Allows you to specify an item tag that uniquely identifies the reference
cable. The item tag appears beside the cable in the Reference Data Explorer. You must enter a
string in this box to define the cable.
Description Allows you to type a description of the cable, for information only.
Cable category Defines the purpose for which the cable is used. The cable category can be
power, control, grounding, or instrumentation. The software automatically assigns the cable
category according to the folder in which you create the cable, and you cannot change the value.
Cable specification Allows you to select the cable specification, which identifies the cable type
and properties, and groups cables that have common properties. You must select a value for this
property. You can define and customize cable specifications in the Data Dictionary Manager.
Cable usage If required, select a value for this property to further categorize the cable, for
example, for control voltage definitions, level definitions, and so forth. You can define and
customize cable usages in the Data Dictionary Manager.
Armor type Allows you to specify the type of armor used to protect the cable from its
environment. For example, types of armor include non-armored, steel, or lead. You can define
and customize armor types in the Data Dictionary Manager.
Outer jacket insulation Allows you to specify the material used for the cable jacket. For
example, insulation materials include PVC and polyethylene. You can define and customize
insulation materials in the Data Dictionary Manager.
Notes Allows you to type user notes, for example if you want to provide additional information
regarding special features of the cable.

SmartPlant Electrical User's Guide

769

Windows and Dialog Boxes


Construction
Describes the physical characteristics related to the construction of the cable. When the
reference item is a non- sized power cable, you can edit the data; otherwise, the items are
read-only. The available values depend on the conductor arrangement you select.
Conductor arrangement Select an option for a new reference cable to define the number and
arrangement of the conductors in the cable (not applicable for instrumentation cables). Your
selection affects how you can modify the cable construction. The following standard options are
available:
Single core cable Creates a current-carrying cable with a single core. For this option, you
can specify an arrangement of any number of single-core conductors, for example, 3
single-core cables, but you cannot specify any additional conductors.
2-core cable Creates a cable with two current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
2+1-core cable Creates a cable with two current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3-core cable Creates a cable with three current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
3+1-core cable Creates a cable with three current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3+2-core cable Creates a cable with three current-carrying conductors and two additional
conductors. You cannot modify the cable construction for this option.
Multicore cable Creates a cable with multiple conductors. For this option, you can specify
any number of conductors and additional conductors.
You can change the names of the standard conductor arrangement items in the Data
Dictionary Manager. However, the software performs calculations according to the position in the
list of the item that you select. Also, you can define new conductor arrangements that the
software can use to filter the available reference cables when sizing project cables.
Set type For instrumentation cables only, allows you to select a standard value that represents
the arrangement of the wires in the set, such as Wire, Pair, Pair w/Shield, Triad, Triad w/Shield,
and so forth. You can select values of this property for a new cable only; you cannot select a
different value for an existing or duplicated cable.
The value Other is available for future use. If you do not want this value to appear in
the list, make it invisible in the Data Dictionary Manager.
Cable formation Displays computed information based on the total number and the size of the
conductors or cable sets specified.
Current-carrying conductors Specifies the number of conductors within the cable used for
carrying the current, excluding the neutral, the ground, or additional conductors (not applicable for
instrumentation cables). If you selected Single-core or Multicore as the conductor
arrangement, this option allows you to specify the number of conductors that carry the electric
current.
Number of sets For instrumentation cables only, allows you to type the number of cable sets
that the cable contains. Click the ellipsis button
to open the Cable Set Properties dialog box
(on page 641) where you can modify the set definitions if required.
Size Allows you to select a standard size for the current- carrying conductors or cable
sets. You can define and customize the available cable sizes in the Data Dictionary Manager.
Material Specifies the conductor material used for the current-carrying conductors or cable
sets. The software automatically copies to project power cables the values in the Conductor
Material Coefficients lookup table that are appropriate for the selected conductor material; these

770

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


values are required for short circuit cable sizing. You can define and customize conductor
materials in the Data Dictionary Manager.
Insulation Specifies the material used for insulating the current-carrying conductors or cable
sets. For example, insulation materials include polyvinyl chloride (PVC) and polyethylene. The
software automatically copies to project power cables the values in the Conductor Insulation
Temperatures lookup table that are appropriate for the selected insulation material; these values
are required for short circuit cable sizing. You can define and customize insulation materials in
the Data Dictionary Manager.
Additional conductors Specifies the number of conductors within the cable in addition to the
conductors used for carrying the current (not applicable for instrumentation cables). If you
selected Multicore as the conductor arrangement, this option allows you to specify the number of
additional non-current-carrying conductors, such as ground wires.
Overall shield For instrumentation cables only, select to specify an overall shield for the
cable. When you select this option, you need to specify the size and material of the overall shield.
Size Allows you to select a standard size for the additional conductors or overall shield. You
can define and customize the available cable sizes in the Data Dictionary Manager.
Material For instrumentation cables only, allows you to select the material used for an overall
shield. You can define and customize the available materials in the Data Dictionary Manager.
Communication wire For instrumentation cables only, select to specify a communication wire
for the cable.
Color pattern Select a color pattern for the cable from one of the patterns available. Click the
ellipsis button
to define or modify a color pattern.
Insulation voltage rating Allows you to select a standard voltage rating that corresponds to
the manufacturer voltage rating for the cable. You can define and customize the available voltage
ratings, including units, in the Data Dictionary Manager.
Insulation temperature rating Allows you to select a standard temperature rating that
corresponds to the manufacturer rating of the maximum operating temperature for the cable. You
can define and customize the available temperature ratings, including units, in the Data Dictionary
Manager.
Basic ampacity in air Allows you to define the ampere capacity of the cable in air under the
basic conditions that the manufacturer specifies. This quantity is a measure of the ability of the
cable to deliver electric current in air. Enter a value with the desired units of current. For power
cables, this value is required for sizing; for other types of cables, the value is optional.
Basic ampacity in ground Allows you to define the ampere capacity of the cable in the ground
under the basic conditions that the manufacturer specifies. This quantity is a measure of the
ability of the cable to deliver electric current under the ground. Enter a value with the desired
units of current. For power cables, this value is required for sizing; for other types of cables, the
value is optional.
Custom basic ampacity This property is not used in reference cable definitions.
Reactance per unit length Allows you to enter the reactance per unit length for a cable that
carries alternating current (AC) according to the value that the manufacturer specifies for the cable
type. Enter a value with the desired units. For power cables, this value is required for sizing; for
other types of cables, the value is optional.
Resistance per unit length Allows you to enter the resistance per unit length according to the
value that the manufacturer specifies for the cable type. Enter a value with the desired units. For
power cables, this value is required for sizing; for other types of cables, the value is optional.

SmartPlant Electrical User's Guide

771

Windows and Dialog Boxes


Parallel cables
Describes the number of cables in parallel and the list of cable names. This information only
applies to project cables.

Design Data Tab (Reference Cable Common Properties Dialog


Box)
Enables you to define the cable drum sizes, routing, length, and so forth. An asterisk beside a
property name indicates required data.

Drum definition
Allows you to define cable drum parameters that are used to assign project cables to drums. Once
you assign a reference cable to a particular drum, the software uses these values for manual and
automatic cable assignment to drums.
When assigning cables to drums manually, you associate a drum with a specific reference cable.
You can define multiple drum sizes for each reference cable. These drum sizes are based on
various cable lengths that a drum can hold. Once you associate a drum with a reference cable that
has multiple drum sizes, you can select the most appropriate drum size for a particular drum.
When assigning project cables to drums automatically, the software optimizes the cable
assignment. SmartPlant Electrical optimizes this assignment based on the drum sizes, the
maximum percentage of free cable length on the drums and the scrap cable length that you have
defined for each reference cable that you select for drum assignment. For more details, see
Optimization of Cable Drum Assignment.
You perform automatic cable assignment by using the Assign Drums to Cables wizard. When
using the wizard, you define the assignment parameters by selecting the following:
All the available reference cables or just one specific reference cable.
One or more pulling area.
The wizard will then assign all the project cables that comply with these parameters. Furthermore,
the software will optimize cable assignment to the drums based on the drum sizes, the maximum
percentage of free cable lengths on the drums, and the scrap cable length that you have defined
for each reference cable that you selected in the wizard.
Drum sizes Allows you to define multiple sets of cable lengths that will be used in cable drum
assignment. Note that all the values that you enter in this grid become available on the Drum
Sizes dialog box when setting a reference cable for a cable drum.
Minimum Allows you to type a value and select an appropriate unit of measure for the
minimum length of cable when ordering from a supplier.
Maximum Allows you to type a value and select an appropriate unit of measure for the
maximum drum capacity. This value is the total cable length that a drum can hold, including
any spare cable.
Remove Deletes a row that you select.
Maximum free length on drum (%) Allows you to type a value which sets the maximum
percentage of free space that can be left on a drum. A drum that has more free space than the
value you set here makes the drum not optimized. Note that this option is applicable to automatic
cable assignment only. The software indicates if a drum is not optimized in the cable drum log file.
Scrap cable length Allows you to specify the scrap length for the cables that are based on the
current reference cable. The software will use this value when calculating the total cable length on
a drum in your project. Note this value has no effect on any other calculations.

772

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Cable routing
This information only applies to project cables.

Design data
Provides information about the physical characteristics of the cable.
Use external routing length This information only applies to project cables.
Estimated length Allows you to enter the estimated length of cable before installation for use
as a default value in project cables.
Design length Allows you to enter a more accurate length for the cable after installation for use
as a default value in project cables.
Routing length This information only applies to project cables.
External routing length This information only applies to project cables.
Tail 1 Type a value for the spare tail length at one end the cable, if you require, for use as a
default value in project cables.
Length A calculated field that displays the design length, or if not available, the estimated
length.
Tail 2 Type a value for the spare tail length at the other end the cable, if you require, for use as
a default value in project cables.
Spare length Type a value for additional spare cable length, if you require, for use as a default
value in project cables.
Actual length This information only applies to project cables.

Connections Tab (Reference Cable Common Properties Dialog


Box)
From / To
Describes information about the connection points for the cable. This information only applies to
project cables.
Gland Displays a gland associated with the cable side, if appropriate.
Find Click to open the Find dialog box, where you can select an appropriate cable gland to
associate on the From or To cable side.
Dissociate Click to dissociate a gland that already has an association with the cable side.

Procurement Tab (Reference Cable Common Properties Dialog


Box)
Enables you to enter information related to ordering a specific cable for your inventory. When the
reference item is a non-sized power cable, you can edit the data; otherwise, the items are
read-only.
Manufacturer Allows you to select a manufacturer. You can define and customize
manufacturers in the Data Dictionary Manager.
Model number Allows you to select a cable model. The available models are specific to the
manufacturer. You can define and customize models in the Data Dictionary Manager.
Stores part number Allows you to enter a reference number for the cable in your inventory.

SmartPlant Electrical User's Guide

773

Windows and Dialog Boxes

Reference Control Station Common Properties Dialog Box


Enables you to associate reference cables with a reference control station that you defined in the
Reference Data Explorer.
Item tag Allows you to enter a tag name that identifies the control station.

Associated cables
Displays the reference cables that the software associates with the control station.
(Data window) Describes the properties of the associated cables. In particular, this window
shows the conductor arrangement.
Add Opens the Select Reference Cable dialog box to associate a new reference cable with
the control station.
Remove Removes the selected associated cable from the control station.

Typical I/O set


Displays a typical I/O set of signals for the control station.
Find Allows you to display all the available typical I/O sets on the Find dialog box, where you
can select the desired typical I/O set for the control station.
Clear Allows you to clear the association of the selected typical I/O set with the control station.

Schematic Sheet Properties Dialog Box


Allows you to define multiple sheets and sheet properties for a typical schematic drawing.

Sheets
Sheet Number Displays the sheet number that you typed under Sheet number in the Sheet
details group box.
Sheet Name Displays the sheet name that you typed under Sheet name in the Sheet details
group box.
Add Adds a new row to allow you to define a new sheet.
Remove Removes a selected sheet from the list. The software deletes the removed sheet
from the database after you click OK.

Sheet details
Sheet number Allows you to type a sheet sequence number for a sheet selected in the Sheets
list. You will then be able to select this sheet number and assign it to a block when editing the
properties of that typical schematic drawing.
Sheet name Allows you to type a sheet name for a sheet selected in the Sheets list.

774

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Select Reference Cable Dialog Box


You use this dialog box to select an appropriate reference cable when defining equipment profiles,
associating an instrument, control station, and so forth with a reference cable.
Cable category Allows you to select a category that defines the purpose for which the cable is
used: Power, Instrumentation, Control, or Grounding. This is a required field for this dialog
box.
Cable specification Allows you to select a filter criterion that defines a family of cables, each
consisting of a specific group of reference cables.

Cable definition
Select from cable library Allows you to select a reference cable by choosing an existing
reference cable.
Reference cable Click Select and then select an appropriate cable from the cable library.
Specify construction Allows you to associate a new plant cable which you create based on
the construction definitions below.
Conductor arrangement Allows you to define the number and arrangement of the conductors
in the cable. The following standard options are available:
Single core cable Creates a current-carrying cable with a single core. For this option, you
can specify an arrangement of any number of single-core conductors, for example, 3
single-core cables, but you cannot specify any additional conductors.
2-core cable Creates a cable with two current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
2+1-core cable Creates a cable with two current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3-core cable Creates a cable with three current-carrying conductors and no additional
conductors. You cannot modify the cable construction for this option.
3+1-core cable Creates a cable with three current-carrying conductors and one additional
conductor. You cannot modify the cable construction for this option.
3+2-core cable Creates a cable with three current-carrying conductors and two additional
conductors. You cannot modify the cable construction for this option.
Multicore cable Creates a cable with multiple conductors. For this option, you can specify
any number of conductors and additional conductors.
You can change the names of the standard conductor arrangement items in the Data
Dictionary Manager. However, the software performs calculations according to the position in the
list of the item that you select. For example, a 2-core cable is always the second item in the list.
Conductors Allows you to specify the number of conductors within the cable used for carrying
the current, excluding the neutral, the ground, or additional conductors. If you selected Singlecore or Multicore as the conductor arrangement, this option allows you to specify the number of
conductors or cores in the cable that carry the electric current.
Additional conductors If you selected Multicore as the conductor arrangement, allows you to
specify the number of additional non-current-carrying conductors, such as ground wires.

SmartPlant Electrical User's Guide

775

Windows and Dialog Boxes

Typical Circuit Common Properties Dialog Box


Sets options for defining the properties of a typical circuit.
Circuit Identifies the typical circuit. The item tag appears beside the typical circuit in the
Reference Data Explorer. Click the ellipsis button
to open a dialog box where you can
modify the tag segments that are editable.
Circuit type Displays the type of the typical circuit, which can be Incomer, Feeder, Coupler,
or Bus Riser.

Details of circuit internals


Displays the components associated with the typical circuit.
Component Type Displays the type of component in the circuit, such as a circuit breaker or a
fuse.
Component Tag Displays the component identifying tag, as shown in the Reference Data
Explorer.
Lookup Table Allows you to select a lookup table that will be associated with the
corresponding circuit internal component. You will then be able to apply this associated lookup
table to a project circuit when you run the Apply Lookup Tables feature on the Apply Options
dialog box to propagate the lookup table data to the circuit internal components.
Order Determines the position of the component in relation to the bus when the circuit contains
more than one component. The greater the value, the further the component is from the bus.
Show in SLD Indicates whether the software shows a graphical representation of the
component when you generate a single line diagram for the PDB.

Associated cables
Displays the reference cables that the software associates with the typical circuit.
(Data window) Describes the properties of the associated cables. In particular, this window
shows the conductor arrangement.
Add Opens the Select Reference Cable dialog box to associate a new reference cable with
the typical circuit.
Remove Removes the selected associated cable from the typical circuit.

Typical I/O set


Find Opens the Find dialog box, which allows you to select a typical I/O set to associate with
the typical circuit.
Clear Allows you to clear the typical I/O set association to the typical circuit.

776

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Typical Cable Block Diagram Properties


Enables you to enter and manage the properties of a typical cable block diagram. You can define
the document name, select an appropriate template, and type a description.
Document number Allows you to type the document name.
Template name Allows you to choose an appropriate template for your typical CBD.
Description Allows you to type the document description.

Display cable types in cable block diagrams


Allows you to choose the cable types to be displayed in your typical cable block diagram. You
can change the cable type at any time by opening the Typical Cable Block Diagram Properties
dialog box and selecting or clearing the relevant check boxes. Selecting a particular check box
displays the cables of that type on your cable block diagram. The available cable type options
are:
Power
Instrumentation
Control
Grounding

Typical Schematic Blocks Dialog Box


Selects blocks for use in the typical schematics that you define in the Reference Data Explorer.
Blocks Displays the list of the blocks in the database.
Add Adds a new row. You define a block and its characteristics in the Block details section of
this dialog box.
Delete Deletes the currently selected block.
Block name Allows you to enter a name for the block.
Block type Allows you to select a block type representing the item type associated with the
block, for example, a motor.
File name Displays the name of the drawing file that represents the block graphically. The
software supports file types .sym, .dwg, and .igr. Click the ellipsis button
desired file.

to navigate to the

You can only select drawing files from the default folder specified in the Options Manager; you
cannot navigate to files in any other folder.
You can click View to preview the currently selected block before selecting it.

SmartPlant Electrical User's Guide

777

Windows and Dialog Boxes

Typical Schematic Common Properties Dialog Box


Defines a typical schematic with associated blocks in the Reference Data Explorer. You use the
typical schematic as a template to generate a schematic for a specified load in the Electrical
Index.
Name Type a name for the typical schematic.
Template Select a template for the schematic. The template determines the page size and
orientation, and the border and title blocks that appear on the schematic.
Typical schematic block properties Lists the blocks that will comprise the typical schematic.
Add Adds another row that displays the block properties according to your selections under
Block details. Make sure that the blocks that you add belong to the same CAD
format. Generating a schematic drawing based on a typical schematic that uses different CAD
formats (for example, .sym and .dgn files) may result in generation errors.
Remove Removes the currently selected block from the schematic.
Block name Select a block from the available blocks in the library.
Block type Displays the block type representing the item type associated with the block, such
as a motor. This value is read-only.
Sequence This option applies for situations where there is more than one block of the same
type in the schematic. Type an integer that represents the sequence in which the software
associates the blocks with matching project items that belong to the same item type. The
software uses these sequence numbers if there are multiple project items belonging to the same
item type, for example, a schematic that contains two control station blocks that have to be
associated with project items. The software associates the block that has lowest sequence
number with the plant item that has the lowest Sequence in group attribute among the project
items belonging to same item type. Example: A typical schematic contains two blocks A and B for
which sequence numbers are 5 and 8 respectively. If used with a motor that has two control
stations CS-1 and CS-2 whose Sequence in group attributes are 3 and 8 respectively, the
software matches Block A with Control Station CS-1 and Block B with Control Station CS-2.

You can click View to preview the currently selected block before adding it to the typical
schematic.
This option is not available for multi-tag blocks.
Sheet number Allows you to assign a sheet number to the current block in the typical
schematic you are modifying or creating. The values in this list correspond to the sheets that you
create in the Schematic Sheet Properties dialog box. You can assign the same block to several
different sheets if you want the block to appear more than once on different sheets of the same
schematic. Note that you should assign a sheet to each block in the typical
schematic. Unassigned sheets are not kept in the database by the software. This option is not
available or multi-tag blocks.
X Allows you to enter a positive or negative numeric value in the CAD application units of
measure for the X-coordinate. In the generated schematic drawing, the software will shift the
relevant block on the X (vertical) axis according to the value you enter.
Y Allows you to enter a positive or negative numeric value in the CAD application units of
measure for the Y-coordinate. In the generated schematic drawing, the software will shift the
relevant block on the Y (horizontal) axis according to the value you enter.
Multi-Tag Options Opens the Multi-Tag Schematic Options dialog box where you can
specify whether to include a tag list on the main drawing page of a multi-item schematic, and the
maximum number of rows in the list to allow on the drawing sheets. This option is available when
you select a multi-tag block.

778

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Sheets Opens the Schematic Sheet Properties dialog box where you can define multiple
sheets for the current typical schematic drawing.

Reports and Report Templates


Define Report Contents Dialog Box
Defines new items to include in your report and selects the cells to include for the new items. This
dialog box opens when you click Define on the SmartPlant Reports toolbar.
Define Displays the Define Report Items dialog box. For the selected item in the Report on
tree, you define the properties that you want available for inclusion in your report template.
Delete Removes an item from the tree view and from your report structure. Its properties are no
longer available for your report template.
New Displays the New Items dialog box. You use this dialog box to specify new item types to
include in the Report on tree. If you add a new item type, its properties are available for inclusion
in your report template.
Report on Displays a tree view of item types whose properties are available for inclusion in
your report template. To include the properties, you must select an item from the Report on list
and click Define. Then you can map the properties that you select to cells in your report template.
The level into which you add an item type affects the properties that you can access for
your template. That is, a new item type added into the hierarchy under another item type does not
give you access to the same properties that you have if the item type is higher in the hierarchy. For
instance, if you add the equipment item type under nozzles, the equipment item type only reports
on equipment associated with a nozzle, and equipment without nozzles is not reported.

SmartPlant Electrical User's Guide

779

Windows and Dialog Boxes

Define Report Items Dialog Box


Specifies the report item properties available for your report. Select the properties to include for
each report item type and define sorting and filtering for those properties. This dialog box is
accessed by clicking Define on the Define Report Contents dialog box, which, in turn, is
accessed by clicking Define on the SmartPlant Reports toolbar.
Properties Tab (see "Properties Tab (Define Report Items Dialog Box)" on page 780)
Filter Tab (see "Filter Tab (Define Report Items Dialog Box)" on page 781)
Sort Tab (see "Sort Tab (Define Report Items Dialog Box)" on page 781)

Properties Tab (Define Report Items Dialog Box)


Displays properties for a report item so you can select properties to use in your report template.
This tab is part of the Define Report Items dialog box, which opens when you click Define on the
Define Report Contents dialog box.
Group by the selected property Automatically adds a special Report Item Group Total
property to the Map Properties menu on the SmartPlant Reports toolbar. The Report Item
Group Total property displays the number of items that have identical reported properties. If you
want to tally similar items in this way, be sure not to map unique properties, such as item tags,
onto your report. If you do, then items are never grouped together because a unique tag is a
property that items never share. For example, you can use this feature to give you the total
numbers of valves with 1" nominal diameter, 1.5" nominal diameter, 2" nominal diameter, and so
forth.
Repeat parent data Displays the cells of parent item data in your report. For example, if your
report contains Unit then Drawing as a child of Unit, selecting this option for Drawing causes
repetition of Unit cells on any line containing Drawing cells.
Available properties Displays all properties for the report item you specified on the Define
Report Contents dialog box.
Selected properties Lists the report item properties you have selected from the Available
properties list that are consequently available for inclusion in your report.
Left Arrow Moves the selected item in the Selected properties list to the Available
properties list. You can select more than one item by using the CTRL and SHIFT keys and then
clicking the left arrow. Also, double-clicking an item in the Selected properties list moves it to the
Available properties list.
Right Arrow Moves the selected item out of the Available properties list and into the
Selected properties list. You can select more than one item by using the CTRL and SHIFT keys
and then clicking the right arrow. Also, double-clicking an item in the Available properties list
moves it to the Selected properties list.
Use short text Displays the short text value, which is defined in SmartPlant Data Dictionary
Manager. Only select-listed properties can be displayed in their short value form. In a few cases,
the short value is longer than the regular value.
Use select list index Includes the numerical index of the select entry along with either the
short value or select list value for that property. For more information about select lists and their
values and indices, see SmartPlant Data Dictionary Manager Help.

780

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Filter Tab (Define Report Items Dialog Box)


Defines the filter that you want to use for your report item. This tab is part of the Define Report
Items dialog box, which opens when you click Define on the Define Report Contents dialog box,
which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
Applied filter Displays your selected filter. To select a new filter, type a valid filter name or click
Browse to locate a filter.
Browse Displays the Select Filter dialog box, which allows you to choose or to further define
item types for your report template.

Sort Tab (Define Report Items Dialog Box)


Defines the cells that you use to sort the report items and how. This tab is part of the Define
Report Items dialog box, which opens when you click Define on the Define Report Contents
dialog box, which, in turn, opens when you click Define on the SmartPlant Reports toolbar.
Available properties Lists all the properties of your report item.
Down Arrow Moves the selected item down in sorting priority.
Left Arrow Moves the selected item in the Sort properties list to the Available properties list.
You can select more than one item and then click this button. Also, double-clicking an item moves
it to the Available properties list.
Order Specifies the sorting order (ascending or descending) for the report data.
Right Arrow Moves the selected item in the Available properties list to the Sort properties
list. You can select more than one item and then click this button. Also, double-clicking an item
moves it to the Sort properties list.
Sort properties Displays the properties selected for sorting.
Up Arrow Moves the selected item up in sorting priority.

Delete Report Template Dialog Box


Displays a list of available report templates. You can delete a selected report template if you have
the proper privileges, granted in SmartPlant Engineering Manager. This dialog box opens when
you click Reports > Delete on the main menu bar.
Available Reports Lists all available report templates.

Edit Report Template Dialog Box


Displays a list of available report templates and opens the selected report template in Microsoft
Excel so that you can make changes to it. Click Properties to view and update properties for a
report template. This dialog box opens when you click Reports > Edit on the main menu bar.
Available reports Lists all report templates available to edit or customize. Select a template
from the list.
Properties Displays the Report Properties dialog box where you can modify the description
and the report template format.
Open Displays the selected template in Microsoft Excel.
You must have the correct privileges, granted in SmartPlant Engineering Manager,
to edit plant-level report templates.

SmartPlant Electrical User's Guide

781

Windows and Dialog Boxes

My Reports Dialog Box


Allows you to choose one of your custom reports and to specify what items to report on. This
dialog box opens either when you click Reports > My Reports on the main toolbar or when you
click View > My Reports on the Engineering Data Editor toolbar. If you want to run a report on
drawing items, use the Reports menu; if you want to run a report on table items, use the
Engineering Data Editor menu.
Report using Displays options for specifying the scope of your report. The options that appear
in this area depend on whether the Drawing view or Engineering Data Editor is active when you
access this dialog box.
Current Selection Produces a report containing the items currently selected in your drawing or
table. This option is not available if no drawing or table items are selected. You cannot choose the
Include items in drawing stockpile option when you choose Current Selection.
Entire drawing Produces a report containing the contents of the entire drawing. This option is
available only when you use the Reports menu command.
Include items in drawing stockpile Allows you to specify whether or not you want items that
reside in the drawing stockpile in your report. This option is available only when you use the
Reports menu command, not the Engineering Data Editor command.

New Items Dialog Box


Opens when you click New on the Define Report Contents dialog box and displays a list of items
that are related to the item that you selected there. Select an item type to make its properties
available to include in your report.
Apply Adds the selected item type to the Report on tree on the Define Report Contents
dialog box. The software adds this item type as a child of the item type selected on the Define
Report Contents dialog box.
The level into which you add an item type affects the properties that you can access for
your template. That is, a new item type added into the hierarchy under another item type does not
give you access to the same properties that you have if the item type is higher in the hierarchy. For
instance, if you add the equipment item type under nozzles, the equipment item type only reports
on equipment associated with a nozzle, and equipment without nozzles is not reported.
Items related to Displays a list of item types related to the item type that you selected in the
Report on tree on the Define Report Contents dialog box. Select item types from this list to
include in your report template. The properties of the new item types are then available to use in
your report.
Name Displays the name of the selected item type. You can rename the item. If you have
duplicate item type names in your report item type hierarchy, the software prompts you to rename
the new item type uniquely.

782

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

New Report Template Dialog Box


Displays options for creating plant-level and user-level report templates. This dialog box opens
when you click Reports > New on the main menu bar.
Source template Lists the names of all existing report templates and Blank. You select a
user-level template, plant- level template, or Blank. The Blank option creates a Microsoft Excel
workbook with no predetermined formatting information. If you chose Blank, you must specify an
item type; whereas, if you do not choose Blank, the item type automatically displays the item type
that corresponds to your source template. Templates in this list appear in alphabetical order.
Name Allows you to enter a meaningful name to describe the report that you are creating. This
name matches your Microsoft Excel workbook. The software appends .xls to the name when you
save the Excel workbook.
Item type Defines the item properties available in your report. If you do not select a Blank
source template type, then the Item type option automatically displays the item type that
corresponds to your source template.
Report Type Specifies your report format. Available options include fixed, tabular, and
composite. All delivered report templates are tabular format.
Fixed format Creates one Microsoft Excel worksheet for each item. You only edit the first
worksheet, but all fixed format worksheets, one for each item of the report item type, follow the
format of the first worksheet when you generate your report. The Options button on the
SmartPlant Reports toolbar is not available for editing a fixed format report template because
you are free to place headers and data anywhere you want on your worksheet.
Tabular format Formats your report in a table. That is, the properties of each item included in
your report begin on a unique row, or the template format is row-based. All delivered reports are
tabular format.
Composite format Formats your report in a combination of fixed and tabular formats. The first
sheet in the workbook is Fixed format; the second sheet is Tabular format. Subsequent fixed
format worksheets are created after sheet two for each item of your report item type when you
generate your report.
Description Describes the report type that this template produces. You can assign any
description.

Plant Reports Dialog Box


Allows you to choose a report and specify what items to report on. This dialog box opens either
when you click Reports > Plant Reports on the main toolbar or when you click View > Plant
Reports on the Engineering Data Editor toolbar. If you want to run a report on drawing items,
use the Reports menu; if you want to run a report on table items, use the Engineering Data
Editor View menu.
Current Selection Produces a report containing the items currently selected in your drawing or
table. This option is not available if no drawing or table items are selected. You cannot choose the
Include items in drawing stockpile option when you choose Current Selection.
Entire drawing Produces a report containing the contents of the entire drawing. This option is
available only when you use the Reports menu command.

SmartPlant Electrical User's Guide

783

Windows and Dialog Boxes

Report Options Dialog Box


This dialog box allows you to set various options for a report template. You can specify the
number of blank lines between each row between in your report, the number of rows in your report
header, and sort the map properties.
This dialog box opens when you click Options on the SmartPlant Reports toolbar in Microsoft
Excel.
Skip lines between rows Defines the number of blank lines between each row in your report.
You can enter a value in the box or use the scroll buttons to select a value. The maximum value
allowed is 1000.
Rows in report header Specifies the number of rows in your report header.
The Options command is available for tabular and composite format report templates only.
It is not available for fixed format report templates because you are free to place captions and
properties in any configuration that you want. In fixed format report templates, you are not
constrained to have a header or rows at all.
'Map Properties' sort order Allows you to sort the properties in the report the report template.
These properties are available when you click Map Properties on the report template toolbar.
Ascending Sorts the list of properties in the report template in ascending alphabetical
order.
Descending Sorts the list of properties in the report template in descending alphabetical
order.
None Leaves the properties in the original order in which they appear in the list.

When sorted in ascending or descending order, the properties that have sub-properties
appear first sorted alphabetically, followed by the properties that do not have sub-properties,
sorted alphabetically.
For a summary report, the list entry Report Item Group Total that appears at the lowest level
is always at the bottom of the list, regardless of the sort order selected.

Report Preferences Dialog Box


When generating an enhanced all feeder load summary report, allows you to set your preferences
for the electrical consumption values displayed in the report.
Compensated/uncompensated values Allows you to select an option that instructs the
software to display either compensated or uncompensated values.
Consumed/rated values Allows you to select an option that instructs the software to display
either consumed or rated power values.

784

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Report Properties Dialog Box


Displays properties for plant-level and user-level report templates. This dialog box opens when
you click Properties on the Edit Report Template dialog box.
Source template Displays the names of all existing report templates and Blank. You select a
user-level template, plant- level template, or Blank. The Blank option creates a Microsoft Excel
workbook with no predetermined formatting information. If you choose the Blank option, you must
specify an item type; whereas, if you do not choose Blank, the software automatically specified
the Item type option as the item type that corresponds to your source template. Templates in this
list appear in alphabetically.
Name Allows you to enter a meaningful name to describe the report that you are creating. The
name matches your Microsoft Excel workbook. The software appends .xls to the name when you
save the Excel workbook.
Item type Defines the item properties available to populate your report. If you select a source
template other than Blank, the Item type option is automatically specified with the item type that
corresponds to your source template.
Report Type Specifies your report format. Available options include fixed, tabular, and
composite.
Fixed format Creates one Microsoft Excel worksheet for each item. You only edit the first
worksheet, but all fixed format worksheets, one for each item of the report item type, follow the
format of the first worksheet when you generate your report. The Options button on the
SmartPlant Reports toolbar is not available for editing a fixed format report template because
you are free to place headers and data anywhere you want on your worksheet.
Tabular format Formats your report in a table. That is, the properties of each item included
in your report begin on a unique row, or the report format is row-based. All delivered report
templates are tabular.
Composite format Formats your report in a combination of fixed and tabular styles. The
first sheet in the workbook is fixed format; the second sheet is tabular format. When you
generate your report, the software creates subsequent fixed format worksheets after sheet
two for each item that matches your report item type.
Description Describes the report type that this template produces. You can assign any
description.

Schematics
Batch Generate Schematics Dialog Box
Allows you to print and set save options for the schematics you generate in batch mode.

Save options
Save files Saves the generated drawings as external files.
Path Allows you to type the file path or click Browse to navigate to the folder where you want to
save the drawings. The software automatically displays the default path that you have set for
your drawings in the Options Manager.
Save as type Allows you to select a file format for the drawings you want to save.
Print drawings Prints out all the drawings that you are generating.

SmartPlant Electrical User's Guide

785

Windows and Dialog Boxes

Generate Schematic Dialog Box


Enables you to generate a schematic drawing for a selected item in the Electrical Index based on
a typical schematic that includes the drawing blocks and macros that you require for the
generation.
Typical schematic Select a typical schematic that you created in the Reference Data
Explorer.
Drawing name Type a name of the schematic you are generating.
Load name Displays the selected load for which you are generating a schematic.
Blocks Tab (see "Blocks Tab (Generate Schematic Dialog Box)" on page 786)
Macros Tab (see "Macros Tab (Generate Schematic Dialog Box)" on page 786)
Unresolved Items Tab (see "Unresolved Items Tab (Generate Schematic Dialog Box)" on page
787)

Blocks Tab (Generate Schematic Dialog Box)


Displays the data of the blocks that comprise the typical schematic that you selected in the
Typical schematic list.
Typical schematic Select a typical schematic that you created in the Reference Data
Explorer.
Drawing name Type a name of the schematic you are generating.
Load name Displays the selected load for which you are generating a schematic.

Data window
Block Type Displays the block type (motor, circuit, or control station) of the selected block.
Item Name Displays the name of the electrical item with which the block is associated. You
can change this association in the Block details group box.
Block Name Displays the name of the typical block.
X Displays the X block displacement coordinate from the page origin. The software takes this
value from the properties of the associated typical schematic.
Y Displays the Y block displacement coordinate from the page origin. The software takes this
value from the properties of the associated typical schematic.
File Name Displays the name of the graphic file that the typical block is associated with.

Block details
Block type Displays the block type that the selected typical block belongs to.
Item name Displays the electrical item that the selected typical block is associated
with. Select another electrical item if you want to change this association.
Block name Displays the name of the selected typical block.
Sheet number Displays the sheet number that is assigned to the selected typical block. The
software displays a sheet number only if the selected typical schematic contains multiple sheets.

Macros Tab (Generate Schematic Dialog Box)


Displays the data of the macros that you have defined for the typical blocks

786

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Typical schematic Select a typical schematic that you created in the Reference Data
Explorer.
Drawing name Type a name of the schematic you are generating.
Load name Displays the selected load for which you are generating a schematic.

Data window
Item Name Displays the name of the electrical item that the selected macro is associated with.
Macro Item Type and Sequence Displays the macro item type and the item sequence for
macro items belonging to the same item type defined for the same typical block.
Macro Item Name Displays the name of the electrical item that the selected macro is
associated with.

Macro details
Macro item type and sequence Displays the macro item type and the item sequence for
macro items belonging to the same item type defined for the same typical block.
Macro item name Displays the name of the electrical item that the selected macro is
associated with. Select another electrical item if you want to change this association.
Show macros of selected block Allows you to select to display the macro data for the block
you selected in the Block tab folder.
Show all macros Allows you to select to display the macro data for all the blocks you
belonging to the selected typical schematic.

Unresolved Items Tab (Generate Schematic Dialog Box)


Displays the item tags associated with the current load and which do not have corresponding
items in the associated typical schematic.
Typical schematic Select a typical schematic that you created in the Reference Data
Explorer.
Drawing name Type a name of the schematic you are generating.
Load name Displays the selected load for which you are generating a schematic.
Item Name Displays the associated item tags for which there no corresponding items in the
typical schematic.

SmartPlant Electrical User's Guide

787

Windows and Dialog Boxes

Multi-Tag Schematic Options Dialog Box


When you create a multi-tag schematic drawing, you use this dialog box to specify the layout of
the tag-specific data used in the typical schematic. You can specify whether to include tabular
data on the drawing pages that display graphical items, and the maximum number of rows for
displaying data on the drawing sheets and other sheets. Note that when saving a multi-tag
schematic as an external file, you need to save each page of the schematic as a separate
drawing.

Main drawing sheet details


Include tag list Select if you want to display tag data in a table on the drawing sheet that
contains the graphics as well as on subsequent drawing sheets without graphics. For a
multi-sheet drawing, the software displays the data only on the last drawing sheet and subsequent
sheets. Clear to display the tag data on subsequent sheets only.
Maximum number of rows Allows you to specify the maximum number of data rows that the
software displays on drawing sheets that contain graphics. This option is available only when you
select Include tag list.
Maximum number of rows on subsequent sheets Allows you to specify the maximum
number of data rows that the software displays on subsequent drawing sheets that do not show
graphics.

Options Dialog Box


Sets options for the current document. For example, you can set the grid display by clicking the
View tab.

Colors Tab (Options Dialog Box)


Controls color settings for the active document.
Sheet - Sets the default color of all drawing sheets in the active document.
Sheet color is stored in the file. However, when you specify a sheet color on the
Colors tab, it will override the sheet color stored in previously saved files. To allow the display of a
saved sheet color, access the Colors tab and select Default before re-opening the drawing file.
Highlight - Sets the highlight color.
Selected Element - Sets the color of selected elements.
Disabled Elements - Sets the color of disabled elements. This setting can also define the color of
relationship indicators and their corresponding glyphs if Maintain Relationships is disabled. Select
Tools > SmartSketch Settings to see the relationship indicators and their corresponding glyphs
or images.
Handles - Sets the color of handles when an element is selected. Also, if Maintain Relationships is
enabled, the Handles option sets the color for the relationship indicators that display during
element placement.
If you set the sheet color the same as another control setting, the control color setting and
the cursor color is automatically changed to a complementary color. For example, if you have both
the Selected Element color and the Sheet color set to Yellow, the sheet background displays
yellow and the selected elements display in a complementary blue color.

788

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

General Tab (Options Dialog Box)


Controls settings such as the display of 3-D effects and the number of entries in the list of recently
used files.
Update Links Automatically At Open - Updates links automatically when the document is open
and this option is set.
Recently Used Files List - Sets the number of entries for the Recent Files area of the File menu
when the Recent Files area is set.
Dimension Keyin Values Automatically - Places dimensions for recognized step values or for
values you type in a ribbon field while drawing a geometric element. For example, select
Rectangle on the Draw toolbar. On the ribbon, type a value in the Width, Height, and/or Angle
fields, press <Enter> or <Tab>, and then click the location in the Drawing sheet where you want
to place the rectangle.

Display Unit Of Measurement Labels - Displays the units of measurement in the value field.
Set printer paper size to sheet size - Automatically sets the printer paper size to match the
sheet size (if the printer supports that size).
Display XY coordinate readout - Displays the XY coordinate of the cursor position in the right
side of the application window status bar.
Undo Steps - Sets the number of operations that can be undone.
Middle Button Operation - Sets up the middle mouse button so that it can be used for either
scrolling or panning. The default action of the middle mouse button is Windows Scrolling.

File Locations Tab (Options Dialog Box)


Specifies the default location for documents, templates, and other objects you create or use in the
software. You can use the following types of documents:
Documents
User-defined templates
Fonts
Macros
MicroStation references
AutoCAD references

SmartPlant Electrical User's Guide

789

Windows and Dialog Boxes


File Types - Indicates the file type for which you want to specify a location.
Location - Displays the designated location for each file type.
Modify - Accesses the Modify Location dialog box. The directory selected with the dialog box is
displayed in the Location column on this tab. After you select a location, you can delete it later by
selecting the location in the Location column and pressing Delete.

View Tab (Options Dialog Box)


Controls the appearance of the software and document window, such as the display of the graph
paper, ruler, and scroll bar.
Display as printed - Displays the drawing as it appears on paper. This option is enabled by
default.
Style view scale - Controls the width of linear styles as displayed on the screen. This option is
only available when Display as printed is disabled and will not apply to printed drawings.
Maximum line width - Sets the maximum width allowed for the display linear styles. This option is
only available when Display as printed is disabled and will not apply to printed drawings.
Reset - Resets Style view scale and Maximum line width to their default values. This option is
only available when Display as printed disabled.
Window - Controls the window display.
Vertical Scroll Bar - Displays the vertical scroll bar of the active window.
Horizontal Scroll Bar - Displays the horizontal scroll bar of the active window.
Status Bar - Displays the status bar of the application.
Sheet Tabs - Displays the drawing sheet tabs.
Grid - Sets options for the grid.
The grid display option must be checked from the view menu before these settings will be
visible.
Grid Display - Displays a grid so that you can place elements with precision. The grid lines are
not considered part of the document and do not print.
Grid Snap - Aligns elements with the grid. The grid is an invisible set of lines in the document that
helps you align elements. When you set Grid Snap, elements always align with the grid lines or
nearest intersection of the grid lines.
Grid Style - Changes the format of the grid lines to either static or dynamic. When you zoom in or
out, the software dynamically generates the grid lines for a dynamic grid. You can set dynamic grid
lines to appear at fine, medium, or coarse levels. The grid lines appear at common major
measurement increments. A dynamic grid displays index lines that intersect with the darker, solid
grid lines. A static grid displays solid grid lines that do not move as you zoom in or out. The grid
maintains a constant minimum spacing.
Grid Index - Determines the number of index grid lines, also known as minor grid lines, to be
equally spaced between the major grid lines. This option is available only if you select Static in the
Grid Style list box.
Grid Spacing - Sets the spacing of the major grid lines. This option is available only if you select
Static in the Grid Style list box. The selected options on the Units tab of the Properties dialog
box determine the units that you can enter, such as inches or centimeters.
You can open the Properties dialog box by clicking Properties on the File menu.
Grid Density - Changes the number of dashes in the index lines, or minor grid lines, between
intersections with the grid lines. This option is available only if you select Dynamic in the Grid
Style list box.

790

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Sheet outline - Sets options for the outline of the drawing sheet.
Display - Displays the outline of a drawing sheet so you can view its boundaries.
Use during fit - Specifies whether or not to use the sheet outline during a fit.

Symbols Tab (Options Dialog Box)


Determines the default actions when you drag a symbol into the document. You can override the
settings on this tab when you drag a symbol. You can press Ctrl to embed the symbol or Ctrl +
Shift to link the symbol.
Drag and Drop Default - Specifies actions when you drag a symbol into the document.
Embed - Sets the default action so that the symbol embeds when you drag it on the drawing
sheet. Embedding the symbol means that the software places a copy of the symbol in the
document. If you edit one instance of the embedded symbol in a document, all copies of that
symbol within the current document reflect those changes.
Link - Sets the default action so that the symbol is linked when you drag it into the document.
Linking the symbol allows you to edit the original symbol document. The symbol that you placed
on the drawing sheet updates automatically. If you edit the symbol inside the active document,
those changes are saved in the .sym document on your computer.

Reference Files Tab (Options Dialog Box)


Scale - Sets a scale option for importing a document.
Coincident - Brings in a reference file, also known as an inserted object, at full scale (1:1) and
coincident to its original coordinate position. The setting shifts the drawing sheet to the lower left of
the document graphic range and then determines a drawing sheet scale that fits the reference file
within the sheet. If the current document already contains graphics, the drawing sheet shifts to
include those graphics.
If you use the Coincident setting, the reference file does not appear when you drag the
pointer.
Select Scale - Sets the drawing scale to a standard ratio. The specified ratio defines the size of
the drawing in relation to the size of the real-world object. For a 2:1 ratio, 2 represents the size of
the drawing and 1 represents the size of the real-world object.
Fit to Sheet determines a drawing sheet scale that fits the reference file within the sheet, but
allows you to specify where to insert the file by clicking on the drawing sheet.
Custom Scale - Sets the scale that you type in the boxes for a document that you insert or drag.
For example, when you type in 3 and 2 in each of the respective boxes, the scale of the foreign
document is one-and-a-half times its original size.

SmartPlant Electrical User's Guide

791

Windows and Dialog Boxes

Foreign Data Tab (Options Dialog Box)


The Foreign Data tab is only available on the Options dialog box if you install the
Translators option.
Sets options for moving information into the current document by dragging a document or by
clicking one of the following commands:
Paste Special on the Edit menu
Object on the Insert menu
Open on the File menu.
Format - Sets the type of format that you can use for importing or saving a document. When you
click MicroStation or AutoCAD and then click the appropriate Options, you can access a specific
dialog box to set options for importing or saving AutoCAD (.dxf, .dwg) or MicroStation (.dgn)
documents.
Import - Sets options for importing an AutoCAD or MicroStation document.
File Units - Sets the units for the document you want to import. When you insert or drag a
document into the drawing sheet, the software uses this setting only when the document has units
assigned that the software does not recognize.
Orientation - Sets the orientation for the document that you want to import.
Options - Accesses one of the dialog boxes for importing an AutoCAD or MicroStation document.
Export - Sets options for exporting an AutoCAD or MicroStation document.
Options - Accesses a dialog box for exporting an AutoCAD or MicroStation document.

MicroStation Import Options Dialog Box


Controls how a MicroStation document is opened or inserted into the current document.
To use this functionality, you must install the Translators option.
General Tab (MicroStation Import Options Dialog Box)
Cell Library - Sets options for translating MicroStation cell libraries. When a cell library is
imported, a symbol document with an .sym extension is created.
Units of Resolution - Determines the sub-unit and positional unit settings for MicroStation cell
libraries. Cell libraries do not have units and depend on the MicroStation document for their units
of resolution. These settings have no effect on translating documents with a .dgn extension; the
settings only affect documents with a .CEL extension.
Cells - Sets options for importing cells in MicroStation documents. When you import a
MicroStation document, a temporary folder is created in the Temp folder on your computer. The
temporary folder contains the symbols that are embedded in the MicroStation document. By
default, these symbols are deleted after the document is imported into the drawing sheet. You can
change a setting in ITMSTN.INI to save the symbols instead. In Notepad, open ITMSTN.INI and
change the following line in the Options section: Delete Symbol Definitions = 0.
Options - Determines if cells are imported as elements on the drawing sheet or embedded
symbols. Symbol documents have an .sym extension. For example, type 2 cells are imported as
groups and shared cells, type 34, are imported as symbols.
Template File - Specifies the path and filename for the template that you want to use to create a
document.
Browse - Accesses the Browse dialog box.
Fit imported data to active sheet - Places the MicroStation data on the active drawing sheet. If
the checkbox is not selected, the imported data is placed on a new drawing sheet.

792

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Font Tab (MicroStation Import Options Dialog Box)
Maps the software font to a MicroStation font.
Linestyle Tab (MicroStation Import Options Dialog Box)
Maps the MicroStation line styles to line style definitions in the software. The core MicroStation
line styles (0 - 7) default to equivalent SmartSketch line styles unless they are mapped on the
Linestyle Tab.
The number values listed below can be used in the line style table to map MicroStation line
styles to line style definitions in the software. When mapping line styles use the line style number,
not the line style name.
MicroStation

SmartSketch

Line Style

Number

Line Style

Number

Solid

Normal

Dotted

Dashed

10

Medium Dotted

Dotted

11

Long Dotted

Dash Dot

12

Dot Dash

Dash 2Dot

13

Short Dash

Chain

18

Dash Dot Dot

Double Chain

20

Long Short Dash

2Dash Dot

21

Line Width Tab (MicroStation Import Options Dialog Box)


Maps the MicroStation weights to line widths in the software.

MicroStation Export Options Dialog Box


Controls how a document will be translated to a MicroStation file format.
To use this functionality, you must install the Translators option.

General Tab (MicroStation Export Options Dialog Box)


Version - Specifies the version of MicroStation you want to use.
Seed File - Specifies the path of a default seed file that contains appropriate units, color tables,
and other important information.
When you specify a 2D seed file while exporting a 3D MicroStation reference file from
the current document, the 3D reference file is not saved in MicroStation. For the 3D MicroStation
reference file to be saved in MicroStation, you must specify a 3D seed file on the MicroStation
Export Options dialog box.
Browse - Displays the Seed File dialog box.
Font Tab (MicroStation Export Options Dialog Box)
Maps the fonts in the software to a MicroStation font.
Linestyle Tab (MicroStation Export Options Dialog Box)
Maps the line styles in the software to MicroStation line styles.

SmartPlant Electrical User's Guide

793

Windows and Dialog Boxes


The number values listed below can be used in the Linestyle table to map line styles in the
current document to MicroStation line styles. When mapping line styles, use the line style number;
not the line style name.
SmartSketch

MicroStation

Line Style

Number

Line Style

Number

Normal

Solid

Dashed

10

Dotted

Dotted

11

Medium Dotted

Dash Dot

12

Long Dotted

Dash 2Dot

13

Dot Dash

Chain

18

Short Dash

Double Chain

20

Dash Dot Dot

2Dash Dot

21

Long Short dash

Line Width Tab (MicroStation Export Options Dialog Box)


Maps the software line widths to MicroStation weights.
Layer Tab (MicroStation Export Options Dialog Box)
Layer Mapping Table - Displays an alphanumeric ordered list of the layers.

AutoCAD Import Options Dialog Box


Controls how an AutoCAD document is opened or inserted into the current document.
To use this functionality, you must install the Translators option.

General Tab (AutoCAD Import Options Dialog Box)


Blocks - Specifies whether an AutoCAD block is imported as an embedded symbol or a group of
elements. An embedded symbol document has a .sym extension. When you import an AutoCAD
document, a temporary folder is created in the Temp folder on your hard drive. The temporary
folder contains the symbols that are embedded in the AutoCAD document. By default, these
symbols are deleted after the document is imported into the drawing sheet. You can change a
setting in ITACAD.INI and change the following line in the Options section: Delete Symbol
Definitions = 0.
Template File - Specifies the path and filename for the template that you want to use to create a
document.
Browse - Displays the Browse dialog box.
Fit imported data to active drawing sheet - Places the AutoCAD data on the active drawing
sheet. If the checkbox is not selected, the imported data is placed on a new drawing sheet.
Font Tab (AutoCAD Import Options Dialog Box)
Maps AutoCAD fonts to system TrueType fonts.
SmartSketch supports system TrueType fonts. AutoCAD-compiled shape fonts (.shx) and
postscript binary fonts (.pfb) are not supported. Many of the standard AutoCAD fonts are
pre-mapped to their most equivalent TrueType fonts. If a font is not mapped, it defaults to the
font specified in the first entry in the font mapping list.

794

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Linestyle Tab (MicroStation Import Options Dialog Box)
Maps the MicroStation line styles to line style definitions in the software. The core MicroStation
line styles (0 - 7) default to equivalent SmartSketch line styles unless they are mapped on the
Linestyle Tab.
The number values listed below can be used in the line style table to map MicroStation line
styles to line style definitions in the software. When mapping line styles use the line style number,
not the line style name.
MicroStation

SmartSketch

Line Style

Number

Line Style

Number

Solid

Normal

Dotted

Dashed

10

Medium Dotted

Dotted

11

Long Dotted

Dash Dot

12

Dot Dash

Dash 2Dot

13

Short Dash

Chain

18

Dash Dot Dot

Double Chain

20

Long Short Dash

2Dash Dot

21

Line Width Tab (AutoCAD Import Options Dialog Box)


Maps a line width for the current document to an AutoCAD color.
Default Width - Defines the width to assign to all AutoCAD entities that do not have width or
color-to-width mapping.

AutoCAD Export Options Dialog Box


Controls how a document will be saved to AutoCAD file format.
To use this functionality, you must install the Translators option.
General Tab (AutoCAD Export Options Dialog Box)
Version - Specifies the version of AutoCAD you want to use. Click the Version arrow to see the
AutoCAD versions that are supported for export. Select the version you want to use.
Prototype DWG File - Specifies the default prototype drawing (.dwg) file to use during translation.
This document can contain appropriate styles, color tables, and other preconfigured settings.
Browse - Displays the AutoCAD Template File dialog box.
Font Tab (AutoCAD Export Options Dialog Box)
Maps the fonts in the current document to AutoCAD-compiled shape fonts (.shx), AutoCAD
postscript binary fonts (.pfb), or system TrueType fonts (.ttf).
If a font is not mapped, it defaults to the font specified in the first entry in the font mapping
list.
Linestyle Tab (MicroStation Export Options Dialog Box)
Maps the line styles in the software to MicroStation line styles.

SmartPlant Electrical User's Guide

795

Windows and Dialog Boxes


The number values listed below can be used in the Linestyle table to map line styles in the
current document to MicroStation line styles. When mapping line styles, use the line style number;
not the line style name.
SmartSketch

MicroStation

Line Style

Number

Line Style

Number

Normal

Solid

Dashed

10

Dotted

Dotted

11

Medium Dotted

Dash Dot

12

Long Dotted

Dash 2Dot

13

Dot Dash

Chain

18

Short Dash

Double Chain

20

Dash Dot Dot

2Dash Dot

21

Long Short dash

Line Width Tab (AutoCAD Export Options Dialog Box)


Maps a line width in the current document to an AutoCAD color.
Polyline Width Threshold - Defines the threshold used to determine when polylines with width
must be created.

Customize the Software with the Options Command


You can use Options on the Tools menu to customize the software. You can change such things
as the screen appearance, document location, and display colors.
1. Click Tools > Options.
2. On the Options dialog box, select the tab containing the information you want to customize.
3. Use the controls on the Options dialog box to make the appropriate changes.

Set File Locations


1.
2.
3.
4.

Click Tools > Options.


On the Options dialog box, click the File Locations tab.
Select one of the file types in the list.
Click Modify and, on the Modify Location dialog box, select the directory where you want the
software to look for the file type.

You can set the software to look for files on another machine. To connect to another
machine, click the Modify button to define other directories or network paths.

796

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Sheet Setup Dialog Box


Defines the properties of the active drawing sheet.

Size and Scale Tab (Sheet Setup Dialog Box)


Defines details for the drawing sheet size, scale, and print setup information.
Sheet size Sets the size for the drawing sheet.
Same as print setup Sets the drawing sheet size using the current print setup definition. For
example, if the printer is set up as 8 1/2 X 11, the drawing sheet size is set up as 8 1/2 X 11.
Standard Defines the drawing sheet size from a list of standard ANSI and ISO paper sizes.
Custom Defines the drawing sheet size according to the entered width and height values.
Drawing scale Sets options for the scale of the drawing sheet.
Scale (1:1) Sets the drawing scale to a 1:1 ratio. As a result, the representation of the objects
on the drawing sheet is the same size as the real- world object being described.
Select Scale Sets the drawing scale to a standard ratio. The specified ratio defines the size of
the drawing in relation to the size of the real-world object. For a 2:1 ratio, the 2 represents the size
of the drawing and the 1 represents the size of the real-world object.
Custom Defines a custom or scale ratio. The first value defines the distance on the drawing
sheet and the second value defines what this distance is equal to in the real world.
Paper units Sets the paper units for the drawing sheet.
Units Controls the display of numeric values in dialog boxes that define the size of non-scaled
objects. Some examples of non-scaled object values are text height and line width. This setting
does not affect dimension units.
Only value boxes use this option. For example, if you are working in feet and inches, you can
specify that you want to read and enter values for text height in fractional inches. (1/8" instead of
0.00'-0.125")
When printing or plotting a drawing sheet, the non-scaled items appear on the printed
document with the exact size that you specify.
Precision Sets the number of significant figures to display, or the accuracy of the unit readout
value. The precision setting does not change the numbers that you can type in the fields, only the
display of the numbers in the field. Values ending in 5 are rounded up to the next whole number.
For example, if you set this control to .001 and you draw a line that is 2.1056 inches, then the line
length value is rounded. The length value appears as 2.106 inches. If you set this control to 0.01
and you type a line length value of 3.5 mm, the length value appears as 3.50 mm.

Background Tab (Sheet Setup Dialog Box)


Defines the color, margin settings, and background sheet display information.
Background sheet Specifies the background sheet that you want to use for the working sheet.
If you have not created a background sheet, this box does not display any options. You must first
create a background sheet before you can select it from the list.
All graphics on the background sheet display on the working sheet. Changing the background
sheet updates the size and margin settings of the working sheet to the values defined by the
selected background sheet.
Show background Displays the background sheet graphics on the selected working sheet.
Preview Displays the range of the graphic to print on the printer paper.

SmartPlant Electrical User's Guide

797

Windows and Dialog Boxes

Name Tab (Sheet Setup Dialog Box)


Defines the name of a drawing sheet. You can also change the name of a drawing sheet.
Sheet name Specifies a name for the drawing sheet. You can also use this box to rename a
drawing sheet by selecting the sheet in the document before clicking Sheet Setup on the File
menu.

Single Line Diagrams


Single Line Diagram Options Dialog Box
Enables you to define generation settings for single line diagrams.
General Tab (see "General Tab (Single Line Diagram Options Dialog Box)" on page 799)
Source Definitions Tab (see "Source Definitions Tab (Single Line Diagram Options Dialog Box)"
on page 801)
Page Settings Tab (see "Page Settings Tab (Single Line Diagram Options Dialog Box)" on page
801)
Circuit & Internals Tab (see "Circuits & Internals Tab (Single Line Diagram Options Dialog Box)"
on page 802)
Buses Tab (see "Buses Tab (Single Line Diagram Options Dialog Box)" on page 803)
Related Equipment Tab (see "Related Equipment Tab (Single Line Diagram Options Dialog Box)"
on page 807)
Miscellaneous Tab (see "Miscellaneous Tab (Single Line Diagram Options Dialog Box)" on page
809)

798

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

General Tab (Single Line Diagram Options Dialog Box)


Enables you to define the document number, SLD type, and other general settings for a single line
diagram.

Document
Allows you to define a document name and description of a single line diagram that you are going
to generate.
Document number Allows you to type an SLD name.
Description Allows you to type a short SLD description.

SLD type
Allows you to select a type of SLD that you want to generate. These options are not available
when generating PDB-based single line diagrams.
Conventional Generates a full and unfiltered single line diagram that includes all the
associated cables, converting equipment, and loads.
Overall Generates an SLD that displays multiple levels of buses but does not include
individual loads. The following table specifies the items that are included in overall SLDs:

Item

Displayed in SLD

Power sources

Shown

Buses

Shown including their incomers. If there are bus incomers that


are not part of the SLD scope, the SLD displays the references to
their feeders. Also, overall SLDs show coupled buses and their
incomers and feeders.

Circuit internals

Shown according to the settings on the Circuits & Internals tab.

Feeder circuits

Shown only if connected to a transformer, battery bank, UPS,


incomer circuit, or any load that is shown in the SLD.

Converting
equipment

Shown

Loads

Not shown apart from motors and heaters that have a minimum
rated power setting defined on the Miscellaneous tab.

Cables and
busways

User-defined. You can show or hide cables and busways as you


require. Note that if you choose to display the cables, the
software will show only those cables that are connected to the
loads included in the current SLD.

Based on bus rated voltage Generates an SLD based on the bus rated voltage that you
select from the list below.
Electrical analysis SLD Generates a single line diagram that you can publish to an
electrical analysis application such as ETAP. Also, after selecting this option you have to
define the options for circuits and circuit internals on the Circuits and Internals tab.

SmartPlant Electrical User's Guide

799

Windows and Dialog Boxes


Include in SLD
Enables you to define the scope of the source data that you want to include in a single line
diagram that you generate for electrical items in the Electrical Engineer. Note that these options
do not apply to SLDs based on power distribution boards.
All items powered from the selected source Generates an SLD for the electrical items you
selected in the Electrical Engineer (shown in the box below). The SLD will include the selected
items and all the items powered from the selected sources. The software will generate an SLD
where the selected electrical items are the origin points from which the power network is drawn.
The selected sources and their sub-items in the Expanded Electrical Engineer
Generates an SLD for the selected sources. To use this option, expand the required Electrical
Engineer hierarchy and then select the items that will be the SLD entry points. The SLD will
include only the selected items and their sub-items located under them in the expanded hierarchy
of the Electrical Engineer. Note that this option is not available for SLDs generated from the
Electrical Index.
The selected sources and the items connected below the specified number of bus levels
Generates an SLD for the selected items in the Electrical Engineer and in the Number of bus
levels box, type the number of bus levels below the selected sources to be included in the
SLD. The SLD will display the selected items and all the items connected to the specified number
of bus levels below the source. The SLD will also include the buses at the levels you define, all
the circuits belonging to these buses down to the incomer connections or until their electrical end.
Feeder display options (available only when generating SLDs for power distribution boards)
Allows you to select an option that determines the extent of the downstream branch display in the
generated SLD. The following three options are available:
Do not show downstream branch items Instructs the software to show only PDB
internal items: buses, cells, circuits, and circuit internals. The items that are connected
directly to the PDB internal items will be represented by a reference label.
Show all items in the downstream branch up to the first load Instructs the
software to show all the items in the feeder branch up to the first equipment item that is
defined as load. If this load is connected to a downstream equipment item, the generated
SLD will show a reference label that represents this equipment.
Show all downstream branch items Instructs the software to show the complete
feeder branch that will include all electrical items in the branch regardless whether they
have been defined as loads. The SLD will also show in the downstream branch other
buses within the same PDB and all the equipment that is connected to their feeders
downstream. If a load in the feeder branch is connected to a downstream bus that belongs
to another PDB, the SLD will show a reference label pointing to the associated PDB and
bus.
Note that the software stops the display of the downstream branch at the
item which belongs to the Loads folder in the Electrical Index. In this case, the software
shows a reference label that points to the existing downstream equipment.
Incomer display options (available only when generating SLDs for power distribution boards)
Allows you to select an option that determines whether to show the upstream incomer branch in
the generated SLD. The following two options are available:
Do not show upstream branch items Instructs the software not to display any items
of the upstream branch. However, the generated SLD will show a reference to the
upstream equipment that feeds the incomer.
Show upstream branch items Instructs the software to display the items of the
upstream branch. In the incomer branch, the software will show the first associated
electrical equipment and then a reference to the next equipment item that is connected in
the upstream branch.

800

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Activate 'Hide PDB internals' property Allows you to show the entire PDB and all of its
sub-items as a single block without showing the PDB sub-items on your SLD. This option takes
effect only if the Hide PDB internals property for the current PDB is set to TRUE in the
Properties window.
Activate 'Hide bus feeders' property Allows you to hide the bus feeders on your SLD. This
option takes effect only if the Hide bus feeders property for the current bus is set to TRUE in the
Properties window. Note that if you do not select the Activate 'Hide bus feeders' property
check box and you set the Hide bus feeders property for the current bus to FALSE, the software
will still hide bus feeders if you selected the Activate 'Hide PDB internals' property check box
and set its Hide PDB internals property to TRUE.

Source Definitions Tab (Single Line Diagram Options Dialog


Box)
Enables you to define the scope of the source data that you want to include in a single line
diagram that you generate for electrical items in the Electrical Engineer. Note that these options
do not apply to SLDs based on power distribution boards.
All items powered from the selected source Generates an SLD for the electrical items you
selected in the Electrical Engineer (shown in the box below). The SLD will include the selected
items and all the items powered from the selected sources. The software will generate an SLD
where the selected electrical items are the origin points from which the power network is drawn.
The selected sources and their sub-items in the Expanded Electrical Engineer
Generates an SLD for the selected sources. Expand the Electrical Engineer hierarchy and then
select the items that will be the SLD entry points. The SLD will include only the selected items
and their sub- items located under them in the expanded hierarchy of the Electrical
Engineer. Note that if you use this option, the software does not allow you to save the SLD as an
internal document. You can, however, save it as an external document.
The selected sources and the items connected below the specified number of bus levels
Generates an SLD for the selected items in the Electrical Engineer and in the Number of bus
levels box, type the number of bus levels below the selected sources to be included in the
SLD. The SLD will display the selected items and all the items connected to the specified number
of bus levels below the source. The SLD will also include the buses at the levels you define, all
the circuits belonging to these buses down to the incomer connections or till their electrical end.

Page Settings Tab (Single Line Diagram Options Dialog Box)


Enables you to define the size of the active generation area and fit the drawing to the page size.

Page settings
Enables you to define the size of the active generation area.
Default SLD template Generates a single line diagram based on the default template file you
define in Options Manager.
A0 wide template file Generates a single line diagram based on the A0 wide template file
provided to you by the system. This template file is called A0_Template.spe and the software
sets its default location in Options Manager under Default Report Template Path. You can
change this location if needed but do not delete this file.
Selected template Generates a single line diagram based on the template file you select from
the list below this option button.

SmartPlant Electrical User's Guide

801

Windows and Dialog Boxes


Shrink to page Fits the content of the drawing (excluding the title block) into the working area
of the drawing as defined by the SLD margin settings.

SLD margins
Enables you to define the distance between the page edges and the SLD so that the drawing does
not overlap the title block.
Top Allows you to type a value in inches for the top drawing margin.
Bottom Allows you to type a value in inches for the bottom drawing margin.
Right Allows you to type a value in inches for the right drawing margin.
Left Allows you to type a value in inches for the left drawing margin.
Units Allows you to select a unit of measure for the SLD margins.

Circuits & Internals Tab (Single Line Diagram Options Dialog


Box)
Enables you to define the presentation of circuits and their components in a generated single line
diagram.

Circuit internals
Enables you to define the presentation of circuit components.
Show only enabled circuit internals Includes only those circuit components in the single line
diagram for which the Is SLD parameter in the Properties window is set to TRUE.
Show all circuit internals Includes in the single line diagram all the circuit components
regardless of their Is SLD parameter setting in the Properties window.
Do not show any circuit internals Excludes the circuit components in the generated single
line diagram.
Distance between circuit internals Enables you to define the vertical distance between the
circuit components in the generated SLD.
Options for electrical analysis SLDs Enables you to define the presentation of circuits and
circuit components in an electrical analysis SLD. Note that these options are only available after
selecting Electrical analysis SLD on the General tab. This is used to publish SLD to a third
party analyst application such as ETAP.
Show only circuits Includes circuits but does not show any circuit components in generated
electrical analysis single line diagrams.
Show only circuit internals Includes only circuit components but without the circuits.
Do not show circuits or circuit internals Excludes circuits and the circuit components in the
generated single line diagram.

802

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Circuits
Enables you to define the presentation of circuits.
Use bus tie symbols This option deals with the way the software represents the connection
between two redundant buses in a power distribution board.
Select this option to show a horizontal representation between two buses using the
BusTie.sym file. In this case, the software shows the connection between the two buses as a
straight bus-tie connection without showing the items connected between and within the
circuits. Note that the BusTie symbol is a "circuit" type symbol and has its first connection
point on the rightmost side and the second connection point at the leftmost side. Also, the
item property in the SLD displays only the coupler information. Furthermore, if you use the
Find in SLD command, the software finds the pertinent coupler and not the bus riser.
Clear this option to use a vertical representation of a connection between two buses. This is
the standard bus coupler-riser circuit connection representation that includes both coupler and
the riser circuits and displays them as vertical objects, connected to each other. The software
displays both circuits as standard arrows.
Distance between circuits Allows you to define the horizontal distance between the circuits
above and below the buses in the generated SLD.

Buses Tab (Single Line Diagram Options Dialog Box)


Enables you to define bus settings for a single line diagram.

Frames and distances


Draw a frame around each PDB bus group Draws a border around the items belonging to
the same power distribution board. You can resize the frame or move it to another place in the
drawing as you require. The software retains your changes after saving the drawing.
When drawing a PDB frame, the software draws a separate frame around each
bus or a section of a bus (if a bus break was used to break the bus symbol into sections).
When creating a PDB symbol in Catalog Manager, you can add a macro for PDB item tags.
This will enable you to display the PDB name on each PDB frame shown on the SLD. For
examples of how the software draws PDB frames, see PDB Frame Examples in SLDs (see
"PDB Frames Examples in SLDs" on page 306).
Draw frames around the circuits in each cell Draws a border around the circuits belonging
to the same cell. You can resize or move the frame to another place in the drawing as you require.
The software retains your changes after saving the drawing.
Distance between buses Allows you to define the horizontal distance between the buses
displayed on the same drawing level.

Display options
The options in this group box allow you to do the following:
Control the placement and position of the incomer and feeder circuits on the bus in an SLD
drawing.
Instruct the software to break the bus symbols on the drawing into several sections. You can
use these options if an SLD for a PDB includes a large number of circuits so that the labels on
the SLD drawing are more legible. The number of sections for each bus is determined by the
maximum number of incomer and feeder circuits per bus section that you define.

SmartPlant Electrical User's Guide

803

Windows and Dialog Boxes


Position the incomers and feeders by showing the incomers on the first page and first bus
section Allows you to set the position of the incomers and feeders on the bus using the
sequence in group values in such a way that the incomer and feeder circuits in the group are
counted separately. Selecting this option always results in placing the incomer circuits on the
first page and on the first bus section. The number of bus sections, in this case, is determined
only by the number of feeder circuits that are defined for that bus.
Position the incomers and feeders by their sequence numbers Allows you to set the
position of the incomers and feeders on the bus using the sequence in group values in such a way
that all the incomer and feeder circuits in the group are counted together in a continuous manner.
Selecting this option results in placing the incomers and feeders on bus sections based on the
sequence in group values of the incomers and feeders. The number of bus sections, in this case,
is determined by the total number of feeder and incomer circuits on a particular bus.

Note that bus risers and couplers are always displayed on the same page adjacent to
each other.
To ensure that all the circuits are placed correctly, all the circuits must have sequence in
group values. The software places the circuits that do not have sequence in group values
first and only then the rest of the circuits.
Force bus breaks Breaks the bus symbols on the drawing into sections and places them in
rows underneath each other. The software displays the electrical items on the buses in several
rows according to the bus breaks. You can move the individual bus sections and place them on
the drawing as you require. Also, you can move the incomer and feeder circuits from one bus
section to another on the same bus.
Clear this check box to instruct the software not to break the bus symbols into sections and display
of all the circuits on the same row.
The bus break options only apply to SLDs that are based on power distribution
boards generated from the Electrical Index.
Maximum number of circuits per bus section to display This option becomes available
when you select Force bus breaks. Enter the maximum number of circuits to allow on each row
of the drawing. The software forces bus breaks wherever the number of circuits on the bus
exceeds the specified value.

When forcing bus breaks, the software places the maximum number of feeder circuits on
the first bus section according to the value that you enter. Then, the software places the
rest of the feeders on the next section. For example, if you enter 3 as the maximum
number of feeders per bus section and there are 5 feeders on that bus, the software will
place 3 feeders on the first section and the other 2 feeders on the second bus section.
All the incomer circuits for each bus are drawn on the first bus section only.
You can move the incomer and feeder circuits from one bus section to another bus
section on the same bus as you require. Click an incomer or a feeder circuit symbol to
select it and then drag its connection point on the bus to another bus section of the same
bus.
Where two buses are connected by a coupler-riser, the software does not force a bus
break across the connection. Instead, the software draws the first bus section and then
counts the feeders from the riser on the second bus section before forcing the break. For
details, see Bus Break Example (on page 805). Note that you can move coupler and riser
circuits to another section of the same bus just like any other circuit.
Use multiple sheets Displays each row of items on a separate drawing sheet. When
selected, the software uses off-page connector symbols with appropriate labels to show the
continuation between adjacent sheets. Clear to display all the items on a single drawing sheet.

804

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


When cleared, the software uses row break symbols to show the continuation between adjacent
rows. Note that this option becomes available after selecting Force bus breaks.

Off-page connector symbols

Row break symbol

Suppose you have a PDB SLD with three buses that have the following arrangement:
Bus A has two incomers (CKT-I1 and CKT-I2) and 8 feeder circuits (CKT-1A to CKT-8A).
Bus B has an incomer (CKT-I3), 4 feeder circuits (CKT-1B to CKT-4B), and a coupler circuit,
CKT-5B (C).
Bus C has two incomers (CKT-I4 and CKT-I5), 4 feeder circuits (CKT-2C to CKT-5C), and a
bus riser circuit, CKT-1C (R).
The bus riser-coupler pair connects buses B and C.
The diagram appears as follows when there are no bus breaks, with illegible labels:

The drawings below show how different parts of the SLD appear when you select to force bus
breaks and specify a maximum of three feeder circuits to display per bus section.

SmartPlant Electrical User's Guide

805

Windows and Dialog Boxes


Breaks on Bus A
The first bus break appears after the third feeder circuit. The final bus section contains the last
two feeders. Note that both of the incomer circuits appear on the first bus section only.

806

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Breaks on Buses B and C
The first break on Bus B appears after the third feeder circuit; the second section does not break
after the coupler, even though it is the third circuit on that section; instead, the coupler-riser pair is
displayed on the same row, and the software forces a break after the third circuit on Bus C.

Related Equipment Tab (Single Line Diagram Options Dialog


Box)
The options on this tab enable you to define if and how the software will display control stations,
space heaters, meters, and relaying equipment in generated single line diagrams. Also, you can
set the horizontal and vertical distance between equipment items that are connected in parallel.

Control station options


Show control stations associated with equipment Select to display control stations that are
associated with electrical equipment items. Note that if an item is associated with more than one
control station, the software displays only the first control station in the SLD.
Control station symbol displacement Enter the X and Y coordinates and their unit of
measure to define the displacement of the control station from the symbol that represents the
equipment with which the control station is associated.

SmartPlant Electrical User's Guide

807

Windows and Dialog Boxes


Space heater options
Allow you to define display options for space heaters and set them next to their associated motors
or separately, below their power supply equipment.
These options apply only if you use space heater symbols that are not part of a symbol
assembly.
Show space heaters next to associated motors Select to display the space heaters next to
their associated motors. Clearing this check box does one of the following:
Displays the space heaters under their feeding equipment if this feeding equipment is
displayed in the current SLD.
Does not display the space heaters if their feeding equipment is not displayed in the
current SLD.
Displaying power cables that connect feeders and auxiliary contacts:
If the space heater is not fed from the same bus as its associated motor, the software
displays the connecting power cable only if the feeding bus is included in the current SLD.
If the bus feeding the space heater is not on the current drawing, the software displays a
reference to the feeding bus.
Space heater symbol displacement Enter the X and Y coordinates and their unit of measure
to define the displacement of the space heater from the symbol that represents the equipment with
which the space heater is associated.

Auxiliary contact options


Allow you to define display options for auxiliary contacts in generated single line diagrams.
These options apply only if you use auxiliary contact symbols that are not part of a symbol
assembly.
Show auxiliary contacts next to disconnect equipment Select to display the auxiliary
contacts next to their associated disconnect equipment. Clearing this check box does one of the
following:
Displays the auxiliary contacts under their feeding equipment if this feeding equipment is
displayed in the current SLD.
Does not display the auxiliary contacts if their feeding equipment is not displayed in the
current SLD.
Auxiliary contact symbol displacement Enter the X and Y coordinates and their unit of
measure to define the displacement of the auxiliary contact from the symbol that represents the
equipment with which the auxiliary contact is associated.

Metering and relaying equipment options


Show metering and relaying equipment Select to display metering and relaying equipment
in single line diagrams.
Metering equipment first symbol displacement Enter the X and Y coordinates and their unit
of measure to define the displacement of the metering equipment from the symbol that represents
the equipment with which the metering equipment is associated.
Vertical displacement Enter the value for the vertical displacement of subsequent metering
equipment and their symbols, below the first metering equipment item.

808

The software does not display control station properties in the Properties window when you
select a control station in an SLD.
The software does not allow you to compare control station changes with an archived SLD.

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Parallel equipment settings
Allow you to define how the software will present electrical equipment items that are connected in
parallel.
Horizontal distance Allows you to enter a value that determines the horizontal distance
between adjacent electrical equipment items that are connected in parallel.
Vertical distance Allows you to enter a value that determines the vertical distance between the
horizontal axis of the parallel equipment and the parallel connection branch.
Units Allows you to select an appropriate unit of measure for the distance between the items in
the parallel branch.

Miscellaneous Tab (Single Line Diagram Options Dialog Box)


Enables you to define miscellaneous SLD options that include options for displaying cables,
motors, and heaters. Also, allows you to display a symbol legend in the single line diagram.

Cable and busway display options


Do not show cables and busways Enables you to determine whether or not to display
associated power cables and busways when generating conventional SLDs or SLDs based on
bus rated voltage.

Overall SLD options


Allow you to determine whether or not you want to include any associated motors or heaters when
generating an overall SLD. Note that if you choose not to display any motors or heaters, the SLD
will not show the feeders associated with the motors or heaters. These options are only available
after choosing Overall under SLD type on the General tab.
Show motors Allows you to include associated motors whose minimum rated power is above
the value that you select from Include motors with rated power greater than list.
Include motors with rated power greater than Allows you to include associated heaters
whose minimum rated power is above the value that you select from Include heaters with rated
power greater than list.
Show heaters Allows you to display main heaters.
Include heaters with rated power greater than Allows you to type the minimum rated power
and select the unit of measure to determine which heaters the software will include in the SLD.

Legend
Enables you to include a legend that explains the SLD symbols used in the drawing. Note that
once an SLD contains a legend, you can drag the legend and move it like any other element in an
SLD. An SLD legend contains all the symbols that the software uses to represent all the electrical
items in a single line diagram. Also, the software shows custom symbols if you have defined the
Electrical Equipment Type property and selected a symbol from the Symbol Name list in the
Properties window for a particular electrical item.
Draw legend Adds a legend in an SLD.
Horizontally Positions the legend horizontally.
Vertically Positions the legend vertically.

SmartPlant Electrical User's Guide

809

Windows and Dialog Boxes


Item position and style
These options allow you to control the position of items in a drawing after manually changing the
original position of items in a drawing that has already been generated. That is, you can instruct
the software how to handle the position of items that you move around in an open SLD or the
position of items that you drag to a drawing that has already been generated.
Reset saved items positions
For manual SLDs, recalculates the positions of all items in the SLD. Note that items moved to
other places in the drawing do not retain their positions after saving the drawing. After
regenerating this SLD, the software recalculates the position of all the items as if it was a new
SLD generation. Manually placed items (main items that you dragged to the drawing before
generating the SLD) are not included in the recalculation since the software always retains the
coordinates of the latest position.
For automatic SLDs, this option is not available since the software resets all the positions
when regenerating an SLD. That is, when regenerating an automatic SLD, the software
retains the latest positions of all the items based on the SLD preferences that you defined.
Reset custom styles For both automatic and manual SLDs, resets the symbols custom styles
to that of the default styles as they have been defined in Catalog Manager. Note that this
option only affects those symbols that are on the opened SLD. If you select this option, the
software cancels all the manual changes in the current SLD and all the items will be displayed as
they are defined in your symbology. Also note that this option depends on your preference settings
for single line diagrams. For more details about symbology, see the Catalog Manager User's
Guide > Working with Symbols.

Not shown items


Allows you to define a symbol that will serve as a reference label representing the items that are
not displayed on a single line diagram.
Reference label Allows you to type a file path or browse to a symbol that will be used to
represent the items that are not shown in an SLD. The software uses this symbol as a reference
icon to represent the items that are not shown in the SLD.
Note that when generating an automatic SLD that originates from the Electrical Engineer, the
use of this label becomes irrelevant. Also, if you do not select a symbol, the software uses a
default symbol for the items that are not shown.

Batch Options for SLDs Dialog Box


Enables you to print and set save options for batch generation of single line diagrams that you
generate for power distribution boards.
Save files to disk Saves the generated drawings as external files.
Path Allows you to type the file path or click to navigate to the folder where you want to save the
drawings. The software automatically displays the default path that you have set for your
drawings in Options Manager.
Save as type Allows you to select a file format for the drawings you want to save.
Print Drawings Prints out all the drawings that you are generating.
Include Loads Shows the loads associated with items on your SLD drawing.

810

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Open Single Line Diagram Dialog Box


Enables you to select and open a single line diagram for an electrical item that is an origin for more
than one SLD document.
Document number Displays the document number.
Document description Displays the document description.

SLD Legend Dialog Box


Enables you to insert a legend that explains the SLD symbols used in the drawing. Note that
once an SLD contains a legend, it behaves like any other element in the SLD. Therefore, you can
resize it or drag it to another place in the SLD. An SLD legend contains all the symbols that the
software uses to represent all the electrical items in a single line diagram. Also, the software
shows custom symbols if you have defined the Electrical Equipment Type property and selected
a symbol from the Symbol Name list in the Properties window for a particular electrical item.
Horizontal Allows you to display the legend horizontally.
Vertical Allows you to display the legend vertically.

Change Branch Orientation Dialog Box


You use this dialog box to change the orientation of a branch that is connected between a selected
power source and a bus in a single line diagram. The software changes the orientation of all the
branch and displays it above or below the bus.
To open this dialog box, in an SLD drawing, select a root power source and then click
on the
Edit Drawing toolbar.
The dialog box options are as follows:
Connected buses Allows you to select a bus that is connected to the root power source that
you selected. The software will change the orientation of all the items in the branch that are
connected between the selected power source and this bus.
Above the selected bus Changes the orientation of the branch above the selected bus.
Below the selected bus Changes the orientation of the branch below the selected bus.

SmartPlant Electrical User's Guide

811

Windows and Dialog Boxes

Symbols
Associate Custom Symbols Dialog Box
This dialog box allows you to associate a customized symbol file with each available document
type (drawing), for each specific item you use in SmartPlant Electrical.
Item Tag Displays the item tag selected for associating a symbol with.
Document Type Allows you to select the document type for the item tag that you want to
associate.
Symbol Allows you to select the custom symbol you want to associate with the document type
and item tag. Click
, to view the custom symbols in the default Symbols folder and its
sub-folders. The default Symbol folder is defined under Options > Locations in the SmartPlant
Electrical Options Manager.
Add Adds a new row for defining a document and symbol association. The Add button is
deactivated when no more rows can be added.
Remove Removes the selected row from the item tag.

Tabular Editor
A compound filter consists of more than one simple filter. Simple filters are added to the
compound filter either by dragging the simple filter to the compound filter folder or by creating new
simple filters under the compound filter in the filter hierarchy. Compound filters apply only to
homogeneous item types. This dialog box specifies the properties of a compound filter, including
the name, description, and whether to match all or any of the simple filter criteria.

Name Specifies the filter name. The name can be any combination of characters and has no
length limit. Filter names within a plant must be unique. This name appears as the filter name on
the Filter Manager interface.
Description Specifies a phrase or sentence about the filter. The description can be any
combination of characters and has no length limit. The description appears as a ToolTip when you
point to the filter name on the Filter Manager interface.

Filter method
Allows you to decide whether items must meet all or only one criterion to pass through the filter.
Match all Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any Specifies that items matching any one or more of the filtering criteria pass through
the filter. Match any is the default matching method.

812

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Advanced Table Properties Dialog Box


Allows you to define, select, and save filters or layouts for a Tabular Editor view. This dialog box
opens when you click Advanced on the Table Properties dialog box, which opens when you click
Window > New > Table on the main toolbar or when you right-click Table Properties on the
Tabular Editor view shortcut menu.
Filter Tab (Advanced Table Properties Dialog Box) (on page 813)
Layout Tab (Advanced Table Properties Dialog Box) (on page 814)

Filter Tab (Advanced Table Properties Dialog Box)


Allows you to define, select, and save a filter for a Tabular Editor view.

Base filter
Displays details of a saved filter.
Name Displays the name of the filter as defined in Filter Manager.
Default Indicates if the named filter is the default filter for the item type selected on the Table
Properties dialog box. You can designate a filter as the default by checking this box.
Browse Opens the Select Filter dialog box, which allows you to select a base filter.

Definition
Allows you to add, remove, or edit filter criteria and to specify the relationship between multiple
criteria.
Match all Specifies that items matching ALL of the filtering criteria pass through the filter.
Match any Specifies that items matching any one or more of the filtering criteria pass through
the filter. Match any is the default matching method.
Add Places a new entry at the end of the existing definition list and enables the options in the
Edit group so that you can edit the new entry.
Delete Removes the selected criterion from the definition list. This button is available only when
you select a criterion in the definition list.

Edit
Provides options that allow you to define or edit a single line of filter definition criteria.
Property Displays a list of all properties for a certain item type. Examples of properties
include Equipment Type, Instrument Type, and Estimated Length. You define or modify filtering
criteria by selecting a property, an operator, and a value.
Operator Specifies the relationship between the property and its value. Relationships include,
for example, greater than, >; equal to, =; not equal to, <>; and so forth.
Value Lists appropriate values for the property specified in the Property column. If a list of
attributes is not already associated with the Value box, you must type a value, which can be free
text, or choose null. You can type a percent sign, %, as a wildcard character to find multiple
characters, or type an underscore, ( _ ), as a wildcard character for a single character. Do not use
an asterisk, *, in the Value box.

SmartPlant Electrical User's Guide

813

Windows and Dialog Boxes

Layout Tab (Advanced Table Properties Dialog Box)


Allows you to define, select, and save a layout for a Tabular Editor view.
Name - Displays the name of a saved layout. You can enter a new layout name and then click
Save to save the layout for re-use. Or, you can select any of the layouts in the list.
Default - Indicates whether the named layout is the default layout for the item type on the Table
Properties dialog box. You can designate a layout as the default by selecting this box and then
clicking Save.
Usage - Lists the property display types associated with the Properties window. Options include
a blank value, Brief, Bulk, and Brief/Bulk. The selected item type and display attributes define what
appears in the Properties window when you select the Show Brief Properties, Copy Bulk
Properties, or Paste Bulk Properties commands from the Properties window toolbar.
You can have only Brief and one Bulk layout per item type. The last layout that you define as
Brief or Bulk is set as such and replaces the previous one.
Delete (Name) - Removes the named layout.
Save - Saves the data in this dialog box as a named layout. Layout names must be unique.
Definition - Displays all defined criteria associated with the selected layout. This group contains
two list views. In order to add to or modify either list, you must select a line in the list and then
define or edit the property in the Edit group. The buttons to the right act upon the active list view.
Display Property - Lists the columns that appear in the Tabular Editor. To edit an entry, select it
and modify the property in the Edit group.
Caption (Definition) - Displays the caption for each column in the Tabular Editor.
Sort Property - Lists the properties that apply to the item type specified in the Table Properties
dialog box.
Order - Lists the sort orders ascending and descending. You can select one.
Type - Lists the sort types numeric and alphanumeric. You select one.
Add - Adds a new entry at the end of the existing entries. Enables the fields in the Edit group so
that you can edit the new entry.
Insert - Places a new entry above the currently selected entry. Enables the fields in the Edit group
so that you can edit the new entry.
Delete (Definition) - Removes the currently selected entry.
Up - Moves the currently selected entry up one line.
Down - Moves the currently selected entry down one line.
Edit - Allows you to edit a single entry selected in either the Display Property or Sort Property
list views. If you select an entry in the Display Property view, the Edit group allows you to edit the
property and the caption. If you select an entry in the Sort Property view, the Edit group allows
you to edit the property, order and type.
Property - Displays a list of all the properties that apply to the item type defined in the Table
Properties dialog box. If you select an entry in the Display Property view, you can specify the
property and its caption. If you select an entry in the Sort Property view, you can specify the
property, its order, and its type.
Caption (Edit) - Displays the caption for each column in the Tabular Editor.

814

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Custom AutoFilter Dialog Box


Sets options for the behavior of the AutoFilter as it controls the display of items in the Tabular
Editor. This dialog box opens when the AutoFilter is active and you click an arrow at the top of one
of the columns in the Tabular Editor and select (Custom).
Comparison operator Lists the available comparisons: for example, equals, does not equal, is
greater than, begins with, and so forth.
Value Lists the available values currently stored in the column.
And Allows you to add another comparison using the Boolean operator sense of And: this
means all criteria must be met.
Or Allows you to add another comparison in the Boolean sense of Or: this means any one of
the criteria must be met. The Boolean Or is less restrictive than the And.

New Filter Dialog Box


Allows you to specify compound or simple filter when you create a new filter. You can activate this
dialog box by clicking New on the Select Filter dialog box.
Compound filter Combines two or more simple filters to return a collection of items based on
the criteria of the combination of simple filters.
Simple filter Returns a collection of items based on the filter definition and criteria of a single
filter.

Select Filter Dialog Box


Allows you to select a filter for filtering the data for a particular item type to display in a Tabular
Editor view or in a report. Using this dialog box, you can create a new filter or modify an existing
filter. To display this dialog box, you can:
Click Browse on the Filter tab of the Advanced Table Properties dialog box while you are
choosing your item type for displaying in a Tabular Editor view.
Click Browse on the Filter tab of the Define Report Items dialog box while you are choosing
your report item type.
New Displays the New Filter dialog box, which allows you to specify a new simple or new
compound filter.
Properties Allows you to edit the properties of the selected filter. This button displays the
Filter Properties dialog box or the Compound Filter Properties dialog box, depending on your
selection in the filter list. If you create a compound filter, you select the individual simple filters
that comprise a compound filter and click Properties to view the Filter Properties dialog box for
those simple filters.

SmartPlant Electrical User's Guide

815

Windows and Dialog Boxes

Table Properties Dialog Box


Enables you to select the item types, filters, and layouts for a Tabular Editor view. This dialog
box appears when you click Window > New > Table on the main toolbar or when you right-click
Table Properties on the Tabular Editor view shortcut menu.
Item Type Lists all the item types that you can select; for example, equipment.
Filter Lists all of the filters that have been saved for the selected item type.
Layout Lists all of the layouts that have been saved for the selected item type.
Advanced Displays the Advanced Table Properties dialog box, where you can define and
save filters or layouts for a Tabular Editor view. You can specify the default filter and layout for a
certain item type also. Specify brief and bulk properties in this dialog box, too.

Troubleshooting Errors and Rule Inconsistencies


Log Files Dialog Box
Allows you to select from a list of categories and display an error log file for the selected
category. You can generate an error log file for any batch operation in SmartPlant Electrical as
well as for bulk copying and pasting of values in the Properties window. Note that you need to
activate the error log file generation on the Preferences dialog box before you attempt to
generate any error log file.
Log file type Select the category for which you want to view the log file. Note the functionality
of the following two error log files:
Comprehensive Error Log File Contains all errors of all types.
Miscellaneous Error Log File Contains errors that do not fit the description of any of the
available log file types.
Clear Log Clears the contents of the log for the selected log file type.

Show
Allows you to specify which types of errors appear in the log files.
All log file data Displays data and rule inconsistency errors.
Rule inconsistencies only Displays rule inconsistency errors only.
All log file data excluding rule inconsistencies Displays data errors only.
Show log file data for last operation only Select to display errors for the last performed
operation relating to the specified log file. Clear to display accumulated errors for successive
operations.
Open Opens a log file of the selected category in Microsoft Excel. After generating the log file
in Excel, you switch back to the Log File Selection dialog box and select another
category. Clicking Open displays the log in the same Excel workbook but in a different
worksheet.
Close Closes this dialog box.

816

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Fix Inconsistencies Dialog Box


After checking for rule violations, performing any copy rule operations, and fixing inconsistencies
found, the dialog box enables you to view a summary detailing the number of items checked, the
number of inconsistencies found, and the type of inconsistencies found.

Summary
Total number of items Shows the total number of items that you selected in the Electrical
Index or Tabular Editor.
Inconsistency Type Indicate the type of rule inconsistency, if any, that the software
found. The following levels are indicated: No inconsistency, Logged, Warning, and Rejected,
according to the options specified in the Rule Manager.
Number of Items Indicates the number of selected items that the software found with
inconsistencies corresponding to the indicated inconsistency type.
Cancel Cancels the processing while the software is checking items for rule
inconsistencies. When the software has finished checking all the selected items, this command
changes to Close.
Show Log Displays an Excel file showing details of rule inconsistencies that the software found
for the selected items.

Rule Inconsistencies Dialog Box


Enables you to view rule inconsistencies for operations related to the selected items.

Data Window
Displays the rules with details of inconsistencies and the action to be taken.
Rule Name The name of the rule as defined by the user. The same rule name can appear
more than once if several inconsistencies exist for that rule.
Inconsistencies Indicates the way in which the data is inconsistent with the rule for the
specified item. The following example specifies an inconsistency for a rule whereby a 100hp
motor must have a rated voltage of at least 400V:
Motor=100hp(M-A-1000):Rated Voltage(220V)>=(400V)
Where the components of the formula are as follows:
Component

Value

Operand 1

Motor=100hp

Item tag

(M-A-1000)

Property

Rated Voltage

Actual database value

(1000V)

Operator

>=

Operand 2 property / value

(400V)

SmartPlant Electrical User's Guide

817

Windows and Dialog Boxes


In this case, the actual rated voltage for motor M-A-1000 is 220V, and so this value represents a
rule inconsistency.
Action Specifies the action that is required where there is an inconsistency. The
actions can be:
Log Records the rule inconsistency to a log file without notifying you. You can access
the log file from SmartPlant Electrical.
Warn Prompts you to reject or accept the operation when a rule inconsistency is
found. This action gives you flexibility in making an appropriate decision.
Reject Automatically rejects the operation that you performed and notifies you about
the rule inconsistency. This action prevents you from accepting any operation when the
software detects an inconsistency.
Solutions Displays the solutions that are available for the specific inconsistency. Only
solutions consistent with the specific rule will be displayed. The following solutions are available if
the operator is = (equal) Copy Rule:
Approve Inconsistency - Performs the operation, even though data values or
relationships exist that are inconsistent with the rules. In the case of rule inconsistencies
for which the action is specified as Warn, the software accepts the latest data values and
saves them in the database.
Copy data from item1 to item2 Copies value from property from item 1 to item 2.
Copy data from item2 to item1 Copies value from property from item 2 to item 1.
Copy data from value to item1 Copies fixed value to the property in item 1.
Reject Operation Rejects the operation on the item or relationship for which the software finds
rule inconsistencies. In the case of rule inconsistencies for which the action is specified as Warn,
the software does not save the data.
Accept Solutions Performs the operation, according to the selected solution even though data
values or relationships exist that are inconsistent with the rules.
Show Rule - Opens the Rule Properties dialog box with read-only information showing details of
the selected rule.

Rule Properties Dialog Box


Enables you to view the properties of the rules that appear on the Rule Inconsistencies dialog
box.
Rule properties include the following settings:
Rule name and description
Rule components (that is, item types or filters created for certain item types in Filter Manager)
Logical expressions which determine rule consistency criteria
Action associated with a logical expression (an action applies whenever the user operation in
SmartPlant Electrical does not comply with the logical expression)
General Tab (see "General Tab (Rule Properties Dialog Box)" on page 819)
Rule Components Tab (see "Rule Components Tab (Rule Properties Dialog Box)" on page 819)
Consistency Tab (see "Consistency Tab (Rule Properties Dialog Box)" on page 820)

818

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

General Tab (Rule Properties Dialog Box)


Enables you to view the rule name, description, or priority.
Rule name Defines the name of the rule.
Rule description Identifies the purpose or function of your rule.
Disable rule Not in use. Note that only those rules appear for which this check box was not
selected in the Rule Manager.
Priority Determines which rule applies first when rules conflict with each other. Values lie in
the range from 1 to 100, where 1 represents the lowest priority and 100 represents the
highest. When a user of SmartPlant Electrical performs an operation that involves items to which
several rules apply, the software first applies the rules with the highest priority.
In a case of rule inconsistency, if a specific logical expression in the rule is associated with the
Reject action, the software rejects the operation automatically and does not apply any other rules
that has lower priorities. Likewise, if a logical expression is associated with the Warn action, and
the user rejects the operation, the software does not apply any other rules that has lower priorities.
A priority applies to an entire rule, not to a particular logical expression.

Rule Components Tab (Rule Properties Dialog Box)


Enables you to view the rule type relation rule or single component rule together with the
rule components. Rule components can be either filters created in Filter Manager or item types
available in SmartPlant Electrical (except for reference data item types). A filter specifies an
extensive class of item types to which the rule applies. A relation rule consists of a pair of rule
components. A single component rule has only one rule component.

Component 1
Displays the first rule component and set or changes the rule type.
Filter or item type Displays the first rule component.
Single component Indicates the rule type. When this check box is selected, the software
uses a single component rule for the component specified in the Filter or item Type box under
Component 1. A single component rule enables you to evaluate and validate consistency of the
properties or property values of a specific item tag.

Component 2
Available only when the rule type is a relation rule. Specifies a second rule component, which the
software can display as an operand in logical relations in the Consistency tab.
Filter or item type Displays the second rule component.
The order of the rule components is not important. Relation rules are be bi- directional. If
your rule components are different, and in the Consistency tab you create a logical expression
using both components as operands, the rule applies to any of the components involved in user
operations in SmartPlant Electrical.

SmartPlant Electrical User's Guide

819

Windows and Dialog Boxes

Consistency Tab (Rule Properties Dialog Box)


Defines consistency check criteria and enables you to view logical expressions that exist for the
rule.
Whenever the software detects a rule violation, it performs the action assigned to the specific
logical expression. Depending on an action, the software can record the inconsistency to a log
file, reject the user operation automatically, or prompt the user to accept or reject the operation.
Each row is the tab is a specific logical expression that consists of various parameters for creating
a relationship between a pair of rule components or between one rule component and its property
or a specific value. A user operation that does not satisfy all of the consistency criteria is
considered a rule violation.

Consistency criteria
Displays the consistency criteria which consist of one or more logical expressions and an action
associated with specific expressions. A logical expression is a relationship created between two
operands by means of a logical operator.
A logical expression consists of the left and right parts separated by an operator:
Left part Must always contain Operand 1 and its property, where Operand 1 represents a
rule component.
Right part Can contain either a rule component as an Operand 2 and its property or the
Value operand and a value specified for the property of Operand 1.
Operand 1 Displays a rule component specified in the Rule Components tab. If the rule type
is single component, the cell displays the rule component specified on the Rule Components tab
under Component 1.
Property Lists appropriate properties for the rule component that appears in the Operand 1
list.
Operator Displays the operator for the logical relation. For details about operator descriptions,
see Operator Descriptions and Rule Examples (on page 35).
Operand 2 Displays a rule component specified in the Rule Components tab or the Value
operand of a property selected in the Property column. For a rule component, this column
displays the relationship between properties of rule components. For the Value operand, this
column displays the relationship between the rule component property and the property value.
Property/Value Depending on the selection in the Operand 2 column, lists properties or
values. If the Operand 2 column contains a rule component, this column displays a property of a
specific item type or filter. If the Operand 2 column contains the Value operand, this column
displays the value for the property defined in the Property column. Depending on the operator, a
value can be free text, a number of units of measure separated by commas or semi colons, or a
value selected from the list.
Action Displays the action for the software to perform in case of inconsistency. In SmartPlant
Electrical, the software applies an action only when the software detects a rule inconsistency (that
is, whenever a user violates the logical expression with which you associate the action). The
software records rule inconsistency details into a log file which you can generate from SmartPlant
Electrical.

820

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


The actions are:
Log Records the rule inconsistency to the log file without notifying you.
Warn Prompts you to reject or accept the operation when a rule inconsistency is
found. This action gives you flexibility in making an appropriate decision.
Reject Rejects user operation automatically and notifies the user about the rule
inconsistency. This action prevents you from accepting the operation when the software
detects an inconsistency.

Wiring
Batch Cable Connection Dialog Box
Allows you to connect, in batch mode, numerous project cables that belong to the same category,
for example, power, control, instrumentation, and so forth. For example, you can you can
terminate all the project control cables that are associated with 10hp motors.

Cable side 1 (From) / Cable side 2 (To)


These group boxes allows you to define the From and To sides of the cables you are going to
connect.
Activate cable side 1 (From) / Activate cable side 2 (To) Activate the options for the From
and To sides of the cables you are going to connect.
Terminal strip sequence Allows you to type a value that defines the terminal strip that is
associated with the equipment that you want to connect. The value that you type corresponds to
the terminal sequence in group.
First terminal Allows you to type a value that instructs the software as to which terminal on the
current terminal strip is to be connected first.
Active connection side Allows you to select the side of the terminals to be connected to the
cable end.
Left The active side
Right The opposite side
Connection type Allows you to select a connection method for the From and To sides of the
cables. You can select one of the following:
Continuous Allows you to make a connection in a sequential way by selecting a terminal
that will be wired first. The software then automatically wires the rest of the terminals in a
sequential order.
An existing custom connection type Allows you to make your connections based on an
existing reference connection type of a selected cable. You start by selecting a terminal to be
wired first and the software then connects the rest of the terminals according to the connection
type. If the connection type that you require is not on the list, create it in the Reference Data
Explorer. For details, see Define a Connection Type (on page 335).

Cable connection details


Select Allows you to select the cables to be included in the batch connection.
Cable Tag Displays the names of the cables that you can select for the batch connection.
Cable Category Displays the category of the cables, for example Control, Power, and so forth.
Cable Formation Displays the formation of the cables, for example 3x1.5 mm2.

SmartPlant Electrical User's Guide

821

Windows and Dialog Boxes


From Equipment Displays the name of the equipment associated with the From side of the
current cable.
To Equipment Displays the name of the equipment associated with the To side of the current
cable.
From Terminal Strip Displays the name of the terminal strip on the equipment that is
associated with the From side of the current cable.
To Terminal Strip Displays the name of the terminal strip on the equipment that is associated
with the To side of the current cable.
Cable Common Properties Opens Cable Common Properties dialog box where you can
edit the properties of a cable that you select in the Cable connection details data window.
Select all Selects all the cables displayed in the data window.

Cable Connection Type Selection Dialog Box


Allows you to select a cable connection type that you can use to wire project items using the
custom connection method in a wiring drawing or when connecting cables in batch mode.
Cable Displays the name of the cable that you selected to terminate.
Item Displays the name of the wiring item you selected in the current wiring drawing or in the
Batch Cable Connection dialog box.

Cable connection details


This data window contains all the cable sets of the current cable and connection types for each
cable set.
Select Allows you to select an appropriate cable set in a multi-set cable.
Cable/Set Displays the name of the cable or cable set you are selecting for termination.
Connection Type Allows you to select an appropriate connection type for the current cable
termination. If the connection type that you require is not on the list, create it in the Reference
Data Explorer. For details, see Define a Connection Type (on page 335).
Connect Effects the termination of the terminal you selected in the current wiring drawing.

Connection Type Dialog Box


Allows you to define a connection type that facilitates rapid cable set connections. You define a
connection type that contains a pattern by which SmartPlant Electrical connects conductors to
terminals on a terminal strip.
Connection type Allows you to type a connection type name. Click the ellipsis button
to
open a dialog box where you can modify the connection type segments.
Description Allows you to type a description connection type, for information only. Click the
ellipsis button

to open a dialog box where you can type longer text for the description.

When typing the description in the dialog box, to begin a new line, press CTRL + ENTER.
Skip between sets Allows you to enter the number of terminals that you want to skip between
the first conductor of the previously connected set and the first conductor of the next set.

822

SmartPlant Electrical User's Guide

Windows and Dialog Boxes


Conductors
This data window contains all the conductors of the selected cable set, showing their names and
configurations. The number of rows that you should add has to match the number of conductors
that will be connected. The software does not connect the leftover conductors that do not have
connection type definitions in the Conductors data window.
Conductor Displays a specific conductor in a cable set. The displayed Wire00x values
represent the conductor names and are used to illustrate the current connection type
configuration. This field is not editable.
Skip Allows you to type the number of terminals to skip before connecting this conductor in the
set. The skip refers to the number of terminals that will be left unconnected between consecutive
cable sets. Enter the number of terminals to be skipped according to your needs. In most cases,
this value is incremented for successive conductors.
Land Side Allows you to set the side of the terminal to which you want to connect each
conductor.
A The active side of the terminal. In the environment of a wiring drawing, the A side is
the active side of the terminal that you want to connect. It can be its left or right side,
depending on which terminal side you clicked after you moved the cursor over the
connection points.
O The opposite side of the terminal. In the environment of a wiring drawing, the O side
is the opposite side of the terminal that you want to connect. It can be its left or right side,
depending on which terminal side you clicked after you moved the cursor over the
connection points.
Add Adds a new row to the Conductors data window where you can define a new conductor
connection. The number of rows must match the number of conductors you are going to
connect. The software does not connect the leftover conductors that do not have connection type
definitions in the Conductors data window.
Remove Removes the selected row from the Conductors data window.

Terminal Strip Configuration Dialog Box


Allows you to define a reference terminal strip configuration that you can apply to a terminal strip
whose properties you are editing in the Electrical Index.
Note that SmartPlant Electrical creates terminal strip configurations based on the number of
terminals that you enter and terminal strip pattern that you define.
Configuration Allows you to type a name for the current reference terminal strip configuration.
Description Allows you to type a description of the current reference terminal strip
configuration.

Configuration properties
Total number of terminals Allows you to enter a number of terminals to be created on the
current terminal strip. Note that this number should always be higher than the
First terminal Allows you to type or select a starting number of the first terminal on the current
terminal strip.

Terminal strip pattern


This data window displays the pattern of terminal numbering on the terminal strip based on your
Total number of terminals value. The pattern reflects the number of rows (terminals) that will
constitute the basic repeating numbering (naming) pattern.

SmartPlant Electrical User's Guide

823

Windows and Dialog Boxes


Sequence Displays the sequential number of a terminal.
Prefix Allows you to type a prefix for the terminal if you require.
Incremented Increments the terminal number within the pattern.
Numbered Makes the number of the terminal appear between the prefix and the suffix.
Suffix Allows you to type a suffix for the terminal if you require.
Add Adds a new row to the terminal strip pattern. The maximum number of rows that you can
add cannot exceed the total number of terminals that you enter.
Remove Removes the highlighted row from the terminal strip pattern.

Terminal Strip Common Properties Dialog Box


Allows you to define the properties of a terminal strip and set its terminal configuration.
Item tag Allows you to type a terminal strip name. Click the ellipsis button
to open a
dialog box where you can modify the terminal strip tag segments.
Description Allows you to type a description of the terminal strip, for information only. Click
the ellipsis button

to open a dialog box where you can type longer text for the description.

When typing the description in the dialog box, to begin a new line, press CTRL + ENTER.

Terminal strip configuration


Allows you to apply a reference terminal strip configuration to the current terminal strip. Also, you
can define a terminal strip configuration on the fly. The software creates the terminal strips and
the terminals based on the configuration you use. However, the software does not retain the
configuration that you create on the fly. To save a configuration for later use, define a reference
terminal configuration in the Reference Data Explorer. For details, see Define a Reference
Terminal Strip Configuration (on page 332).
Total number of terminals Allows you to enter a number of terminals to be created on the
current terminal strip.
First terminal Allows you to enter a starting number for the first terminal on the current terminal
strip.
Find Opens the Find dialog box that allows you to find an appropriate reference terminal strip
configuration that you want to apply to the current terminal strip.

Terminal strip pattern


This data window displays the pattern of terminal numbering on the terminal strip based on your
Total number of terminals value. The pattern reflects the number of rows (terminals) that will
constitute the basic repeating numbering (naming) pattern.
Sequence Displays the sequential number of a terminal.
Prefix Allows you to type a prefix for the terminal if you require.
Incremented Increments the terminal number within the pattern.
Numbered Makes the number of the terminal appear between the prefix and the suffix.
Suffix Allows you to type a suffix for the terminal if you require.
Add Adds a new row to the terminal strip pattern.
Remove Removes the highlighted row from the terminal strip pattern.

824

SmartPlant Electrical User's Guide

Windows and Dialog Boxes

Terminal Common Properties Dialog Box


Enables you to define the properties of a terminal.
General Tab (see "General Tab (Terminal Common Properties Dialog Box)" on page 825)
Procurement Tab (see "Procurement Tab (Terminal Common Properties Dialog Box)" on page
825)

General Tab (Terminal Common Properties Dialog Box)


Allows you to define the general properties of a terminal.
Item tag Allows you to type a terminal name. Click the ellipsis button
to open a dialog
box where you can modify the terminal strip tag segments.
Equipment Displays the name of the associated electrical equipment.
Description Allows you to type a description of the terminal, for information only. Click the
ellipsis button

to open a dialog box where you can type longer text for the description.

When typing the description in the dialog box, to begin a new line, press CTRL + ENTER.
Terminal strip Displays the terminal strip that is associated with the current terminal.
Type Allows you to select a type for the current terminal. You can define and customize types
in Data Dictionary Manager.
Terminal color Allows you to select a color for the current terminal. You can define and
customize terminal colors in Data Dictionary Manager.
Sequence Allows you to enter the sequential number of the current terminal on its terminal
strip.

Procurement Tab (Terminal Common Properties Dialog Box)


Enables you to enter information related to ordering a specific terminal for your inventory.
Manufacturer Allows you to select a manufacturer. You can define and customize
manufacturers in the Data Dictionary Manager.
Model Allows you to select a terminal model. The available models are specific to the
manufacturer. You can select a model without selecting a manufacturer. The software then
selects the appropriate manufacturer automatically according to the selected model. You can
define and customize models in the Data Dictionary Manager.
Store part number Allows you to enter a reference number for the terminal in your
inventory. This read-only value comes from the reference cable used as the basis for this cable.

SmartPlant Electrical User's Guide

825

SECTION 40

Toolbars and Ribbons


Actions Toolbar
The Actions toolbar contains commands that allow you to carry out various commands with
electrical items in your plant. This toolbar displays by default docked to the left side of the
interface.
Batch Load Association Allows you to perform batch load
association between loads and power distribution boards.
Dissociate Dissociates a selected item in the Electrical
Engineer from its parent item.
Batch Size Cables Allows you to perform batch sizing for a
selected group of power cables.
Replace Cables Allows you to perform batch replacement of a
group of cables within a particular category (power, control, or
grounding).
Apply Options Allows you to apply a profile, a circuit, or control
stations to motors or to apply lookup table data to items.
Generate SLD for PDB Generates a single line diagram for a
selected PDB.
Generate Schematic Generates a new schematic for a selected
item.
Design PDB Layout Opens the environment where you can
design the layout of a power distribution board.
Define Document Reference Defines a reference to an
external document.
Associate Document Associates external files or documents
with the selected item.
Resolve Symbol Inconsistencies Resolves symbol
inconsistencies in an open cable block diagram.

SmartPlant Electrical User's Guide

827

Toolbars and Ribbons

Align Ribbon
Align Left Aligns the left side of objects in a select set.
Align Right Aligns the right side of objects in a select set.
Align about Horizontal Aligns the objects in a select set along
their horizontal centers.
Align about Vertical Aligns the objects in a select set along
their vertical centers.
Align Top Aligns the tops of objects in a select set.
Align Bottom Aligns the bottoms of objects in a select set.

828

SmartPlant Electrical User's Guide

Toolbars and Ribbons

Change Toolbar
The Change toolbar contains commands that you can use to modify the graphic elements in a
drawing. You can activate the Change toolbar by using the View > Toolbars command.
Icon

Description
Move Moves elements from one location to another.
Align Allows you to align two or more elements in a selection
set.
Nudge Moves a drawing item using keypad arrows.
Offset Draws an offset copy of an element or a set of contiguous
elements.
Rotate Rotates one or more elements.
Mirror Mirrors one or more selected elements about a line that
you define.
Scale Reduces or enlarges selected elements by a scale factor
that you define.
Bring to Front Moves a selected element to the front of the
display order.
Send to Back Moves a selected element to the back of the
display order.
Pull Up Moves a selected element up one position in the display
order.
Push Down Moves a selected element down one position in the
display order.
Connect Makes a point fixed on another element.
Horizontal / Vertical Makes a line or two points horizontal or
vertical.
Parallel Makes two lines parallel.
Perpendicular Makes a line or arc perpendicular to another
element.
Tangent Makes two elements tangent.
Colinear Makes two lines colinear.
Concentric Makes two arcs or circles concentric.
Symmetric Makes two elements symmetric.
Equal Makes two elements or dimensions equal.
Lock Locks an element so that it cannot be moved.
Relationship Handless Toggles the display of relationships
within the active window.

SmartPlant Electrical User's Guide

829

Toolbars and Ribbons


Icon

Description
Alignment Indicator Turns on the horizontal and vertical
relationship indicator.

Draw Toolbar
The Draw toolbar displays by default docked to the left side of the interface. You can use the
commands on this toolbar to place the basic elements of your symbol.
Select Tool Use to select, modify, and manipulate elements.
Line Draws one line or a series of connected lines.
Tangent Arc Draws an arc tangent or perpendicular to one or two
elements.
Line/Arc Continuous Creates lines and arcs.
Circle by Center Point Draws a circle using a center point and
radius.
Ellipse by Center Point Draws an ellipse using the center point
and two edge points.
Rectangle Draws a rectangle using three points.
Curve Draws a smooth, open or closed curve.
FreeSketch Draws lines, arcs, rectangles, and circles by converting
a sketch into a precision drawing.
Fillet Draws a fillet between two elements.
Chamfer Draws a chamfer, or bevel.
Trim Trims open and closed elements to the closest intersection in
both directions.
Extend to Next Extends one or more open elements until they
intersect with the nearest element.
Connector Connects two elements together.

830

SmartPlant Electrical User's Guide

Toolbars and Ribbons

Edit Drawing Toolbar


The Edit Drawing toolbar contains commands that you can use to edit or insert text, activate the
connection and jumper mode, and so on. To activate the Change toolbar click View > Toolbars.
Insert Text Inserts a text annotation.
Edit Text Edits a text annotation.
Toggle Redlining Turns on or off redlining mode.
Activate Connection Mode Turns on the connection mode in
wiring diagrams. Press ESCAPE on your keyboard to turn the
connection mode off.
Activate Association Mode Turns on the association mode that
allows non-power flow associations in cable block diagrams. Press
ESCAPE on your keyboard to turn the connection mode off.
Show/Hide Association Connectors Toggles the display of
logical connectors that shows non-power flow associations
between items in cable block diagrams.
Activate Jumper Mode Turns on the jumper mode. Press
ESCAPE on your keyboard to turn the jumper mode off.
Disconnect Disconnects electrical items.
Remove Removes the selected item from the drawing.
Move Cell Moves a cell to another location in a PDB Layout grid.
Remove Cell Moves a cell to another location in a PDB Layout
grid.
Change Branch Orientation Changes the orientation of an SLD
branch connected to a selected power source.
Toggles Marking of Auxiliary Graphics Marks or does not
mark auxiliary graphics.

SmartPlant Electrical User's Guide

831

Toolbars and Ribbons

Label Toolbar
The Label toolbar allows you to attach various types of labels to symbols
SmartDimension Dimensions all geometry.
Distance Between Dimensions the distance between elements.
Angle Between Dimensions the distance between multiple
elements.
Axis Sets the dimension axis.
Coordinate Dimension Places a coordinate dimension.
Symmetric Diameter Places a symmetric diameter dimension.
Measure Distance Measures the distance between two points.
Measure Area Measures the area of closed areas.
Text Box Creates a box where text can be entered.
Character Map Provides access to the Microsoft Character
Mapping functionality.
Leader Adds leaders to annotation elements or existing leaders.
Balloon Places a balloon next to an element or a free space point.
Fill Fills a closed region.

Main Toolbar
The Main toolbar contains commands for the most common commands in the software. This
toolbar is displayed by default docked to the left side of the interface.
New Item Creates a new item of the selected item type..
Open Drawing Opens an existing drawing.
Save Saves the active document.
Print Prints the open file.
Cut Deletes the selected item and moves it to the Clipboard.
Copy Copies the selected item to the Clipboard.
Paste Pastes the contents of the Clipboard.
Delete Deletes the selected items.
Duplicate Duplicates the selected item.
Select Tool Selects drawing elements.
Zoom Area Allows you to select an area on the drawing that zooms to

832

SmartPlant Electrical User's Guide

Toolbars and Ribbons


fit the entire display area.
Zoom In Zooms in on a drawing element in fixed increments.
Zoom Out Zooms out on a drawing element in fixed increments.
Fit Resizes the drawing to fit the display area.
Pan Pans across the drawing to enable you to view different areas.
Document Properties Opens the properties of the selected
document.
Common Properties Opens the Common Properties dialog box for
the selected item.
Properties Window Displays or hides the Properties window.
New Electrical Index Opens a new Electrical Index window.
New Electrical Engineer Opens a new Electrical Engineer window.
New Reference Data Explorer Opens a new Reference Data
Explorer window.
New Reference Electrical Engineer Opens a new Reference
Electrical Engineer window.
New Table Opens the Tabular Editor for items of the selected class.
New Project Management Opens a new Project Management
window.
Help Opens the appropriate Help topic in the Online Guide.

SmartPlant Electrical User's Guide

833

Toolbars and Ribbons

Modify Connector Ribbon


This ribbon contains commands that allow you to modify the display of connectors. You can define
the connector line style, color, type, width, and so forth. Also, you can define the connector
clearance. This ribbon becomes available after clicking a cable or a connector in a cable block
diagram.
Terminators are compatible with any of the linear styles.
List

Style Sets the line style for the connector.


Line Color Sets the line color for the connector.
Line Type Sets the connector line type and style.
Line Width Sets the line width for the connector.

List

Line Start Terminator Sets the terminator for star ting the
connector.

List

Line End Terminator Sets the terminator for ending the connector.
Diagonal Mode (ALT) Allows you to either place or modify a
connector with diagonal segments.
Insert Segment Mode (ALT+S) Inserts line segments into the
connector.

834

List

Clearance Allows you to define a connector clearance.

List

Parallel Pairs Allows you to select a pair of equipment items that


you want to connect in parallel. For details, see Connect Equipment
Items in Parallel (on page 202).

SmartPlant Electrical User's Guide

Toolbars and Ribbons

SmartPlant Electrical User's Guide

835

SECTION 41

Using Help
Online user assistance makes command information available as you perform tasks. You can
access different kinds of information any time that you are running the software. This information
includes reference topics, narrative descriptions, or instructional material.
The software offers the following important user-assistance features:

Online Help
A structured table of contents, an index, and full-text search capabilities provide easy access to
Help topics. Press F1 any time you need online Help during a session. You can access the table
of contents by clicking Help > Electrical Help, or by clicking the Help command on the toolbar.

Learning Tools
You can click Help > About Electrical to see your software version and license information.

User Interface Features


ToolTips help you find toolbar command names. When you point to a command button on the
toolbar and pause over it, a label displays the name of the command.

Printable Guides
You can click Help > Printable Guides and choose to display the Help contents in portable
document format (.pdf). Then you can print the file if necessary.

SmartPlant Electrical User's Guide

837

Using Help

838

SmartPlant Electrical User's Guide

Glossary
A
active power
The quantity of electrical power (in W, kW, or MW) supplied to a consumer that is capable of
producing actual work. See also: rated active load, consumed active load.

actual length
A derived value that SmartPlant Electrical uses for cable sizing, cable drum assignment, and so
forth. If a cable has a value for Estimated length, but no value for Design length, then the
Estimated length is also the Actual length. If there is a value for Design length only, then this is
also used as the value for Actual length.

annotations
Dimensions, notes, symbols, or reports that you place in a drawing to provide information or
comments.

ANSI
American National Standards Institute.

apparent power
The quantity of electrical power (in VA, kVA, or MVA) that represents the vector sum of the active
load and reactive load for a motor. This quantity is the actual power that the electricity supply
company needs to generate.

As-Built
The operational plant that is used as the source of data for your projects.

asynchronous speed
The maximum attainable rate of rotation of a motor shaft, in rpm. This quantity is always less
than the synchronous speed because of energy losses due to the magnetic field, pole
architecture, and so forth.

SmartPlant Electrical User's Guide

839

Glossary
attribute
1. A property or characteristic of a component.
2. A characteristic that all members of a class possess. Each property has an associated value
that defines its current state. Most databases represent an attribute by a column in a table.

average power
The average electrical power consumption for a consumer, used to calculate overall electrical load
requirements. The average load is calculated by multiplying the rated active load by the
operating factor.

B
block
A block is the basic drawing unit of a schematic. Each block graphically represents the
functionality of an item or a related group of items. Each block must belong to a block type, which
you can use to classify the blocks according to the items they represent; for example, a motor and
its cables, or a circuit block with its bus, cell, and PDB. The block also specifies the drawing file
that contains the graphical information for the items.

block
A block is the basic drawing unit of a schematic. Each block graphically represents the
functionality of an item or a related group of items. Each block must belong to a block type, which
you can use to classify the blocks according to the items they represent; for example, a motor and
its cables, or a circuit block with its bus, cell, and PDB. The block also specifies the drawing file
that contains the graphical information for the items.

brake power
The minimum mechanical power required to make the motor shaft rotate and drive the pump or
process equipment attached to the motor.

bucket
See cell.

buffer
A temporary data store used for setting aside items before you decide whether to scope those
items.

840

SmartPlant Electrical User's Guide

Glossary
bus riser, bus tier
See riser circuit.

busbars
Busbars are used in place of standard cables to interconnect electrical equipment requiring high
current. They consist of strips of copper, usually arranged in groups of three or four. Each set of
busbars operates at a specified rated voltage.

C
cell
A removable compartment in a power distribution board that contains circuitry.

claim
Selection of an item in a project so that it can be edited in that project.

claim mode
Indicates whether a claimed item is available for all available projects (shared claim) or only for the
selected project (exclusive claim).

coincidence factor
The fraction of the maximum possible utilization of the motor for a specified operating mode. The
software uses this factor when calculating the total load consumption of a power distribution board
or electrical system.

compartment
A section of a power distribution board that contains the required circuitry.

consumed active load


The quantity of electrical power used by a consumer when operating at the brake power.

consumer
See load.

SmartPlant Electrical User's Guide

841

Glossary
control station
A local or remote panel containing a low-voltage circuit, used to control the operation of a motor
via a control circuit.

converting equipment
Equipment used to convert one level or type of electric property to another. Converting
equipment includes transformers, battery chargers, UPS units, and variable-frequency drives
(VFDs).

coupler circuit
A circuit that connects two buses in a power distribution board for the purpose of creating a bus tie.
This circuit belongs to the bus that serves as the power source of the coupled bus in the PDB.

cubicle
See cell.

D
data dictionary
The underlying data model of a plant, consisting of database entries and select lists. SmartPlant
Data Dictionary Manager maintains this information.

data model
Application items that populate a project. Typical items in a data model are components, lines,
and labels.

demand factor
A quantity expressing the ratio of brake power to motor rated power. The demand factor can
have values between 0 and 1.

demand point
The point where the motor operates at its brake power.

842

SmartPlant Electrical User's Guide

Glossary
disconnect electrical equipment
Equipment used to disconnect a load from the power supply. Disconnect electrical equipment
includes switches, starters, overload relays, fuses, circuit breakers, and protection relays.

distribution board
A box divided into panels, used to distribute the power supply to the various loads, and to
transform the voltage as required. See also: power distribution board.

distribution equipment
Equipment used to distribute the power supply among several loads. Distribution equipment
includes power distribution boards (PDBs), motor control centers (MCCs), disconnect electrical
equipment, cables, and panels.

drawing file
A file in which you place items; also called a design file.

E
efficiency
A quantity expressing the ratio of useful power output to power input. Efficiency can have values
between 0 and 1.

electrical distribution network


The arrangement of buses, cables, and distribution boards used to bring electrical power to the
loads.

enclosure
The physical housing of a piece of electrical equipment used to protect the equipment from its
environment.

enclosure protection
The level of protection afforded to a motor from its environment. For example, the operational
environment of the motor may require that the enclosure is sealed or explosion-proof.

SmartPlant Electrical User's Guide

843

Glossary
EPC
Engineering Procurement Contractor: a company that has responsibility to design and erect a
plant.

F
feeder
A circuit that distributes power from a distribution board downstream to other types of equipment.

frame size
A US standard that defines the physical and mechanical properties and dimensions of a motor.

full load amperes (FLA), full load current (FLC)


The electrical current drawn by a motor when operating at maximum load. This quantity is
required for sizing cables that supply power to the motor.

full load current


See full load amperes.

I
IEC
International Electrotechnical Commission, a European electrical standard.

incomer
A circuit that supplies power to a power distribution board.

item status in project


Describes the status of a particular item in the project. Possible statuses are: Scoped, Claimed,
Completed, or Merged.

L
load (consumer)
An electrical device, such as a motor or heater, that draws power from the electrical distribution
network.

load center
See power distribution board.

844

SmartPlant Electrical User's Guide

Glossary
load factor
See demand factor.

locked rotor current (LRC)


The initial electrical current required to start rotation of a motor. Depending on the motor, this
quantity is typically 400 - 1000% larger than the full load current of the motor. Usually, the motor
nameplate specifies the LRC/FLA ratio, and this ratio is multiplied by the motor FLA to calculate
the LRC value.

M
macro
A macro is a string attached to a graphic block that represents the item type and one of its
properties. You can assign one or more macros to a block. When you generate a schematic
drawing, the software reads and resolves the macros so that it can retrieve the value of the
property from the database and display it in the drawing.

main item
A term used to describe almost any item added in As-Built that can be a focal item with related
items. Main items can include loads, converting equipment, power sources, free cables, PDBs,
and documents. You can only scope main items if they are included in a plant group that has
been scoped.

merge
The action of moving items whose data was modified in a project back to the As-Built schema.

minimum required power


Under the IEC Standard, the minimum mechanical power that the motor shaft is required to supply
when operational.

SmartPlant Electrical User's Guide

845

Glossary
miscellaneous drawings
Drawings that you create based on a template, to which you can add symbols. You can revise
miscellaneous drawings, as you can any other SmartPlant Electrical document, and associate it
with any item in your plant.

motor control center (MCC)


A power distribution board providing the necessary electrical power for motor loads.

motor rated power (MRP)


The maximum mechanical power that a motor shaft is required to supply. This quantity is usually
marked on the motor nameplate, and is used in calculating the electrical power requirements for
the motor.

motor speed
The rate of rotation of the motor shaft, in rpm. Motor speeds are characterized by two standard
quantities: the synchronous speed and the asynchronous speed.

N
naming convention
The naming convention is a means of ensuring a consistent structure and maintaining uniqueness
of tags for items of the same type. Once you define a naming convention for an item type such as
motors, the software tags any new items of that type using the mask and structure of the naming
convention. The naming convention is a combination of properties, text strings, and separators
that makes up the tag structure in the Electrical Index. You define naming conventions in the
Options Manager.

NEC
National Electric Code, a US electrical standard.

O
operating factor
A quantity expressing the ratio of the load power requirement at the operating point to the rated
power. The operating factor can have values between 0 and 1.

846

SmartPlant Electrical User's Guide

Glossary
operating mode
A description of how the motor is used in practice in the plant. The operating mode can be:
continuous, intermittent, normal, standby, or spare, and a quantitative measure of the motor
behavior in each mode is provided by the coincidence factor.

operating point
The point where the motor operates under normal working conditions.

owner operator
A company that owns and operates a plant.

P
panel circuit
A circuit that can be created in a local panel or a junction box.

particular power
Under the IEC Standard, the mechanical power that a motor shaft is required to supply when
operating under a specified set of conditions, for example, once a year.

plant
A group of facilities and equipment that performs one or more material processing functions within
a given geographical area. One company can have several plants located at different
geographical locations.

power distribution board (PDB)


A distribution board containing components of the electrical distribution network at the supply
level.

power factor (cos f)


The ratio between active load and apparent load. The power factor can have values between 0
and 1.

SmartPlant Electrical User's Guide

847

Glossary
profile
A profile is an assembly of various typical items that you can use as a template for creating project
items. For example, you can create a motor profile that consists of the following reference items:
a motor, one or more cables, a control station, a circuit with protection devices, and schematic.

project
A separate electrical schema within a plant used to claim items for updating when performing
routine maintenance or modernization (revamp) for that plant. To facilitate plant modernization,
you can create a number of projects within a single plant. Within a particular plant, the projects
and As-Built have a common reference schema and data dictionary.

project status
Describes the status the project as a whole. Possible statuses are: Active, Completed, Merged,
or Cancelled.

property
A unique characteristic of an object, item, symbol, or document.
The properties of an item can include display properties and properties stored with the item. For
example, the properties of a valve symbol can include display properties such as color, line style,
and width. Other properties stored with the valve symbol can include the manufacturer, cost, or
material. Properties stored with the valve symbol are displayed in the Properties window when
the valve symbol is selected.

R
rated active load
The maximum quantity of electrical power used by a consumer when operating at the rated power.

rated power
The maximum output power that a load can produce. See also: motor rated power.

rated voltage
The voltage at which a piece of equipment is designed to operate. This quantity is required to
ensure electrical compatibility between the electrical supply and the equipment.

848

SmartPlant Electrical User's Guide

Glossary
reactive power
The component of the supplied electrical power (in VAR, kVAR, or MVAR) that the load uses to
provide reactive energy.

reference data
A collection of information containing facts relative to industry design codes, catalog data of
vendors, job specifications, commodity libraries, graphics symbology, label descriptions, report
formats, and other information of a similar theme.

reference plant group


A plant group containing reference data, options settings, naming conventions, and so forth, that
you can use as a source for copying. Usually, a reference plant group does not belong to your
current plant structure. You can access a reference plant group and view naming conventions
only from Options Manager.

related item
An item that has an electrical relationship to a main item and which the software scopes
automatically when the main item is scoped. Related items may include control stations,
associated cables, circuits, and signals. Some scoped items may belong to unscoped plant
groups.

relation rule
A rule in which consistency criteria apply to two specific components. Relation rules ensure that
correct relationships are created when you create a new relationship or modify properties or
values of related items in SmartPlant Electrical.

report template
An online outline for a new report that you need to define. You can select a user-level or a
project-level template to create a new report template.

resistive load
A load that has resistive characteristics.

riser circuit
A circuit that connects two buses in a power distribution board for the purpose of creating a bus tie.
This circuit belongs to the bus that serves as the receiver of backup power from the feeder bus in
the PDB.

SmartPlant Electrical User's Guide

849

Glossary
rotor
The rotating part of a motor or generator.

run-up rime
The time it takes a motor to reach its operating speed after switching on the power.

S
schematic
A graphical representation of the wiring of a load, its feeder circuit and its controls, which includes
specific data for that particular load.

schematic file
Schematic drawing or diagram of a particular item in the plant.

scope
In Engineering Manager, the scope defines the extent of the items that you are able to view and
subsequently claim, based on plant group levels of the project. In SmartPlant Electrical, any item
that you scope in As-Built becomes available for viewing in the project. When you select and
scope main items, the software includes certain related items in the scope.

search criteria
Set of values used to scan a database or object library.

segregation level
A term used to group cables that share a common electrical signal and can therefore be run along
the same routing path. You use segregation levels to distinguish between different groups of
cables that if routed together could produce electrical or magnetic interference. Examples of
such groups include high or low voltage cables, cables of different types or sources, or cables
associated with different applications or systems.

server
In network operations, the node that maintains common data or performs a common task that
clients need. All network operations between two or more nodes establish a client/server
relationship.

850

SmartPlant Electrical User's Guide

Glossary
shaft
The part of a motor or generator that drives the attached equipment.

signal
An item type that is used for mediating between SmartPlant Electrical and SmartPlant
Instrumentation. You can associate a signal with a load, a control station, or a circuit for the
purpose of publishing data to SmartPlant Instrumentation. You can perform wiring connections
in SmartPlant Instrumentation and retrieve the host information back to SmartPlant Electrical,
where it appears as read-only properties of the signal. SmartPlant Electrical can then use the
values of those properties to display I/O assignment information in a schematic.

single component rule


A rule in which consistency criteria apply to one component only. Single component rules
validate consistency of the properties or property values of a specific item tag.

single line diagram (SLD)


A schematic one-line diagram representing the electrical distribution network.

static load
Equipment that does not rotate; for example, heaters, lighting equipment, other machines are
static loads.

stator
The stationary part of a piece of rotating electrical equipment, such as a motor or generator.

strip
A termination item used for making wiring connections. A strip is always at the lowest level in the
hierarchy of distribution equipment.

switch board
See power distribution board.

switchgear
See power distribution board.

SmartPlant Electrical User's Guide

851

Glossary
synchronous speed
The maximum theoretical rate of rotation of a machine shaft, in rpm, assuming no energy losses
due to the magnetic field, pole architecture, and so forth. See also: asynchronous speed.

T
Te stall time
The time it takes a motor to come to rest after switching off the power.

U
unit
Group of parts of the schematic and individual worlds of a plant that together perform a given
process function. The identifying number of the unit is unique within the project and within the
plant. Most companies, but not all, use the concept of unit.

852

SmartPlant Electrical User's Guide

Index
A
actions 819, 820
description 820
Log 820
Options Manager settings 820
Reject 820
rule priorities 819
Warn 820
aligning 357, 359, 360, 828
Align command 360
align ribbon 828
drawing objects 359
overview 357
alternative feeders 119, 120, 121
associating 120
changing 120
dissociating 121
annotations 273, 278, 349, 350, 351
deleting 351
editing 350
in schematics 273, 278
inserting 349
inserting graphics 350
overview 349
applying 126, 668, 671
applying options
batch mode 126
lookup tables to items 126, 671
overview 125
profiles 130, 668
typical circuits 669
typical control stations 128
typical I/O sets 672
typical schematics 671
As-Built
adding items 456
claiming items overview 457
comparing with project documents 462
filtering the display 466
generating a report 467
merging into As-Built 464
merging into As-Built overview 462
modifying a project status 452
project management overview 449
Project Management Table (As-Built)
748
Project Management Window (Project)
751

SmartPlant Electrical User's Guide

Project Status dialog box 754, 755


releasing claim 459
releasing items from merge 461
rules for changing statuses 451
rules for scoping items 454
running a test merge 464
scoping items 456
scoping items overview 453
scoping projects 450
selecting projects 453
setting display options 466
understanding statuses 450
using the buffer 457
ascending order 619
assemblies 61, 62
copying 62
creating 61
assigning
batch cable-drum assignment 177
cable routing 165
control stations to motors 670
loads to typical circuits 127
loads to typical I/O sets 132
loads to typical schematics 129
typical circuit data to circuits 123
associating
a single load with a PDB 208
associating registered reports 394
automatic creation of feeders 195
bus riser circuits with coupler circuits 196
changing existing associations 191
circuits 756
control station cables with equipment
197
control stations with cables 43, 136, 197
control stations with loads 136
dissociating electrical equipment 193
dissociating external documents 370
dragging items to the Electrical Engineer
186
external documents 370
instrument cables with equipment 197
items in KKS mode 417
loads 674
loads with a PDB in batch mode 205
loads with control stations 196
loads with feeders 194
miscellaneous drawings 372
non-power cables with equipment 199

853

Index
power cables with equipment 198
AutoCAD 588
autofilter 378
automatic drum - cable assignment 621,
622

B
batch application of options 126
batch item creation 82
batch load association 205
batch operations 820
Options Manager settings 820
Warn action 820
batch sizing cables 147, 624
compare documents 733
battery banks 78, 79, 101, 128, 196, 680,
681, 682
applying typical control stations 128
associating with control stations 196
controls and signals 682
creating 101
deleting 79
duplicating 78
electrical data 681
general data 680
instrument data 682
battery chargers 78, 79, 102
adding 102
deleting 79
duplicating 78
blocks 51, 52, 265
sequencing items 265
brief properties 72, 75, 76
bulk properties 72, 74, 75
bus riser circuits 122, 196
associating with coupler circuits 196
creating 122
bus ties 196
buses
associating a single load 208
associating electrical equipment with
feeders 194
associating loads in batch mode 205
calculating load summaries 253
calculating load summaries overview
214
calculating loads for all buses 253
changing bus symbols in SLDs 285
creating 106
creating stand-alone buses 107
deleting 107
displaying associated loads 211
displaying bus load data 211

854

enhanced load summary report 254


SLD symbol creation guidelines 310
validating total loads 211

C
cabinets 743, 744, 745, 746
electrical data 744
feeder data 745, 746
general data 743
cable block diagrams
creating diagram 324
finding items in the EI or EE 355
hiding cables 329
opening existing diagram 319
overview 317
removing items 327
show related items 356
cable drums
assigning cables to 175, 176
automating splicing 177
batch assigning cables 177
calculations 181
creating 174
editing 175, 639
properties 639
rules 181
selecting reference cables for 175, 650
unassigning cables from 182
cable route 664
properties 664
cable routing 165, 166, 167, 169, 172, 308,
309, 628, 657, 659
assign components to segments 166
assigning cables 628
batch mode 657
batch routing cables 166
clearing 167
create cableway and segments 165
defining 166
edit cableway 169
overview 165
segment fill 169, 172
segment validations 308, 309, 659
setting calculation criteria 172
setting validation method 172
validation 169, 172
cable sets 340, 341, 641
connecting 340
disconnecting in wiring drawings 341
properties 641
cables
adding 140

SmartPlant Electrical User's Guide

Index
adding parallel power cables to equipment
198
adding reference cables 139
applying reference data 620
associating bus riser circuits with coupler
circuits 196
associating glands 143
associating non-power cables with
equipment 199
associating power cables with equipment
198
associating with control stations 43, 136,
197
automatic assignment to drums 621, 622
batch connection 339
batch sizing 147, 624
cable set properties 641
comparing reference data 642, 643
connection properties 773
connections 632
connections common tasks 334
continuous connection method 337
custom connection method 336
deleting 142
design data properties 628, 772
disconnecting in wiring drawings 341
display / hide multiple cables 183
dissociating cable sides and glands 144
earth loop impedance 573, 637
editing 141
editing reference cable properties 140
general properties 625, 769
overview 139
parallel cables in SLDs 285
procurement 638
procurement properties 773
project 624
reference 769
replacing 155, 647
replacing cable side associations 157
selecting for connection to a control
station 647
sizing 146
sizing algorithms 151
sizing data properties 633
cableway 165, 169
creating 165
editing 169
calculated electric consumption 205, 208,
211
calculations
batch load assignment 249
bus load connectivity 219

SmartPlant Electrical User's Guide

bus load summaries overview 214


bus loading 224
bus properties 250
cable drum 181
circuit properties 250
compensated and uncompensated data
214
converting equipment properties 250
correcting bus power factors 247
custom 574, 577
electrical load data overview 214
electrical load for all buses 253
electrical load for all PDBs 253
electrical load for selected buses 253
electrical load for selected PDBs 253
flow of activities 249
implementing 576
preferences 248
capacitors 78, 79, 85, 247
adding 85
correcting bus power factors 247
deleting 79
duplicating 78
Catalog Manager 279, 280, 310, 313
complete symbol file for schematic blocks
280
placing connection points on symbols
313
recommended workflow for schematic
blocks 279
recommended workflow for SLD symbols
310
cells 107, 116, 118, 119, 194, 733
associating with loads 194
automating cell size 119
cell macros 116
creating 118
deleting 107
properties 118
changing 73, 191, 619
changing naming conventions 26
existing electrical associations 191
overview 26
properties 73, 607
relationship properties 72
select list entries 619
select set properties 72
circuit components 44, 45, 59, 60, 107,
122, 123, 124
applying lookup tables 59
associating lookup tables 59
automatating load based sizing 60
copying 123

855

Index
creating 44, 45, 124
deleting 107
circuit mode 121
associating with lookup tables 122
circuits 44, 45, 107, 122, 123, 124, 138,
194, 195, 755, 756, 757
assigning typical circuit data 123
associated items 757
associating with loads 194
associating with lookup tables 122
automatic creation of feeders 195
circuit breakers 44, 45, 123, 124
creating 122
creating panel circuits 138
creating reference circuits 44
deleting 107
electrical data 756
general data 756
moving 124
claiming 458, 459
adding items 458
claim modes 459
claiming items 458
reclaiming items 459
releasing claim 459
Clear Mark as Completed 460
closing 588, 589
drawings 588
SmartPlant Electrical 589
Tabular Editor 588
common tasks
external documents 369
managing cable drums 175, 176
managing PDBs 105
managing power distribution boards 122
compartments 733
compensated electrical data 214
conductors 340, 341
connecting 340
disconnecting in wiring drawings 341
conformity to standard 633, 693
connecting 612, 647
cables to control stations 647
to databases 612
to plant structures 612
connection points 313
placing on symbols 313
connections 103, 335, 336, 337, 339, 340,
341, 342
batch cable connection 339
connecting cable sets 340
connecting single conductors 340

856

continuous cable connection method


337
custom connection method 336
customizing jumper symbols 342
defining connection types 335
jumpering terminals 341
transformers 103
consumed electrical power 205, 208, 211
contactors 44, 45, 123, 124
control cable associations with equipment
199
control stations 43, 128, 136, 196, 197,
670, 747
applying typical control stations 128
assigning to motors 670
associating cables 43, 136, 197
associating cables with equipment 197
associating loads 196
project 136
reference 43
conventions 405
for KKS mode 405
converting equipment 78, 79, 102, 128,
196, 683, 684, 687, 689
adding 102
applying typical control stations 128
associating with control stations 196
controls and signals 686
deleting 79
duplicating 78
electrical data 684
feeder data 687, 689
general data 683
instrument data 687
copying 27, 44, 45, 62, 77, 123
bulk properties 74, 75
circuit components 44, 45
default data 27
default items 77
internal equipment 44, 45, 123
items 590
power network structures 62
reference items 77
coupler circuits 122, 196
associating with bus riser circuits 196
creating 122
custom folders
applying filters 69
creating 68
deleting 69
overview 67
custom symbols
adding a custom symbol 347

SmartPlant Electrical User's Guide

Index
associate symbol 600
deleting a symbol 348
custom validations and calculations 574,
577
customizing 75, 76, 567, 597
data 567
data display 75, 76
toolbars 597

D
daisy-chain connection pattern 202
data customization 567
Data Dictionary templates 407
data display 61, 183
Electrical Engineer 183
Reference Electrical Engineer 61
data model 567
database connection 612
DDT files 407
default DDT file for KKS mode 407
default cables 139, 140, 769
default control stations 774
default data 27
copying 27
default items
adding 40
copying 77
default panels 42, 43
defining 135
defining reference items 40, 42, 51, 139
blocks 51
brief properties 72, 76
bulk properties 72, 74, 75
cables 139
panels 42
project panels 135
report items 398
table layouts 375
tables 605
deleting 79, 142
cables 142
items 79, 589, 590
descending order 619
designing PDB layouts 116, 733
zooming 733
disconnect electrical equipment 690
disconnect switches 44, 45, 123, 124
display rules in Electrical Engineer 183
displaying 72, 73, 75, 183, 597
brief properties 75, 76
data in Electrical Engineer 183
null data 75, 76
properties 72, 73, 75, 597

SmartPlant Electrical User's Guide

tables 605
displays 596
filters 596
dissociating 193, 370, 371
batch dissociation of external documents
371
electrical equipment 193
external documents 370
distribution equipment 44, 45, 123, 124
document properties 735, 737
revisions 735, 737
documents
associating external documents 370
associating registered reports 394
compare 733
compare in batch mode 733
comparing As-Built and project
documents 462
comparing documents 367, 368
defining external document references
369
dissociating external documents 370
dissociating multiple items 371
external documents common tasks 369
global revisions 366
opening external documents 371
opening PDB layout for selected PDB
117
opening schematics 279
opening SLDs 293
opening SLDs from Documents folder
294
opening SLDs from Electrical Engineer
294
overview 365
revisions in single documents 365
drag-and-drop rules 63, 187, 192
from the Electrical Index to the Electrical
Engineer 187
from the Reference Electrical Engineer to
the Electrical Engineer 63
within the Electrical Engineer 192
drawing 355
drawing templates 255
drawings 355, 356, 372, 587, 588, 589
creating miscellaneous drawings 372
manipulating 355
miscellaneous 372
properties 589
saving 588, 589
view associated 355
viewing 356
zooming 356

857

Index
drums 621, 622
automatic cable assignment 621, 622
dual source power supplies 119, 120, 121
associating alternative feeder 120
dissociating 121
duplicating 78, 85
items 78
motors 85

E
earth loop impedance 573, 637
editing 43, 46, 52, 53, 56, 73, 78, 83, 136,
140, 141, 175, 395
cable drums 175
control stations 136
electrical motor properties 83
item properties 78
lookup tables 56
profiles 46
project cables 141
properties 73, 374
reference cables 140
reference control stations 43
relationship properties 72
report templates 395, 398
select set properties 72
table items 373
typical control stations 43
typical schematic blocks 52
typical schematics 53
electrical analysis SLDs 447, 799
electrical associations
automatic creation of feeders 195
changing 191
creating 186
daisy-chain connection 202
dissociating 193
finding parent items 185
electrical cables 624, 769
electrical consumption 205, 208, 211
electrical distribution equipment 44, 45,
123, 124
Electrical Engineer 29, 61, 63, 70, 183,
185, 186, 187, 192, 195, 202, 288, 293,
294, 304, 355
automatic creation of feeders 195
daisy-chain connection 202
display rules 183
drag-and-drop rules 192
dragging items from the Electrical Index
186, 187
dragging items from the Reference
Electrical Engineer 63

858

finding items from cable block diagrams


355
finding items from wiring drawings 355
finding items in SLD drawings 304
finding parent items 185
generating single line diagrams 288
grouping related items 70
opening single line diagrams 294
opening SLDs 293
overview 183
PDB display preferences 29
Reference Electrical Engineer 61
Electrical Index 70, 187, 289, 291, 304, 355
batch generation of SLDs 291
customizing sort sequence within folders
70
drag-and-drop rules 187
finding items from cable block diagrams
355
finding items from wiring drawings 355
finding items in SLD drawings 304
generating single line diagrams 289
grouping related items 70
electrical motors 41, 79, 82, 83, 85, 692,
693, 696, 697, 698, 700
adding 82
calculating power requirements 83
controls and signals 697
deleting 79
duplicating 85
editing properties 83
electrical data 696
feeder data 698, 700
general data 692
instrument data 698
load data 693
reference 41
electrical power calculations 569
electrical relationship 183
Enhanced SmartLoop reports 277, 278
equipment profiles 668
error log files 33, 34
exiting SmartPlant Electrical 589
external documents 365, 369, 370, 371
associating 370
common tasks 369
defining document references 369
dissociating 370
dissociating multiple items 371
opening 371
overview 365

SmartPlant Electrical User's Guide

Index

F
feeder circuit location 124
feeders 119, 120, 121, 122, 194, 195, 389,
687, 689, 698, 700, 709, 710, 719, 720,
727, 728, 745, 746
alternative 119
associating alternative feeder 120
associating cabinets with feeders 745,
746
associating converting equipment with
feeders 687, 689
associating instruments with feeders
709, 710
associating loads with feeders 194
associating motors with feeders 698,
700
associating other electrical equipment
with feeders 719, 720
associating static loads with feeders
727, 728
automatic creation 195
changing alternative feeder 120
creating 122
dissociating alternative feeder 121
Enhanced All Feeder Load Summary
report 389
filtering 596
Design window 596
displays 596
filters 596
autofilter 378
properties 666
tables 374, 375
folders 70
customizing sort sequence within folders
70
formats 588
fuses 44, 45, 123, 124

G
gapping 309, 310, 603
generating 382
reports for selected items 382
generators 78, 79, 99, 128, 196, 701, 703,
704
applying typical control stations 128
associating with control stations 196
controls and signals 704
creating 99
deleting 79
duplicating 78
electrical data 703

SmartPlant Electrical User's Guide

general data 701


instrument data 704
glands
associating with cable sides 143
creating 143
global revisions 366
grounding cable associations with
equipment 199

H
handles 591
harmonic filters 78, 79, 85
adding 85
deleting 79
duplicating 78
heat traces 78, 79, 85
adding 85
deleting 79
duplicating 78
heaters 78, 79, 85
adding 85
deleting 79
duplicating 78
Help 606
hierarchy of plant groups 612
hyperlinks 610

I
I/O signals
associate in batch mode 345
create 344
dissociating 345
overview 344
incomers 122
creating 122
instrumentation cable associations with
equipment 199
instruments 197, 705, 706, 707, 708, 709,
710
associating cables with equipment 197
controls and signals 707
electrical data 706
feeder data 709, 710
general data 705
instrument data 708
interface to SmartPlant Instrumentation
344, 423, 424, 425, 426, 443, 445
creating signals 344
mapping plant groups 425
overview 423
prerequisites 424
publish 443, 445

859

Index
retrieve 426
interfaces 447
ETAP 447
internal documents
adding revisions 365
comparing documents 367, 368
global revisions 366
overview 365
internal equipment 44, 45
internals 123, 124
copying 123
creating 124
item tag 710

J
jumpers 341, 342
connecting 341
customizing symbols 342
junction boxes 43, 137
creating 137

K
KKS 422
KKS mode 405, 407, 409, 413, 416, 417,
420, 421
Classification dialog box 422
configuring for hard-coded tag
propagation 409
configuring for rules 413
configuring SmartPlant Electrical 407
default DDT file 407
overview 405
propagation 416, 417
renaming items 421
scope 420
using default DDT file overview 407
using supplied DDT file 409

L
layers 588
layouts 374, 375, 596
legend 304, 305
in SLDs 304
using custom symbols 305
levels 588
lighting fixtures 87
loads
applying typical control stations 128
assigning to typical circuits 127
assigning to typical I/O sets 132
assigning to typical schematics 129

860

associating 674
associating a single load with a PDB 208
associating with a PDB in batch mode
205
associating with control stations 136,
196
associating with feeders 194
automatic creation of feeders 195
calculating load summaries 253
calculating load summaries for all buses
253
calculating load summaries overview
214
controls and signals 718, 726
creating in batch mode 82
displaying loads associated with a bus
211
electrical data 717, 725
Enhanced All Feeder Load Summary
report 389
enhanced load summary report 254
feeder data 719, 720, 727, 728
general data 714, 722
instrument data 698, 718, 726
load data 716, 723
populating data 125
properties 722
validating 211
local panels 43, 137
log files 29, 33, 34, 35, 588
displaying rule inconsistencies 35
generating 33, 34
preferences 29
viewing 588
logical expressions 35, 820
associated actions 820
description 820
examples 35
operands 820
operators 35
properties 820
values 820
lookup tables 56, 59, 126, 671
adding more regional standards 59
applying to items 126, 671
circuit components 59
defining 56
editing 56

M
macros 116, 256, 262, 265, 274, 397, 398
cell macros 116
definition guidelines 262

SmartPlant Electrical User's Guide

Index
for report headers 397
multi-item schematics 274
report macros 398
sequencing items in schematic block
macros 265
title blocks 256
mapping 425
mapping attributes 398
plant groups 425
Mark as Completed 460
Match all 375
Match any 375
measuring transformers 110, 114
copying 114
creating 110
merging 462, 464
into As-Built 464
overview 462
running a test merge 464
metering equipment
copying 114
creating measuring transformers 110
creating meters 111
creating protection relays 112
creating relay functions 112
meters 111, 114
copying 114
creating 111
MicroStation 588
mirroring items 591
miscellaneous drawings 372
associating with electrical items 372
creating 372
inserting symbols 372
overview 372
modifying 73, 619
properties 73
relationship properties 72
select lists 619
select set properties 72
motors 41, 79, 82, 83, 85, 125, 569, 692,
693, 696, 697, 698, 700
adding 82
calculating power requirements 83
controls and signals 697
deleting 79
duplicating 85
editing properties 83
electrical data 696
electrical power calculations 569
feeder data 698, 700
general data 692
load data 693

SmartPlant Electrical User's Guide

populating data 125


reference 41
moving 71, 124, 591, 612, 619
circuits 124
feeder circuits 124
items 71, 591, 612
select list entries 619
multi-item schematics 274, 788
multiple cables 183
display / hide 183
multi-sheet schematic macros 256
multi-sheet schematics 55

N
naming conventions 27, 65, 405, 710
copying 27
KKS 405
using 65
new 255, 587, 588
drawing templates 587, 588
drawings 255
tables 374
null data 75, 76

O
opening 117, 255, 256, 279, 293, 294, 612
databases 612
drawing templates 256
new drawings 255
PDB layouts for selected PDBs 117
plant structures 612
schematic drawings 279
single line diagrams for PDBs 294
SLDs 293
SLDs from Documents folder 294
SLDs from Electrical Engineer 294
options 126, 668
other electrical equipment 714, 716, 717,
718, 719, 720
controls and signals 718
electrical data 717
feeder data 719, 720
general data 714
instrument data 718
load data 716
overall SLDs 799
overload relays 44, 45, 123, 124

P
panel circuits 138
creating 138

861

Index
panels 42, 43, 79, 135, 137
adding project panels 135
adding reference panels 42
creating local panels 137
deleting 79
junction boxes 43
local panels 43
panning 356
parallel cables 183
parallel cables in SLDs 285
display / hide 183
parent items in the Electrical Engineer 185
pasting 590
bulk properties 74, 75
items 590
PDB layout design sheets 733
zooming 733
PDBs
a single load with a PDB 208
associating loads 674
associating loads in batch mode 205
associating with loads 194
batch generation of SLDs 291
calculating load summaries 253
calculating load summaries overview
214
calculating loads for all buses 253
common tasks 105, 122
creating 106
customizing border 305
deleting 107
design overview 114
designing layouts 116
designing physical structure 115
displaying in Electrical Engineer 29
Enhanced All Feeder Load Summary
389
enhanced load summary report 254
generating single line diagrams 289
opening PDB layout for selected PDB
117
opening single line diagrams 294
phase association 205, 208
associating single load with a PDB 208
batch load assignment 205
plant groups 26, 425, 612
changing names 26
hierarchy 612
mapping 425
moving items to 612
plant reference data 27
plant structures 612
populating item data 125

862

power cables 198


adding in parallel to equipment 198
associating with equipment 198
power distribution boards 29, 105, 106,
107, 114, 115, 116, 117, 122, 205, 208,
289, 291, 294, 305, 389, 674
associating a single load with a PDB 208
associating loads 674
associating loads in batch mode 205
batch generation of SLDs 291
common tasks 105, 122
creating 106
customizing border 305
deleting 107
design overview 114
designing layouts 116
designing physical structure 115
Enhanced All Feeder Load Summary
report 389
generating single line diagrams 289
in Electrical Engineer 29
opening PDB layout for selected PDB
117
opening single line diagrams 294
power network structures 62, 63
preface 733
preferences
deleting loads 32
deleting main item 32
log files 29
overview 29, 33
PDB item tags 29
reports 31
SLD generation 30
printing 589
product news 606
profiles
applying 130, 668
creating 45
editing 46
overview 125
proirities 819
description 819
Reject action 819
Warn action 819
project cable properties 624, 625, 628, 632,
633, 637, 638
connections 632
design data 628
earth loop impedance 637
general 625
procurement 638
sizing data 633

SmartPlant Electrical User's Guide

Index
project cables 140, 141, 142, 143, 144,
146, 147, 155, 157, 620, 624, 642, 643,
647
adding 140
applying reference data 620
associating glands 143
batch sizing 147, 624
comparing reference data 642, 643
deleting 142
dissociating cable sides and glands 144
editing 141
replacing 155, 647
replacing cable side associations 157
sizing 146
project control stations 136, 747
project items 78, 79
deleting 79
duplicating 78
project management
claiming items overview 457
merging into As-Built overview 462
overview 449
project panels 135
projects 450, 451, 452, 453, 458, 459, 460,
461, 462, 464, 466, 467, 754, 755
projects. scoping 450
projects. selecting in As-Built 453
adding items 458
claim modes 459
claiming items 458
comparing documents with As-Built 462
filtering the display 466
generating a report 467
marking items as completed 460
merging items into As-Built 464
modifying a status 452
Project Status dialog box 754, 755
releasing claim 459
releasing items from merge 461
rules for changing statuses 451
running a test merge 464
setting display options 466
understanding statuses 450
propagation 416, 417
in KKS mode 416, 417
properties 72, 73, 74, 75, 76, 589, 594,
597, 610
Properties window 75, 76
brief 75, 76
bulk 74, 75
copying 74
display 74, 75, 76
displaying 72, 73

SmartPlant Electrical User's Guide

drawings 589
editing 73, 607
null data 76
table 74, 76
table views 594
tables 374, 605
protection relays 112, 114, 123, 124
copying 114
creating 112
functions 112
publish 391
publish data 443, 445

Q
quitting SmartPlant Electrical 589

R
rated power 205, 208, 211
reclaiming items 459
redlining 349, 351, 352, 353
deleting 353
editing 352
inserting graphics 352
inserting text 351
overview 349
reference cable properties 769
reference cables 139, 142, 650, 769, 772,
773
connection properties 773
deleting 142
design data properties 772
general properties 769
procurement properties 773
selecting for cable drum 650
reference control stations 774
reference data 27, 39
Reference Data Explorer 37, 70
copying 27
customizing sort sequence within folders
70
overview 37
Reference Electrical Engineer 61, 62, 63
copying power network structures 62
drag-and-drop rules 63
overview 61
reference items
adding 40
battery banks 101
blocks 51, 52
cables 139, 140
circuit components 44, 45
circuits 44

863

Index
control stations 43
converting equipment 102
copying 77
creating project items 125
deleting 79
duplicating 78
generators 99
motors 41
other equipment 87
panels 42, 43
schematics 53
shipped data 39
static electrical equipment 85
transformers 102
refreshing drawings 595
regional standards 59
enabling addional standards 59
relation rules 820
consistency criteria 820
logical expressions 820
relationships 72
relays 112
functions 112
protection 112
renaming items 79, 421
in KKS mode 421
replacing cables 155, 647
report templates 395
common tasks 395
defining items 398
reports 31, 254, 382, 389, 391, 394, 397,
398, 742
adding report macros 398
All Feeder Load Summary (Enhanced)
254
associating registered reports 394
creating for selected items 382
Enhanced All Feeder Load Summary
389
enhanced load summary report 254
macros for report headers 397
registering 391, 742
revisions in registered reports 391
setting preferences 31
shipped reports 382
resistors 78, 79, 85
adding 85
deleting 79
duplicating 78
retrieve data 426
reviewing properties 73
revisions
global revisions 366

864

in documents claimed for projects 462


in miscellaneous drawings 372
in registered reports 391
in single documents 365
ribbons 591
move 591
rotating items 591
routing 165, 166, 167, 169, 308, 309, 628,
657, 659
routing cables 165, 166
assigning cables 628
batch mode 657
batch routing cables 166
clearing 167
create cableway and segments 165
edit cableway 169
overview 165
segment validations 308, 309, 659
rule components 819
description 819
filters 819
item types 819
order of components 819
rule properties 820
actions 820
consistency criteria 820
logical expressions 820
rule types 819
bi-directional rules 819
relation rules 819
single component rules 819
rules 34, 35, 181, 413, 818, 819, 820
cable drum 181
consistency criteria 820
examples 35
general properties 819
KKS configuration 413
proirities 819
properties 818
reports 382
troubleshooting inconsistencies 34, 35

S
saving 588
drawings 588, 589
settings 596
Tabular Editor 588
templates 588
settings 596
schematic blocks 51, 52

SmartPlant Electrical User's Guide

Index
schematics 53, 55, 256, 259, 260, 261,
262, 265, 273, 274, 277, 278, 279, 280,
281, 349, 350, 351, 352, 353, 355, 356,
365, 366, 367, 368, 774, 788
adding revisions 365
annotations 273, 278, 349, 350, 351
annotations and redlining 349
batch generation 278
comparing documents 367, 368
complete symbol file in Catalog Manager
280
entering revisions 261
generating 273, 277
global revisions 366
in AutoCAD 281
in Catalog Manager 279
in MicroStation 281
in SmartSketch 280
including Enhanced SmartLoop reports
277, 278
macros 262
macros in multi-sheet schematics 256
manipulating 355
modifying 261
multi-item 274, 788
multiple sheets 774
multi-sheet 55
opening 279
overview 259
printing 261
redlining 351, 352, 353
renaming 261
saving annotations 279
saving as an external file 261
saving as external document 279
sequencing items 265
typical 53
viewing 356
workflow 260
zooming 356
scoping 450, 453, 454, 456, 457
items 456
projects 450
rules for scoping items 454
scoping items overview 453
using the buffer 457
segments 165
creating 165
segregation levels 628
select all cells in Tabular Editor 606
ordering 619
sorting

SmartPlant Electrical User's Guide

customizing sort sequence within folders


70
tables 375
sorting 619
select lists 618, 619, 689
sorting entries 619
selecting 69
items 606
properties 606
tags 69
setting preferences 29, 33
shipped data 39, 382
reference items 39
reports 382
short circuit 56
lookup table data 56
shortcut menus 607
brief properties 75, 76
null data 75
signals
associate in batch mode 345
create 344
dissociating 345
overview 344
single component rules 820
consistency criteria 820
logical expressions 820
single line diagrams
adding revisions 365
Align command 360
aligning drawing objects 359
annotations 349, 350, 351
annotations and redlining 349
based on bus rated voltage 799
batch generation from Electrical Index
291
bus ties with internals 292
comparing documents 367, 368
control station 97, 295
electrical analysis SLDs 799
entering revisions 285
finding items 304
generating 292
generating from Electrical Engineer 288
generating from Electrical Index 289
generation preferences 30
global revisions 366
inserting legend 304
manipulating 355
manual generation 291
modifying 285
object alignment overview 357
opening 293

865

Index
opening for a PDB 294
opening for Electrical Engineer items
294
opening from Documents folder 294
options 285
overall SLDs 799
overview 283
parallel cables 285
printing 285
redlining 351, 352, 353
removing an item 307
renaming 285
reposition overlapping connectors 731
saving as an external file 285, 295
SmartText label attributes 310
symbol creation guidelines 310
template 291
using custom symbols 305
viewing 356
zooming 356
sizing cables 56, 146, 147, 151, 624, 633,
641
algorithms 151
batch mode 147, 624
individual sizing 146
manual sizing 641
short circuit lookup table data 56
sizing data 633
SLDs
adding revisions 365
Align command 360
aligning drawing objects 359
annotations 349, 350, 351
annotations and redlining 349
based on bus rated voltage 799
batch generation from Electrical Index
291
bus ties with internals 292
comparing documents 367, 368
electrical analysis SLDs 799
entering revisions 285
finding items 304
generating 292
generating from Electrical Engineer 288
generating from Electrical Index 289
generation preferences 30
global revisions 366
inserting legend 304
manual generation 291
modifying 285
object alignment overview 357
opening 293
opening for a PDB 294

866

opening for Electrical Engineer items


294
opening from Documents folder 294
options 285
overall SLDs 799
overview 283
parallel cables 285
printing 285
redlining 351, 352, 353
removing an item 307
renaming 285
reposition overlapping connectors 731
saving as an external file 285, 295
SmartText label attributes 310
symbol creation guidelines 310
template 291
using custom symbols 305
smart labels
aligning 315
SmartPlant Electrical
interface to SmartPlant Instrumentation
423
SmartPlant Instrumentation interface 344,
423, 424, 425, 426, 443, 445
creating signals 344
mapping plant groups 425
overview 423
prerequisites 424
publish 443, 445
retrieve 426
SmartText labels 310
attributes for SLDs 310
socket outlets 87
sorting 70, 375
splices 177
automatic definition 177
starters 44, 45, 123, 124
static loads 722, 723, 725, 726, 727, 728
controls and signals 726
electrical data 725
feeder data 727, 728
general data 722
instrument data 726
load data 723
statistics 589
statuses 450
statuses of items 451, 459, 460
claim modes 459
Clear Mark as Completed 460
Mark as Completed 460
modifying a status 452
rules for changing statuses 451
statuses of projects 452, 754, 755

SmartPlant Electrical User's Guide

Index
Project Status dialog box 754, 755
understanding 450
summaries 589
support 606
symbol files 279, 280, 313
complete symbol file for schematic blocks
in Catalog Manager 280
in SmartSketch 280
placing connection points 313
schematic blocks in Catalog Manager
279
symbols 305, 310, 372
inserting in miscellaneous drawings 372
SLD symbols in Catalog Manager 310
using custom symbols in SLDs 305

T
table items 373
bold 373
editing 373
editing properties 374
freezing panes 373
italic 373
table views 594
tables 605
editing properties 373
items 605
layouts 375
new 374
project management 605
properties 76, 605, 607
Tabular Editor 373, 606
filters 378
properties 375
tag selection 69
tapping 104
templates 255, 372, 395, 587, 588
drawings 255, 587, 588
inserting external graphics 372
reports 395
saving 588
terminal strip configuration 332, 333
applying reference configuration 333
defining configuration 333
reference configurations 332
terminal strips 331, 332, 333
applying reference terminal strip
configuration 333
creating in Electrical Index 331
defining terminal strip configuration 333
reference terminal strip configuration
332
terminals 332, 825

SmartPlant Electrical User's Guide

common properties 825


creating in Electrical Index 332
general definitions 825
procurement 825
title block macros 256
to do list 749, 752
toolbar 749, 752
toolbars 597
Properties window 72, 75
tools 603
transfer switches 121, 122
creating 121
generating SLD 122
overview 121
transformers 78, 79, 103
creating 102
defining connections 103
defining tapping 104
deleting 79
duplicating 78
troubleshooting rule inconsistencies 34, 35
typical circuits 44, 127, 669, 687, 698, 719,
727, 776
adding to equipment 687
adding to loads 719, 727
adding to motors 698
applying to items 669
assigning loads 127
creating 44
typical control stations 43, 128
applying to items 128
creating 43
typical I/O sets 132, 672
applying to items 672
assigning loads 132
typical schematics 53, 129, 671
applying to items 671
assigning loads 129
creating 53

U
uncompensated electrical data 214
UPSs 78, 79, 102
adding 102
deleting 79
duplicating 78

V
validations 574, 577
custom 574, 577
implementing 574
variable frequency drives 78, 79, 102

867

Index
adding 102
deleting 79
duplicating 78
properties 72, 74, 75, 76
tables 605
views 75, 375, 595, 597, 605
drawings 596
refreshing 595
settings 596
tables 596, 607
tabular 374

Z
zooming 356, 733
PDB layout design sheets 733

W
Web 606
address 610
forum 606
welding outlets 87
windows 72
wiring drawings 327, 336, 337, 340, 341,
342, 355
applying reference terminal strip
configurations 333
batch cable connection 339
connecting cable sets 340
connecting cables (continuous method)
337
connecting cables (custom method) 336
connecting single conductors 340
continuous cable connection method
337
continuous connection method 337
custom connection method 336
customizing jumper symbols 342
defining connection types 335
disconnecting cable sets 341
disconnecting cables 341
disconnecting conductors 341
finding items in the EI or EE 355
grouping related items 70
jumpering terminals 341
notes on working with drawings 342
opening 342
opening wiring diagrams 342
overview 331
reference terminal strip configurations
332
removing items 327
terminal strips in Electrical Index 331
terminals in Electrical Index 332
wiring project items common tasks 334
World Wide Web 606, 610

868

SmartPlant Electrical User's Guide

You might also like